SymbolOptions

Static variables and methods.

Build an annotation

Get the arbitrary json data of the annotation.

Returns whether this symbol is draggable, meaning it can be dragged across the screen when touched and moved.

Get the geometry of the symbol, which represents the location of the symbol on the map

Get the Point of the symbol, which represents the location of the symbol on the map

Set the arbitrary json data of the annotation.

Set whether this symbol should be draggable, meaning it can be dragged across the screen when touched and moved.

Set the geometry of the symbol, which represents the location of the symbol on the map

Set icon-anchor to initialise the symbol with.

<p> Part of the icon placed closest to the anchor. </p>

Set icon-color to initialise the symbol with.

<p> The color of the icon. This can only be used with sdf icons. </p>

Set icon-halo-blur to initialise the symbol with.

<p> Fade out the halo towards the outside. </p>

Set icon-halo-color to initialise the symbol with.

<p> The color of the icon's halo. Icon halos can only be used with SDF icons. </p>

Set icon-halo-width to initialise the symbol with.

<p> Distance of halo to the icon outline. </p>

Set icon-image to initialise the symbol with.

<p> Name of image in sprite to use for drawing an image background. </p>

Set icon-offset to initialise the symbol with.

<p> Offset distance of icon from its anchor. Positive values indicate right and down, while negative values indicate left and up. Each component is multiplied by the value of {@link PropertyFactory#iconSize} to obtain the final offset in density-independent pixels. When combined with {@link PropertyFactory#iconRotate} the offset will be as if the rotated direction was up. </p>

Set icon-opacity to initialise the symbol with.

<p> The opacity at which the icon will be drawn. </p>

Set icon-rotate to initialise the symbol with.

<p> Rotates the icon clockwise. </p>

Set icon-size to initialise the symbol with.

<p> Scales the original size of the icon by the provided factor. The new pixel size of the image will be the original pixel size multiplied by {@link PropertyFactory#iconSize}. 1 is the original size; 3 triples the size of the image. </p>

Set the Point of the symbol, which represents the location of the symbol on the map

Set symbol-sort-key to initialise the symbol with.

<p> Sorts features in ascending order based on this value. Features with lower sort keys are drawn and placed first. When {@link PropertyFactory#iconAllowOverlap} or {@link PropertyFactory#textAllowOverlap} is `false`, features with a lower sort key will have priority during placement. When {@link PropertyFactory#iconAllowOverlap} or {@link PropertyFactory#textAllowOverlap} is set to `true`, features with a higher sort key will overlap over features with a lower sort key. </p>

Set text-anchor to initialise the symbol with.

<p> Part of the text placed closest to the anchor. </p>

Set text-color to initialise the symbol with.

<p> The color with which the text will be drawn. </p>

Set text-field to initialise the symbol with.

<p> Value to use for a text label. If a plain `string` is provided, it will be treated as a `formatted` with default/inherited formatting options. </p>

Set text-font to initialise the symbol with.

<p> Font stack to use for displaying text. </p>

Set text-halo-blur to initialise the symbol with.

<p> The halo's fadeout distance towards the outside. </p>

Set text-halo-color to initialise the symbol with.

<p> The color of the text's halo, which helps it stand out from backgrounds. </p>

Set text-halo-width to initialise the symbol with.

<p> Distance of halo to the font outline. Max text halo width is 1/4 of the font-size. </p>

Set text-justify to initialise the symbol with.

<p> Text justification options. </p>

Set text-letter-spacing to initialise the symbol with.

<p> Text tracking amount. </p>

Set text-max-width to initialise the symbol with.

<p> The maximum line width for text wrapping. </p>

Set text-offset to initialise the symbol with.

<p> Offset distance of text from its anchor. Positive values indicate right and down, while negative values indicate left and up. If used with text-variable-anchor, input values will be taken as absolute values. Offsets along the x- and y-axis will be applied automatically based on the anchor position. </p>

Set text-opacity to initialise the symbol with.

<p> The opacity at which the text will be drawn. </p>

Set text-radial-offset to initialise the symbol with.

<p> Radial offset of text, in the direction of the symbol's anchor. Useful in combination with {@link PropertyFactory#textVariableAnchor}, which defaults to using the two-dimensional {@link PropertyFactory#textOffset} if present. </p>

Set text-rotate to initialise the symbol with.

<p> Rotates the text clockwise. </p>

Set text-size to initialise the symbol with.

<p> Font size. </p>

Set text-transform to initialise the symbol with.

<p> Specifies how to capitalize text, similar to the CSS {@link PropertyFactory#textTransform} property. </p>