TextSymbol3DLayer

let labelClass = new LabelClass({
  labelExpressionInfo: {
    expression: "$feature.COUNTY" // Text for labels comes from COUNTY field
  },
  symbol: {
    type: "label-3d",  // autocasts as new LabelSymbol3D()
    symbolLayers: [{
      type: "text",  // autocasts as 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

background Accessorautocast

The background of the text. The background can be used to define a background color for the text to improve readability by increasing contrast with the background. Setting a background will add additional padding to the text and display using rounded corners.

Property

color Color optional Autocasts from Object|Number[]|String The color of the background.

Example

symbolLayer.background = { color: [0, 0, 0, 0.75] };

declaredClass Stringreadonly inherited

Since: ArcGIS Maps SDK for JavaScript 4.7

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

font Font

The font of the text label.

halo Objectautocast

Since: ArcGIS Maps SDK for JavaScript 4.4

The halo surrounding the text.

Properties

color Color optional Default Value:black Autocasts from Object|Number[]|String The color of the halo. This can be autocast with an array of rgb(a) values, named string, hex string or an hsl(a) string, an object with r, g, b, and a properties, or a Color object.

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

Example

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

horizontalAlignment String

Since: ArcGIS Maps SDK for JavaScript 4.23

Adjusts the horizontal alignment of the text in multi-lines.

Known Limitations

• This property only applies when the symbol layer is not used for labeling purposes. The horizontalAlignment for labels is inferred from the labelPlacement value.
• If the symbol layer is added to a symbol with a line callout or vertical offset, then only center is supported.

Possible Values:"left"|"right"|"center"

Default Value:"center"

lineHeight Number

Since: ArcGIS Maps SDK for JavaScript 4.23

The height of the space between each line of text. Only applies to multiline text.

This property can be considered as a multiplier of the default value of 1.0 (e.g. a value of 2.0 will be two times the height of the default height). The range of possible values is: 0.1 - 4.0. If a value of 0 is specified, the default value of 1.0 will be used.

Default Value:1.0

material Objectautocast

The material used to color the text.

Property

color Color optional Default Value:white Autocasts from Object|Number[]|String The color of the text. This can be autocast with an array of rgb(a) values, named string, hex string or an hsl(a) string, an object with r, g, b, and a properties, or a Color object.

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 }
};

size Numberautocast

Autocasts from Number|String

Size of the text label in points. This value may be autocast with a string expressing size in points or pixels (e.g. 12px). When set, this property overrides the font.size property.

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

text String

The text to be displayed. To manually create a new line, use the \n escape character.

Examples

symbolLayer.text = "You are here";

symbolLayer.text = "Wish you were \n here";

type Stringreadonly

The symbol type.

For TextSymbol3DLayer the type is always "text".

verticalAlignment String

Since: ArcGIS Maps SDK for JavaScript 4.23

Adjusts the vertical alignment of the text.

Known Limitations

• This property only applies when the symbol layer is not used for labeling purposes. The verticalAlignment for labels is inferred from the labelPlacement value.

Possible Values:"baseline"|"top"|"middle"|"bottom"

Default Value:"baseline"

Method Overview

Method Details

addHandles(handleOrHandles, groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 4.25

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle[] Handles marked for removal once the object is destroyed.

groupKey * optional Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

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
const symbolLayer = 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 an ArcGIS product. 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.

hasHandles(groupKey){Boolean}inherited

Since: ArcGIS Maps SDK for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter

groupKey * optional A group key.

Returns

Type	Description
Boolean	Returns true if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles(groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter

groupKey * optional A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toJSON(){Object}inherited

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

Returns

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