var labelClass = new LabelClass({
  labelExpressionInfo: {
    value: "{COUNTY}"  // Text for labels comes from COUNTY field
  },
  symbol: new LabelSymbol3D({
    symbolLayers: [new TextSymbol3DLayer({
      material: { color: [ 49,163,84 ] },
      size: 12  // points
    })]
  })
});
// Add labels to the feature layer
featureLayer.labelsVisible = true;
featureLayer.labelingInfo = [ labelClass ];

Property Overview

Property Details

declaredClassStringreadonly

The name of the class. The declared class name is formatted as esri.folder.className.

fontObject

The font of the text label.

Properties:

family String optional The font family. See MDN: font-family. Default Value: Arial

weight String optional The font weight. Known Values: normal | bold Default Value: normal

style String optional The font style. Known Values: normal | italic Default Value: normal

haloObject

Since: ArcGIS API for JavaScript 4.4

The halo surrounding the text.

Properties:

color Color optional The color of the halo. This can be autocast with a named string, hex string, array of rgb or rgba values, an object with r, g, b, and a properties, or a Color object. Default value: black

size Number optional The size of the halo in points. This value may be autocast with a string expressing size in points or pixels (e.g. 12px). Default value: 0

Example:

symbolLayer.halo = {
 color: [255, 255, 255, 0.8], // autocasts as Color
 size: 2
}

materialObject

The material used to color the text.

Property:

color Color optional The color of the text. This can be autocast with a named string, hex string, array of rgb or rgba values, an object with r, g, b, and a properties, or a Color object. Default value: white

Examples:

// CSS color string
symbolLayer.material = {
  color: "dodgerblue"
};

// HEX string
symbolLayer.material = {
  color: "#33cc33";
}

// array of RGBA values
symbolLayer.material = {
  color: [51, 204, 51, 0.3];
}

// object with rgba properties
symbolLayer.material = {
  color: {
    r: 51,
    g: 51,
    b: 204,
    a: 0.7
  }
};

sizeNumber autocast

Size of the text label in points. This value may be autocast with a string expressing size in points or pixels (e.g. 12px).

Default Value: 9

Examples:

// size in points
symbolLayer.size = 14;

// size in pixels
symbolLayer.size = "20px"; // autocasts as number

// size in points
symbolLayer.size = "14pt"; // autocasts as number

textString

The text to be displayed.

Example:

symbolLayer.text = "You are here";

typeStringreadonly

For TextSymbol3DLayer, the type is always text.

Method Overview

Method Details

clone(){TextSymbol3DLayer}

Creates a deep clone of the symbol layer.

Returns:

Type	Description
TextSymbol3DLayer	A deep clone of the object that invoked this method.

Example:

// Creates a deep clone of the graphic's first symbol layer
var symLyr = graphic.symbol.symbolLayers.getItemAt(0).clone();

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:

json Object A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:

Type	Description
*	Returns a new instance of this class.

toJSON(){Object}inherited

Converts an instance of this class to its ArcGIS Portal JSON representation. See the Using fromJSON() topic in the Guide for more information.

Returns:

Type	Description
Object	The ArcGIS Portal JSON representation of an instance of this class.