Point Annotation Options
Builder class from which a pointAnnotation is created.
Constructors
Types
Functions
Build an annotation
Returns whether this pointAnnotation is draggable, meaning it can be dragged across the screen when touched and moved.
Get the geometry of the pointAnnotation, which represents the location of the pointAnnotation on the map
Set the arbitrary json data of the annotation.
Set whether this pointAnnotation should be draggable, meaning it can be dragged across the screen when touched and moved.
Set the geometry of the pointAnnotation, which represents the location of the pointAnnotation on the map
Set icon-anchor to initialise the pointAnnotation with.
Set icon-color to initialise the pointAnnotation with.
Set icon-emissive-strength to initialise the pointAnnotation with.
Set icon-halo-blur to initialise the pointAnnotation with.
Set icon-halo-color to initialise the pointAnnotation with.
Set icon-halo-width to initialise the pointAnnotation with.
Set bitmap icon-image to initialise the symbol.
Set icon-image to initialise the pointAnnotation with.
Set icon-image-cross-fade to initialise the pointAnnotation with.
Set icon-occlusion-opacity to initialise the pointAnnotation with.
Set icon-offset to initialise the pointAnnotation with.
Set icon-opacity to initialise the pointAnnotation with.
Set icon-rotate to initialise the pointAnnotation with.
Set icon-size to initialise the pointAnnotation with.
Set icon-text-fit to initialise the pointAnnotation with.
Set icon-text-fit-padding to initialise the pointAnnotation with.
Set the Point of the pointAnnotation, which represents the location of the pointAnnotation on the map
Set symbol-sort-key to initialise the pointAnnotation with.
Set symbol-z-offset to initialise the pointAnnotation with.
Set text-anchor to initialise the pointAnnotation with.
Set text-color to initialise the pointAnnotation with.
Set text-emissive-strength to initialise the pointAnnotation with.
Set text-field to initialise the pointAnnotation with.
Set text-halo-blur to initialise the pointAnnotation with.
Set text-halo-color to initialise the pointAnnotation with.
Set text-halo-width to initialise the pointAnnotation with.
Set text-justify to initialise the pointAnnotation with.
Set text-letter-spacing to initialise the pointAnnotation with.
Set text-line-height to initialise the pointAnnotation with.
Set text-max-width to initialise the pointAnnotation with.
Set text-occlusion-opacity to initialise the pointAnnotation with.
Set text-offset to initialise the pointAnnotation with.
Set text-opacity to initialise the pointAnnotation with.
Set text-radial-offset to initialise the pointAnnotation with.
Set text-rotate to initialise the pointAnnotation with.
Set text-size to initialise the pointAnnotation with.
Set text-transform to initialise the pointAnnotation with.
Properties
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 icon-size
to obtain the final offset in pixels. When combined with icon-rotate
the offset will be as if the rotated direction was up. Default value: 0,0.
Sorts features in ascending order based on this value. Features with lower sort keys are drawn and placed first. When icon-allow-overlap
or text-allow-overlap
is false
, features with a lower sort key will have priority during placement. When icon-allow-overlap
or text-allow-overlap
is set to true
, features with a higher sort key will overlap over features with a lower sort key.
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. Default value: 0,0.
Extensions
Set icon-color to initialise the pointAnnotation with.
Set icon-halo-color to initialise the pointAnnotation with.
Set text-color to initialise the pointAnnotation with.
Set text-halo-color to initialise the pointAnnotation with.