Symbol Object

Save PDF

TextSymbol

Text symbols are used to add text to a feature (labeling).

The following table provides the specific configurable options available for TextSymbol:

Property	Type	Description
angle [Optional]	Number	Defines text rotation in counter-clockwise degrees.
backgroundColor [Optional]	Color	Defines text background color (Color array in [R,G,B,A] format. [number, number, number, number]).
borderLineColor [Optional]	Color	Defines text border line color (Color array in [R,G,B,A] format. [number, number, number, number]).
borderLineSize [Optional]	Number	Defines text border width in points.
color [Optional]	Color	Defines text color (Color array in [R,G,B,A] format. [number, number, number, number]).
font [Optional]	Font	Defines text font configuration.
haloColor [Optional]	Color	Defines color for the halo around the text (Color array in [R,G,B,A] format. [number, number, number, number]).
haloSize [Optional]	Number	Defines size in points for the halo around the text.
horizontalAlignment [Optional]	HorizontalAlignment	Defines text horizontal alignment (Values: "left" \| "right" \| "center" \| "justify").
text	String	Defines text to display.
type	esriTS	A type of Symbol.
verticalAlignment [Optional]	VerticalAlignment	Defines text vertical alignment (Values: "baseline" \| "top" \| "middle" \| "bottom").
xoffset [Optional]	Number	Defines text horizontal offset in points.
yoffset [Optional]	Number	Defines text vertical offset in points.

Picture marker symbols are used to symbolize point geometries with an image. It is possible to select an image URL or load a picture from a file.

Below is the configurable option for image url.

Property	Type	Description
url	string	Defines Picture URL.

Below is the configurable option for a symbol from a file.

Property	Type	Description
imageData	string	Defines Base64 encoded image data.

Simple line symbols can be used to symbolize polyline geometries or outlines for polygon fills.

Below are the configurable options.

Property	Type	Description
color	Color	Defines line color (Color array in [R,G,B,A] format. [number, number, number, number]).
Style [Optional]	Style	Defines line dash style. Values: "esriSLSDash" \| "esriSLSDashDot" \| "esriSLSDashDotDot" \| "esriSLSDot" \| "esriSLSNull" \| "esriSLSSolid"
type	esriSLS	A type of Symbol.
width [Optional]	number	Defines line width in points.

Simple marker symbols can be used to symbolize point geometries with simple geometric figures.

Below are the configurable options.

Property	Type	Description
angle [Optional]	Number	Defines symbol rotation in counter-clockwise degrees.
color	Color	Defines symbol color (Color array in [R,G,B,A] format. [number, number, number, number]).
outline [Optional]	SimpleLineSymbol	Defines symbol outline (border) configuration. More details in SimpleLineSymbol section.
size	Number	Defines symbol size (radius) in points.
Style	Style	Defines geometry figure to use as marker. Values: "esriSMSCircle" \| "esriSMSCross" \| "esriSMSDiamond" \| "esriSMSSquare" \| "esriSMSX" \| "esriSMSTriangle"
type	esriSMS	A type of Symbol.
xoffset [Optional]	Number	Defines symbol horizontal offset in points.
yoffset [Optional]	Number	Defines symbol vertical offset in points.

Simple fill symbols can be used to symbolize polygon geometries with solid color or line patterns.

Below are the configurable options.

Property	Type	Description
color	Color	Defines fill color (Color array in [R,G,B,A] format. [number, number, number, number]).
outline [Optional]	SimpleLineSymbol	Defines outline (border) configuration. More details in SimpleLineSymbol section.
size	Number	Defines symbol size (radius) in points.
Style	Style	Fill style (pattern). Values: "esriSFSBackwardDiagonal" \| "esriSFSCross" \| "esriSFSDiagonalCross" \| "esriSFSForwardDiagonal" \| "esriSFSHorizontal" \| "esriSFSNull" \| "esriSFSSolid" \| "esriSFSVertical"
type	esriSMS	A type of Symbol.

Picture fill symbols can be used to symbolize polygon geometries. It is possible to select an image URL or load a picture from a file.

Below is the configurable option for image url.

Property	Type	Description
url	string	Defines picture URL.

Below is the configurable option for a symbol from a file.

Property	Type	Description
imageData	string	Defines Base64 encoded image data.