Labeling properties manual

This manual describes the available properties for controlling labeling in your ArcGIS Maps SDK for Native Apps application. For the purposes of labeling, graphics generated by ArcGIS Maps SDK for Native Apps are treated as if they are features. References to features within this document can be assumed to refer to both features and graphics.

1.0 Label Properties

A list of all supported ArcGIS Maps SDK for Native Apps labeling properties, their values and ArcGIS Pro export interpretations.

1.1.0 angle

The angular positions and layout directions for labels on or around point feature symbols.

This optional object specifies how to position a label following the direction of an angle. 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).

The LabelDefinition.placement will still be used to indicate whether offset or centered positioning is required, but the exact position will be overridden by the angle calculated for the feature. Once the position has been determined, LabelDefinition.textLayout and LabelDefinition.textOrientation are used to specify the layout of the text at that position.

1.1.1 Overview

1.1.2 Property values

1.1.3 Other property relationships

• 2.5 angle x placement
• 2.6 angle x textLayout x placement
• 2.7 angle x textOrientation

1.1.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property angle.

Rotation (point features)

• label class properties -> position options -> placement
• label class properties -> position options -> position properties -> rotation -> rotation field -> expression builder
• label class properties -> position options -> position properties -> rotation -> rotation field
• label class properties -> position options -> position properties -> rotation -> additional rotation
• label class properties -> position options -> position properties -> rotation -> rotation type

1.1.5 Standard labeling publishing rules

Outlines which Standard labeling Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property angle.

Rotation (point features)

• label class properties -> position options -> position properties -> angles

1.2.0 deconflictionStrategy

The strategy for moving labels to avoid overlapping feature, annotation, dimension or graphic symbols or higher priority labels. In 3D LabelDeconflictionStrategy.static is selected by default.

The default is LabelDeconflictionStrategy.automatic (which will be interpreted as LabelDeconflictionStrategy.static i.e. use preferred location unless it would overlap an obstacle).

1.2.1 Overview

1.2.2 Property values

1.2.3 Other property relationships

• 2.1 priority x deconflictionStrategy
• 2.3 featureBoundaryOverlapStrategy x deconflictionStrategy
• 2.4 featureInteriorOverlapStrategy x deconflictionStrategy

1.2.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property deconflictionStrategy.

Position options (point features)

• label class properties -> position options -> placement properties -> position
• label class properties -> position options -> zones
• label class properties -> position options -> conflict resolution properties -> unplaced labels -> never remove

Position options (line features)

• label class properties -> position options -> placement properties -> offset along line
• label class properties -> position options -> conflict resolution properties -> unplaced labels -> never remove

Position options (polygon features)

• label class properties -> position options -> placement properties -> place label at fixed position within polygon
• label class properties -> position options -> conflict resolution properties -> unplaced labels -> never remove

1.2.5 Standard labeling publishing rules

Outlines which Standard labeling Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property deconflictionStrategy.

Position options (point features)

• label class properties -> position options -> priority
• label class properties -> position options -> place overlapping labels

Position options (line features)

• label class properties -> position options
• label class properties -> position options -> location along the line
• label class properties -> position options -> place overlapping labels

Position options (polygon features)

• label class properties -> position options -> place overlapping labels

1.3.0 expression

The expression script used to calculate the label text.

The expression may be a combination of literal text and attribute values from the feature being labeled. The syntax of the expression is determined by which label expression object is used: ArcadeLabelExpression, SimpleLabelExpression or WebmapLabelExpression.

A label expression using one scripting language can be replaced by an expression using a different scripting language just by creating an object of the new LabelExpression subclass and assigning it to LabelDefinition.expression.

The default value is an empty ArcadeLabelExpression, which will evaluate to an empty text label.

The expression needs to create a text string which will be used as the label text. The text string can be any legal UTF16 characters.

The text string can also include HTML-style formatting tags e.g.

"Hello <BOL>World</BOL>"

where the angle-bracketed tags will not appear in the label, but may change the presentation of the text. In the example, the "World" will appear in bold.

