labelingInfo

The labelingInfo object specifies the label definition for a layer.

Referenced by: drawingInfo

Properties

Property Details
labelExpression Defines the expression for text of labels. Deprecated on FeatureLayer, Use labelExpressionInfo instead.
labelExpressionInfo The labelExpressionInfo allows label text to be read similar to that of Popups's description property.
labelPlacement This string property specifies the label placement with respect to that of its feature. A list of label placement values categorized by feature geometry types.
Valid values: esriServerLinePlacementAboveAfter, esriServerLinePlacementAboveAlong, esriServerLinePlacementAboveBefore, esriServerLinePlacementAboveEnd, esriServerLinePlacementAboveStart, esriServerLinePlacementBelowAfter, esriServerLinePlacementBelowAlong, esriServerLinePlacementBelowBefore, esriServerLinePlacementBelowEnd, esriServerLinePlacementBelowStart, esriServerLinePlacementCenterAfter, esriServerLinePlacementCenterAlong, esriServerLinePlacementCenterBefore, esriServerLinePlacementCenterEnd, esriServerLinePlacementCenterStart, esriServerPointLabelPlacementAboveCenter, esriServerPointLabelPlacementAboveLeft, esriServerPointLabelPlacementAboveRight, esriServerPointLabelPlacementBelowCenter, esriServerPointLabelPlacementBelowLeft, esriServerPointLabelPlacementBelowRight, esriServerPointLabelPlacementCenterCenter, esriServerPointLabelPlacementCenterLeft, esriServerPointLabelPlacementCenterRight, esriServerPolygonPlacementAlwaysHorizontal
maxScale Represents the maximum scale at which the layer definition will be applied.
minScale Represents the minimum scale at which the layer definition will be applied.
name The name of the label class.
symbol The text symbol used to label.
useCodedValues Boolean value indicating whether to display the coded values for the specified field name(s).
where String template used to determine which features to label.

labelingInfo Example

{
  "labelExpressionInfo": {
    "expression": "return $feature[\"state_name\"];"
  },
  "useCodedValues": false,
  "maxScale": 0,
  "minScale": 0,
  "labelPlacement": "esriServerPointLabelPlacementAboveLeft",
  "symbol": {
    "type": "LabelSymbol3D",
    "symbolLayers": [
      {
        "size": 32,
        "type": "Text",
        "material": {
          "color": [
            255,
            255,
            0
          ]
        }
      }
    ]
  }
}

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

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close