LabelingInfo QML Type

An object that defines the text, appearance and position of labels for features for a given scale range. More...

Import Statement: import Esri.ArcGISRuntime
Since: Esri.ArcGISRuntime 100.0



Detailed Description

A LabelingInfo describes a class of labels.

Each LabelingInfo specifies:

  • Which features are covered by the definition, by applying the where SQL constraint
  • What text should be displayed, based on the individual feature's attributes and the labelExpression formula
  • How the text should appear, using the symbol
  • Where the text should appear, with respect to its feature, using the labelPlacement

Note: You cannot declare or create a component of this type in QML code.

Property Documentation

labelExpression : string

Simple expression describing how to build the text label for a feature, often using attributes of the feature. The default is an empty expression and no labels will be produced.

The Simple expression format is described at Labeling objects e.g., ""Addr: " CONCAT [Name] CONCAT " Street"" (the outer quotes are not part of the expression, but quotes are needed around the literal text).

labelPlacement : Enums.LabelingPlacement

Returns the placement of the label (read-only).

See also Enums.LabelingPlacement.

maxScale : double

Returns the maximum scale that this label class should be used (read-only).

minScale : double

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 minScale is 1:20000, then the labels will be visible (because 1/12000 >= 1/20000).

A minScale of 0, which is the default, indicates no lower limit on the viewing scale.

symbol : TextSymbol

Returns the symbol that is used for this label class (read-only).

useCodedValues : bool

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 values set up for the attribute fields.

The default value is false i.e. no translation will be done.

where : string

Limit the set of features for which labels will be generated and placed.

This is a SQL expression that can refer to the attributes of the feature e.g.:

  • "" (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 "".

Only features that satisfy the where clause will display labels.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.