var textSymbol = new TextSymbol({
  color: "white",
  haloColor: "black",
  haloSize: "1px",
  text: "You are here",
  xoffset: 3,
  yoffset: 3,
  font: {  // autocast as esri/symbols/Font
    size: 12,
    family: "sans-serif",
    weight: "bolder"
  }
});

Property Overview

Property Details

declaredClassStringreadonly

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

decorationString

The text decoration.

Possible Values: underline | line-through | none

Known Limitations

This property is not supported in 3D SceneViews.

Default Value: none

familyString

The font family of the text.

Default Value: serif

See also:

• MDN: font-family

sizeNumber autocast

The font size in points. This value may be autocast with a string expressing size in points or pixels (e.g. 12px).

Default Value: 9

See also:

• MDN: font-size

Examples:

// size in points
symbol.size = 14;

// size in pixels
symbol.size = "20px";

// size in points
symbol.size = "14pt";

styleString

The text style.

Possible Values: normal | italic | oblique

Default Value: normal

See also:

• MDN: font-style

variantString

The text variant.

Possible Values: normal | small-caps

Known Limitations

This property is not supported in 3D SceneViews.

Default Value: normal

See also:

• MDN: font-variant

weightString

The text weight.

Possible Values: normal | bold | bolder | lighter

Default Value: normal

See also:

• MDN: font-weight

Method Overview

Method Details

clone(){Font}

Creates a deep clone of the font object.

Returns:

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

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}

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.