The labelingInfo object specifies the label definition for a layer.

Referenced by: drawingInfo

Properties

PropertyDetails
labelExpressionDefines the expression for text of labels. Deprecated on FeatureLayer, Use labelExpressionInfo instead.
labelExpressionInfoThe labelExpressionInfo allows label text to be read similar to that of Popups’s description property.
labelPlacementThis 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
maxScaleRepresents the maximum scale at which the layer definition will be applied.
minScaleRepresents the minimum scale at which the layer definition will be applied.
nameThe name of the label class.
symbolThe text symbol used to label.
useCodedValuesBoolean value indicating whether to display the coded values for the specified field name(s).
whereString 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
]
}
}
]
}
}