The available tags are:

• "<BOL></BOL>" for bold text
• "<UND></UND>" for underlined text
• "<ITA></ITA>" for italic text
• "<CLR red='256'></CLR>" for colored text
• "<FNT name='Arial' size='18'></FNT>" for text using a different size or font (if available on client).

Tags can be upper or lower case, but not a mixture. Tags can be nested e.g. "<ITA>Hello <BOL>World</BOL></ITA>".

Full documentation of the tag parameters is available in the document Text formatting tags.

1.3.1 Overview

1.3.2 Property values

1.3.3 Other property relationships

None

1.3.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property expression.

expression (all features)

• label properties -> class options -> expression
• label properties -> class options -> language

1.3.5 Standard labeling publishing rules

Outlines which Standard labeling Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property expression.

expression (all features)

• label properties -> label expression
• label properties -> label expression -> language

1.4.0 featureBoundaryOverlapStrategy

The strategy for whether other labels are allowed to overlap the boundary of polygon features/graphics being labeled by this LabelDefinition. In 3D scenes, labels will be allowed to overlap the boundaries of polygon features.

The default is LabelOverlapStrategy.automatic, which will give the same behavior as LabelOverlapStrategy.allow.

1.4.1 Overview

1.4.2 Property values

1.4.3 Other property relationships

• 2.3 featureBoundaryOverlapStrategy x deconflictionStrategy

1.4.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property featureBoundaryOverlapStrategy.

Boundary weight (polygon features)

• label weight ranking -> feature layers

1.4.5 Standard labeling publishing rules

Outlines which Standard labeling Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property featureBoundaryOverlapStrategy.

None, not supported for featureBoundaryOverlapStrategy

1.5.0 featureInteriorOverlapStrategy

The strategy for whether other labels are allowed to overlap the interior of polygon features/graphics being labeled by this LabelDefinition. In 3D scenes, labels will be allowed to overlap the interiors of polygon features.

The default is LabelOverlapStrategy.automatic which will give the same behavior as LabelOverlapStrategy.allow.

1.5.1 Overview

1.5.2 Property values

1.5.3 Other property relationships

• 2.4 featureInteriorOverlapStrategy x deconflictionStrategy

1.5.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property featureInteriorOverlapStrategy.

Feature weight (all features)

• label weight ranking -> feature layers

1.5.5 Standard labeling publishing rules

Outlines which Standard labeling Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property featureInteriorOverlapStrategy.

Feature weight (all features)

• label class properties -> position options -> conflict resolution properties -> feature weight

1.6.0 labelOverlapStrategy

The strategy for whether other labels are allowed to overlap labels created by this LabelDefinition. In 3D, labels will not be allowed to overlap other labels. Overlapping labels will not be displayed until the user zooms in further so that the labels don't overlap.

The default is LabelOverlapStrategy.automatic which will give the same behavior as LabelOverlapStrategy.exclude.

1.6.1 Overview

1.6.2 Property values

1.6.3 Other property relationships

None

1.6.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property labelOverlapStrategy.

Background label (all features)

• label class properties -> position options -> conflict resolution properties -> background labels

1.6.5 Standard labeling publishing rules

Outlines which Standard labeling Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property labelOverlapStrategy.

Label weight (all features)

• label class properties -> position -> conflict resolution -> label weight

1.7.0 lineConnection

The strategy for whether line features with the same label, and matching end vertices, should be joined before sharing a label. 3D line features will be treated as independent features with their own label.

The default is LabelLineConnection.automatic, which will be interpreted as LabelLineConnection.minimizeLabels.

1.7.1 Overview

1.7.2 Property values

1.7.3 Other property relationships

None

1.7.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property lineConnection.

Connect features (all features)

• label class properties -> position options -> conflict resolution properties -> line connection

1.7.5 Standard labeling publishing rules

Outlines which Standard labeling Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property lineConnection.

Line connection (all features)

• default

1.8.0 maxScale

The maximum scale at which labels will be visible. In 3D scenes,the scale range is between individual label and view plane instead of map and view plane.

