Click or drag to resize

LabelDefinitionPriority Property

Gets or sets a number that defines which labels are placed first, and can also supplant existing lower-priority labels (e.g. during panning).

Namespace:  Esri.ArcGISRuntime.Mapping
Assembly:  Esri.ArcGISRuntime (in Esri.ArcGISRuntime.dll) Version: 100.11.0
Syntax
public double Priority { get; set; }

Property Value

Type: Double
Remarks

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.

See Also