Package-level declarations
Types
An expression script using the Arcade language. The Arcade label expression property must contain a syntactically correct Arcade script expression.
Specifies how to calculate the angular position and layout direction for labels on or around point feature symbols. The angular position may be different for each feature (driven by one or more feature attributes) or constant for all features (specified by a fixed number).
How the placement angle should be interpreted. The type of rotation applied to the LabelAngle.angleExpression should be interpreted as LabelAngleRotationType.Arithmetic (counter-clockwise from East) or LabelAngleRotationType.Geographic (clockwise from North).
The weight of features when considered as barriers to labeling. An AnnotationLayer or a DimensionLayer, which has no LabelDefinition of its own, can be added to a map's operational layers. Their features will be automatically considered by the labeling process, to block labels being placed overlapping the features. This LabelBarrierWeight property controls how much labels must avoid the layer's features.
The strategy for moving labels to avoid overlapping point symbols or higher priority labels.
An object that defines the text, appearance, and position of labels for features within a given scale range. A LabelDefinition describes a class of labels.
Abstract base class for the different types of expressions that can be used to create label text. Users can read the expression script using the LabelExpression.expression property. To specify an expression script, users create an object of type ArcadeLabelExpression, SimpleLabelExpression or WebmapLabelExpression with the required expression script and assign it to the label expression object.
The strategy for how to use the geometry of the feature when calculating the label position.
An object that defines the text, appearance and position of labels for features for a given scale range. A LabelingInfo describes a class of labels.
The strategy for whether line features with the same label, and matching end vertices, should be joined before sharing a label.
Whether LabelDefinition.placement above or below a line geometry will be interpreted as above or below on the screen, or with respect to the direction of line's geometry (that is, the digitization order in which the vertices are listed).
The strategy for the number of labels to be placed on a multi-part feature.
The strategy for whether another label is allowed to be placed over this feature or label.
The strategy for whether a label should be visible at viewing scales where the feature is too small for the label to fit.
The strategy for whether labels should be removed if they have the same text as other labels, to reduce clutter and free up space.
The strategy for whether a label should have multiple copies created and placed along or across the same feature.
The strategy for how multi-row (stacked) text should be horizontally aligned. Multi-row text labels can each be horizontally aligned on the left, right or at their center. By using the LabelStackAlignment, the user can choose to use the TextSymbol.horizontalAlignment property for all labels, or can choose to have the most aesthetic alignment calculated case-by-case for each label depending on its placement position around its feature. This is particularly useful for labels of dense point features, where labels may move above, below, left or right of their point symbol, in order to fit on the display.
The strategy for whether a row of text should be broken before or after it exceeds the ideal length. If stacking is turned on, label placement can insert a line break before or after the word that overruns the maximum number of characters per row.
A separator character in a label, where a line break may be inserted in long text. A single separator consists of:
The position where the separator character in a label will be written, if used. Whether the separator code point should appear at the end of one row, or the beginning of the next. This does not matter if the separator is not to be visible when used.
The strategy for whether the text should be stacked or wrapped, rather than place long trailing labels across the map.
The layout to use for label text, which can be either horizontal, straight, perpendicular, or follow the line feature.
The orientation of label text.
An expression script using the Simple REST language. The label Simple expression expects to hold a legal, Simple script and to be read and evaluated by a Simple expression interpreter. An example expression that combines text with a field value is
The label Webmap expression expects to hold a legal, Webmap script and to be read and evaluated by a Webmap expression interpreter. An example expression that combines text with a field value is