Labels will only be visible when the viewing scale is smaller than (or equal to) the maxScale.

For example, if the viewing scale is 1:12000 and the LabelDefinition.maxScale is 1:10000, then the labels will be visible (because 1/12000 < 1/10000). A LabelDefinition.maxScale of 0, which is the default, indicates no upper limit on the viewing scale.

1.8.1 Overview

1.8.2 Property values

1.8.3 Other property relationships

None

1.8.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property maxScale.

visibility range (all features)

• label class properties -> class -> visibility range -> in beyond

1.8.5 Standard labeling publishing rules

Outlines which Standard labeling Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property maxScale.

visibility range (all features)

• label class properties -> class -> visibility range -> in beyond

1.9.0 minScale

The minimum scale at which labels will be visible. In 3D scenes, the scale range is between individual label and view plane instead of map and view plane.

Labels will only be visible when the viewing scale is larger than (or equal to) the minScale.

For example, if the viewing scale is 1:12000 and the LabelDefinition.minScale is 1:20000, then the labels will be visible (because 1/12000 > 1/20000). A LabelDefinition.minScale of 0, which is the default, indicates no lower limit on the viewing scale.

1.9.1 Overview

1.9.2 Property values

1.9.3 Other property relationships

None

1.9.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property minScale.

visibility range (all features)

• label class properties -> class -> visibility range -> out beyond

1.9.5 Standard labeling publishing rules

Outlines which Standard labeling Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property minScale.

visibility range (all features)

• label class properties -> class -> visibility range -> out beyond

1.10.0 multipartStrategy

The strategy for how many labels should be placed on each polyline or polygon (multi-ring) feature.

The default is LabelMultipartStrategy.automatic.

1.10.1 Overview

1.10.2 Property values

1.10.3 Other property relationships

None

1.10.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property multipartStrategy.

Label largest (polygon features)

• label class properties -> position options -> conflict resolution properties -> label largest part

1.10.5 Standard labeling publishing rules

Outlines which Standard labeling Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property multipartStrategy.

Duplicate labels (polygon features)

• label class properties -> position options -> position properties -> duplicate labels

1.11.0 name

Text name for the class of labels.

This name is assigned by the map author to clarify the purpose of this label definition. It is used for display or debugging purposes. If no name is explicitly assigned, then an empty text string is stored.

1.11.1 Overview

1.11.2 Property values

1.11.3 Other property relationships

None

1.11.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property name.

Label class name (all features)

• label class properties -> general -> name

1.11.5 Standard labeling publishing rules

Outlines which Standard labeling Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property name.

Label class name (all features)

• label class properties -> general -> name

1.12.0 offsetDistance

The distance (in points i.e. 1/72 inches) that text should be moved away from its features.

The distance is measured from the point symbol radius or line feature symbology edge. The distance is measured on the screen (i.e. not in the map) in points, comparable to the text font size.

This can be a negative value, to pull the label closer to the feature if, for example, the average size for a point symbol is overly conservative for the actual graphic shown.

If no value is set, then 1 point is assumed.

1.12.1 Overview

1.12.2 Property values

1.12.3 Other property relationships

None

1.12.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property offsetDistance.

Preferred offset (all features)

• label class properties -> position option -> placement properties -> placement

1.12.5 Standard labeling publishing rules

Outlines which Standard labeling Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property offsetDistance.

None, not supported for offsetDistance

1.13.0 overrunStrategy

The strategy for whether a label will be visible at scales where the feature is too small for the label to fit. Not supported by 3D scenes.

The default is LabelOverrunStrategy.automatic which will give different behavior depending on the type of feature that the label might overrun.

1.13.1 Overview

1.13.2 Property values

1.13.3 Other property relationships

None

1.13.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property overrunStrategy.

overrun (line features)

• label class properties -> position properties -> placement options -> placement properties -> offset along line
• label class properties -> position properties -> conflicting resolution properties -> overrun -> maximum
• label class properties -> position options -> conflict resolution properties -> unplaced labels -> never remove

overrun (polygon features)

