PointAnnotationState

The state holder for PointAnnotation properties.

Constructors

Link copied to clipboard

Properties

Link copied to clipboard

Part of the icon placed closest to the anchor.

Link copied to clipboard

The color of the icon. This can only be used with /help/troubleshooting/using-recolorable-images-in-mapbox-maps/.

Link copied to clipboard

Controls the intensity of light emitted on the source features. The unit of iconEmissiveStrength is in intensity.

Link copied to clipboard

Fade out the halo towards the outside. The unit of iconHaloBlur is in density-independent pixels.

Link copied to clipboard

The color of the icon's halo. Icon halos can only be used with /help/troubleshooting/using-recolorable-images-in-mapbox-maps/.

Link copied to clipboard

Distance of halo to the icon outline. The unit of iconHaloWidth is in density-independent pixels.

Link copied to clipboard

Name of image in sprite to use for drawing an image background.

Link copied to clipboard

Controls the transition progress between the image variants of icon-image. Zero means the first variant is used, one is the second, and in between they are blended together.

Link copied to clipboard

The opacity at which the icon will be drawn in case of being depth occluded. Absent value means full occlusion against terrain only.

Link copied to clipboard

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.

Link copied to clipboard

The opacity at which the icon will be drawn.

Link copied to clipboard

Rotates the icon clockwise. The unit of iconRotate is in degrees.

Link copied to clipboard

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. The unit of iconSize is in factor of the original icon size.

Link copied to clipboard

Scales the icon to fit around the associated text.

Link copied to clipboard

Size of the additional area added to dimensions determined by {@link Property.ICON_TEXT_FIT}, in clockwise order: top, right, bottom, left. The unit of iconTextFitPadding is in density-independent pixels.

Link copied to clipboard

Specifies an uniform elevation from the ground, in meters.

Link copied to clipboard

Part of the text placed closest to the anchor.

Link copied to clipboard

The color with which the text will be drawn.

Link copied to clipboard

Controls the intensity of light emitted on the source features. The unit of textEmissiveStrength is in intensity.

Link copied to clipboard

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. SDF images are not supported in formatted text and will be ignored.

Link copied to clipboard

The halo's fadeout distance towards the outside. The unit of textHaloBlur is in density-independent pixels.

Link copied to clipboard

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

Link copied to clipboard

Distance of halo to the font outline. Max text halo width is 1/4 of the font-size. The unit of textHaloWidth is in density-independent pixels.

Link copied to clipboard

Text justification options.

Link copied to clipboard

Text tracking amount. The unit of textLetterSpacing is in ems.

Link copied to clipboard

Text leading value for multi-line text. The unit of textLineHeight is in ems.

Link copied to clipboard

The maximum line width for text wrapping. The unit of textMaxWidth is in ems.

Link copied to clipboard

The opacity at which the text will be drawn in case of being depth occluded. Absent value means full occlusion against terrain only.

Link copied to clipboard

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. The unit of textOffset is in ems.

Link copied to clipboard

The opacity at which the text will be drawn.

Link copied to clipboard

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. The unit of textRadialOffset is in ems.

Link copied to clipboard

Rotates the text clockwise. The unit of textRotate is in degrees.

Link copied to clipboard

Font size. The unit of textSize is in density-independent pixels.

Link copied to clipboard

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