• label class properties -> position options -> position properties -> overrun -> maximum

1.13.5 Standard labeling publishing rules

Outlines which Standard labeling Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property overrunStrategy.

overlap (line features)

• label class properties -> position options -> position properties -> location along the line
• label class properties -> conflict resolution properties -> place overlapping labels

only place label inside polygon (polygon features)

• label class properties -> position options -> only place label inside polygon

1.14.0 placement

The preferred position of the text label, with respect to its feature geometry.

The default is LabelingPlacement.automatic. The effect of this is the same as one of the following, depending on the type of feature geometry:

• LabelingPlacement.pointAboveRight for point features
• LabelingPlacement.polygonAlwaysHorizontal for polygon features
• LabelingPlacement.lineAboveAlong for line features

1.14.1 Overview

1.14.2 Property values

1.14.3 Other property relationships

• 2.5 angle x placement
• 2.6 angle x textLayout x placement

1.14.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property placement.

Label placement (point features)

• label class properties -> position options -> placement properties -> placement
• label class properties -> position options -> placement properties -> zones

Label placement (line features)

• label class properties -> position options -> placement properties -> placement
• label class properties -> position options -> placement properties -> constrain offset
• label class properties -> position options -> placement properties -> offset along line

Label placement (polygon features)

• default

1.14.5 Standard labeling publishing rules

Outlines which Standard labeling Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property placement.

Label placement (point features)

• label class properties -> position options -> position properties -> priority
• label class properties -> position options -> position properties -> place label on top of point
• label class properties -> position options -> position properties -> offset label horizontally around the point

Label placement (line features)

• label class properties -> position options -> align to
• label class properties -> position options -> on the line
• label class properties -> position options -> left of the line
• label class properties -> position options -> right of the line
• label class properties -> position options -> location along the line

default (polygon features)

• default

1.15.0 priority

Defines which labels are placed first, and can also supplant existing lower-priority labels (e.g. during panning).

Lower values indicate more important labels i.e.:

• 0 is the most important
• 5 is high priority
• 15 is medium priority
• Higher values indicate lower priority

If set to -1 or not set at all, then default values are used, depending on the geometry types of the features:

• 12 for point features
• 15 for line features
• 18 for polygon features

This value does not have to be an integer because it is just a continuum of values for comparison. Users can use this to specify that a class of labels should have priority between two other classes with close priorities.

For example, PreferredRoutes might be given priority 13 to appear ahead of general line feature labels, but after general point feature labels. And HistoricSites might be given priority 12.5 to appear ahead of PreferredRoute labels, but still after general point feature labels.

1.15.1 Overview

1.15.2 Property values

1.15.3 Other property relationships

• 2.1 priority x deconflictionStrategy
• 2.2 priority x removeDuplicatesStrategy

1.15.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property priority.

Priority ranking (all features)

• labeling ribbon -> more -> priorities

1.15.5 Standard labeling publishing rules

Outlines which Standard labeling Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property priority.

Priority ranking (all features)

• labeling ribbon -> more -> priorities

1.16.0 removeDuplicatesDistance

A value that controls the duplicate thinning radius (in points i.e. 1/72 inches).

The distance is measured on the screen (i.e. not in the map) in points, comparable to the text font size. This value is only used if LabelDefinition.removeDuplicatesStrategy is enabled. The default value is 0. This indicates that duplicates should be removed from the entire extent.

1.16.1 Overview

1.16.2 Property values

1.16.3 Other property relationships

None

1.16.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property removeDuplicatesDistance.

Search Radius (all features)

• label class properties -> position options -> conflict resolution properties -> remove duplicate labels -> search radius

1.16.5 Standard labeling publishing rules

Outlines which Standard labeling Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property removeDuplicatesDistance.

Default (all features)

• default

1.17.0 removeDuplicatesStrategy

The strategy for whether labels are removed if other features have the same text label. This can reduce clutter and free up space.

The default is LabelRemoveDuplicatesStrategy.automatic, which will be interpreted as LabelRemoveDuplicatesStrategy.none indicating that all labels should be shown if possible.

The distance within which to look for duplicates is controlled by LabelDefinition.removeDuplicatesDistance.

1.17.1 Overview

1.17.2 Property values

1.17.3 Other property relationships

• 2.2 priority x removeDuplicatesStrategy

1.17.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property removeDuplicatesStrategy.

Remove duplicate labels (all features)

• label class properties -> position options -> conflict resolution properties -> remove duplicate labels

1.17.5 Standard labeling publishing rules

Outlines which Standard labeling Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property removeDuplicatesStrategy.

Duplicate labels (all features)

• label class properties -> position options -> position properties -> duplicate labels

1.18.0 repeatDistance

The distance apart (in points i.e. 1/72 inches) that the repetitions should be. In 3D scenes, only one label will be placed per line feature.

This value is only used if LabelDefinition.repeatStrategy is enabled. The distance is measured on the screen along the line feature. As the user zooms in closer, two repetitions move further apart on the screen, until there is room for a new repetition between them. The default is 216 points i.e. line labels should be repeated approximately every 3 inches along long features.

The distance is considered a guide for the approximate label separation and should not be used for precise distance markings.

A distance of 0 disables label repetition.

1.18.1 Overview

1.18.2 Property values

1.18.3 Other property relationships

None

1.18.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property repeatDistance.

Repeat minimal interval (line features)

• label class properties -> position options -> conflict resolution properties -> repeat -> minimum interval

1.18.5 Standard labeling publishing rules

Outlines which Standard labeling Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property repeatDistance.

None, not supported for repeatDistance

1.19.0 repeatStrategy

The strategy for whether a label should have multiple copies created and placed along or across the same feature. In 3D scenes, only label will be placed per line feature.

The default is LabelRepeatStrategy.automatic.

The frequency of repetition is controlled by the LabelDefinition.repeatDistance property.

This property is currently only supported for line features, but will be extended to polygons in the future.

1.19.1 Overview

1.19.2 Property values

1.19.3 Other property relationships

None

1.19.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property repeatStrategy.

{"repeatLabel":true, "repeatLabelDistance":200} (line features)

• label class properties -> position properties -> placement options -> placement properties -> offset along line
• label class properties -> position options -> conflict resolution properties -> repeat -> minimum interval

1.19.5 Standard labeling publishing rules

Outlines which Standard labeling Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property repeatStrategy.

None, not supported for repeatStrategy

1.20.0 stackAlignment

The strategy for how multi-row (stacked) text should be aligned.

Multi-row text labels can be horizontally aligned on the left, right or at its center. This preference can be specified by the TextSymbol assigned to the LabelDefinition. By using the LabelDefinition.stackAlignment property, 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 default value is LabelStackAlignment.automatic (which will have the same effect on labels as LabelStackAlignment.textSymbol).

This property has no effect if LabelDefinition.stackStrategy = LabelStackStrategy.none.

1.20.1 Overview

1.20.2 Property values

1.20.3 Other property relationships

• 2.8 stackAlignment x stackStrategy

1.20.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property stackAlignment.

Horizontal alignment (all features)

• label class properties -> position options -> fitting strategy properties -> stack -> horizontal alignment

1.20.5 Standard labeling publishing rules

Outlines which Standard labeling Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property stackAlignment.

None, not supported for stackAlignment

1.21.0 stackRowLength

A value that limits the number of characters in a row of stacked text.

This length guides the decision on when to break long text strings into separate rows. The line break will be inserted between words, not in the middle of a word, so rows may be longer or shorter than the ideal. Depending on LabelDefinition.stackBreakPosition, the break may be inserted before the breaking word, or after.

The default value is -1 which means to use a default length determined by ArcGIS Runtime (currently 13 characters but may vary with feature-geometry in the future).

This property has no effect if LabelDefinition.stackStrategy = LabelStackStrategy.none.

1.21.1 Overview

1.21.2 Property values

1.21.3 Other property relationships

• 2.9 stackRowLength x stackStrategy

1.21.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property stackRowLength.

Maximum characters per line (all features)

• label class properties -> position options -> fitting strategy properties -> stack -> maximum characters per line

1.21.5 Standard labeling publishing rules

None, not supported for stackRowLength

1.22.0 stackSeparators

The stack separators that should be used for automatic line breaking of label text.

Each LabelStackSeparator specifies a code point to be looked for in the text. A code point is often thought of as a single character in the text, but may need several chars in a String to describe it. So each LabelStackSeparator.separator is a String intended to describe one code point.

For example:

• To use a comma as a separator, the LabelStackSeparator.separator string would be just ","
• To use a Hebrew punctuation Paseq as a separator, the LabelStackSeparator.separator would need to encode the code point with utf16 value "\u05c0" if your SDK uses utf16 strings (e.g. Java, C#) or with the utf8 string "\x30\x35\x63\x30" if your SDK uses utf8 strings
• To use higher range unicode code points such as Aegean Word Separator Dot which has utf32 hex value 10101, the LabelStackSeparator.separator would need to encode the code point with utf16 value "\ud800\udd01" if your SDK uses utf16 strings (e.g. Java, C#) or with the utf8 string "\xf0\x90\x84\x81" if your SDK uses utf8 strings

If it is found, then the LabelStackSeparator also specifies whether:

• The text should always be broken here
• Whether the separator code point should remain visible
• Whether the separator code point should appear at the end of one row, or the beginning of the next

Three default separators are provided: a comma, a space, and a hyphen. Custom separators can be added, and default separators can be removed if not required.

This property has no effect if LabelDefinition.stackStrategy = LabelStackStrategy.none.

1.22.1 Overview

1.22.2 Property values

1.22.3 Other property relationships

• 2.10 stackSeparators x stackStrategy

1.22.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property stackSeparators.

Stacking separators (all features)

• label class properties -> position options -> fitting strategy properties -> stack -> stacking separators

1.22.5 Standard labeling publishing rules

None, not supported for stackSeparators

1.23.0 stackStrategy

The strategy for whether the text should be stacked or wrapped, rather than placed as long trailing labels across the map.

This property controls whether stacking is allowed, or not, or should be calculated automatically based on feature type. The default is LabelStackStrategy.automatic, meaning that stacking will be enabled for point and polygon features and disabled for line features.

1.23.1 Overview

1.23.2 Property values

1.23.3 Other property relationships

• 2.8 stackAlignment x stackStrategy
• 2.9 stackRowLength x stackStrategy
• 2.10 stackSeparators x stackStrategy

1.23.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property stackStrategy.

Stack label (all features)

• label class properties -> position options -> fitting strategy properties -> stack -> stack label

1.23.5 Standard labeling publishing rules

None, not supported for stackStrategy

1.24.0 textLayout

The layout of the text, which can be either horizontal, straight, perpendicular, or follow the line feature.

Optional specification of whether, once the text is positioned, it should be written:

• Horizontally
• Straight (i.e. parallel) to the tangent to the line feature
• Straight in line with the point feature positioning angle
• Perpendicular to the tangent or positioning angle
• following the geometry of the line feature

The default is LabelTextLayout.automatic, which will be interpreted as:

• LabelTextLayout.horizontal for labels attached to point features
• LabelTextLayout.followFeature for labels attached to line features
• LabelTextLayout.horizontal for labels attached to polygon features

1.24.1 Overview

1.24.2 Property values

1.24.3 Other property relationships

• 2.6 angle x textLayout x placement

1.24.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property textLayout.

Point layout (point features)

• label class properties -> position options -> placement properties -> rotation -> alignment type

Line layout (line features)

• label class properties -> position options -> placement properties -> placement

Polygon layout (polygon features)

• default

1.24.5 Standard labeling publishing rules

None, not supported for textLayout

1.25.0 textOrientation

The orientation of the text, which can be either angle direction or screen-oriented. Not supported by 3D scenes.

Optional specification of whether text should follow the placement angle direction even if it means being rendered upside-down, or whether text should be flipped through 180 degrees to keep it screen-oriented. This setting will take effect whenever the feature geometry determines that the text is angled upside-down, or if the map is rotated within the screen to make the text upside-down (with respect to the screen). The default is LabelTextOrientation.automatic, which is interpreted as LabelTextOrientation.screen.

1.25.1 Overview

1.25.2 Property values

1.25.3 Other property relationships

• 2.7 angle x textOrientation

1.25.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property textOrientation.

Keep label upright (all features)

• label class properties -> position options -> placement properties -> placement -> rotation

1.25.5 Standard labeling publishing rules

Outlines which Standard labeling Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property textOrientation.

default (all features)

• default

1.26.0 textSymbol

The text symbol which describes the overall appearance of label text (e.g. font and size).

If no LabelDefinition.textSymbol has been set, then no labels can be created.

1.26.1 Overview

1.26.2 Property values

1.26.3 Other property relationships

None

1.26.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property textSymbol.

symbol (all features)

• label class properties -> symbol

1.26.5 Standard labeling publishing rules

Outlines which Standard labeling Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property textSymbol.

symbol (all features)

• label class properties -> symbol

1.27.0 useCodedValues

Specifies whether the data source should translate domain identifiers into meanings using a CodedValueDomain.

For any translation to occur, the data source must have one or more CodedValueDomain s set up for the attribute fields. The default value is true i.e. translation will be done.

This property only affects Simple label expressions. Arcade expressions can use functions to specify when code translations should be carried out. Coded value translation for Webmap expressions is not currently supported.

1.27.1 Overview

1.27.2 Property values

1.27.3 Other property relationships

None

1.27.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property useCodedValues.

Use coded values (all features)

• label class properties -> class -> label expression -> language
• label class properties -> class -> use coded value descriptions
• label class properties -> class -> label expression -> expression

1.27.5 Standard labeling publishing rules

Outlines which Standard labeling Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property useCodedValues.

Use coded values (all features)

• label class properties -> class -> label expression -> language
• label class properties -> class -> use coded value descriptions
• label class properties -> class -> label expression -> expression

1.28.0 whereClause

A SQL where clause expression that limits the set of features for which labels will be generated and placed.

This is a SQL where clause that can refer to the attributes of the feature. For example:

• "" (no limitations)
• "NAME LIKE 'A%'" (Only label features with NAME attribute values starting with 'A')
• "(LENGTH > CAPACITY) and (TYPE = 1)" (Only label features whose attributes satisfy the SQL condition)

The default value is "" which will allow all features in the data source and extent to be labeled.

1.28.1 Overview

1.28.2 Property values

1.28.3 Other property relationships

None

1.28.4 Maplex labeling publishing rules

Outlines which Maplex Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property whereClause.

SQL expression (all features)

• label class properties -> class -> SQL query

1.28.5 Standard labeling publishing rules

Outlines which Standard labeling Label class property settings are required to achieve a desired value for the ArcGIS Maps SDK for Native Apps labeling property whereClause.

SQL expression (all features)

• label class properties -> class -> SQL query

2.0 Label Property relationships

2.1 priority x deconflictionStrategy

1
2
3
4
5
6
7
8
9
10
11
12
IF 'current label priority LESS THAN other overlapping label priority'
AND 'current label IS NOT overlapping a barrier feature symbol'
AND 'current label IS NOT overlapping an annotation symbol'
AND 'current label IS NOT overlapping a dimension symbol'
  THEN 'place label'

IF 'label priority MORE THAN OR EQUAL to the other overlapping label priority'
  IF 'deconflictionStrategy IS static'
    THEN 'label will not be placed'

  IF 'deconflictionStrategy IS dynamic'
    THEN 'label will attempt to move'

2.2 priority x removeDuplicatesStrategy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
IF 'current label priority LESS THAN other label priority'
  THEN 'place label'

IF 'current label priority MORE THAN OR EQUAL TO other label priority'
  IF 'current label removeDuplicatesStrategy IS None'
    THEN 'place label'

  IF 'current label text EQUALS other label text'
  AND 'other label has been placed'
  AND 'other label position within current label removeDuplicatesDistance'
    IF 'current label removeDuplicatesStrategy IS in_Same_Feature_type'
    AND 'current label featureType EQUALS other label featureType'
      THEN 'Label will not be placed'

    IF 'current label removeDuplicatesStrategy IS in_Same_Label_class'
    AND 'current label labelClass EQUALS other label labelClass'
      THEN 'Label will not be placed'

    IF 'current label removeDuplicatesStrategy IS all'
      THEN 'Label will not be placed'

    OR
      THEN 'place label'

  OR
    THEN 'place label'

2.3 featureBoundaryOverlapStrategy x deconflictionStrategy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
IF 'current label featureBoundaryOverlapStrategy IS allow'
AND 'current label overlaps featureBoundary'
  THEN 'label will be placed'

 IF 'current label featureBoundaryOverlapStrategy IS avoid'
AND 'current label overlaps featureBoundary'
  IF 'current label deconflictionStrategy IS static'
    THEN 'label will be placed'

  OR 'current label deconflictionStrategy IS dynamic'
    THEN 'label will attempt to move, but may still be placed on feature boundary'

IF 'current label featureBoundaryOverlapStrategy IS exclude'
AND 'current label overlaps featureBoundary'
  IF 'current label deconflictionStrategy IS static'
    THEN 'label will not be placed'

  OR 'current label deconflictionStrategy IS dynamic'
    THEN 'label will attempt to move, but will definitely not be placed on feature boundary'

2.4 featureInteriorOverlapStrategy x deconflictionStrategy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
IF 'current label featureInteriorOverlapStrategy IS allow'
AND 'current label overlaps featureInterior'
  THEN 'label will be placed'

IF 'current label featureInteriorOverlapStrategy IS avoid'
AND 'current label overlaps featureInterior'
  IF 'current label deconflictionStrategy IS static'
    THEN 'label will be placed'

  OR 'current label deconflictionStrategy IS dynamic'
    THEN 'label will attempt to move, but may still be placed on feature interior'

IF 'current label featureInteriorOverlapStrategy IS exclude'
AND 'current label overlaps featureInterior'
  IF 'current label deconflictionStrategy IS static'
    THEN 'label will not be placed'

  OR 'current label deconflictionStrategy IS dynamic'
    THEN 'label will attempt to move, but will definitely not be placed on feature interior'

2.5 angle x placement

1
2
IF 'placement IS offset from point'
  THEN 'label position IS calculated from angle'

2.6 angle x textLayout x placement

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
IF 'textLayout IS horizontal'
  IF 'placement IS offset from point'
    THEN 'label position IS calculated from angle, and label layout IS horizontal'

  OR
    THEN 'label position IS centered on point, and label layout IS horizontal'

IF 'textLayout IS straight'
  IF 'placement IS offset from point'
    THEN 'label position IS calculated from angle, and label layout IS rotated by angle'

  OR
    THEN 'label position IS centered on point, and label layout IS rotated by angle'

 IF 'textLayout IS perpendicular'
  IF 'placement IS offset from point'
    THEN 'label position IS calculated from angle, and label layout IS rotated by angle + 90'

  OR
    THEN 'label position IS centered on point, and label layout IS rotated by angle + 90'

IF 'textLayout IS followFeature'
  THEN 'ignore angle'

2.7 angle x textOrientation

1
2
3
4
5
6
IF 'label IS rotated upside down'
  IF 'textOrientation IS set as direction'
    THEN 'allow upside down label text'

  IF 'textOrientation IS set as screen'
    THEN 'label text will flipped to appear upright'

2.8 stackAlignment x stackstrategy

1
2
IF 'stackStrategy IS set to none'
  THEN 'stackAlignment has no effect'

2.9 stackRowLength x stackStrategy

1
2
IF 'stackStrategy IS set to none'
  THEN 'stackRowLength has no effect'

2.10 stackSeparators x stackStrategy

1
2
IF 'stackStrategy IS set to none'
  THEN 'stackSeparators has no effect'