Point Annotation Manager
The pointAnnotation manager allows to add pointAnnotations to a map.
Constructors
Types
Functions
Properties
The added annotations
The Added clickListeners
The delegateProvider
The added dragListeners
The IconAllowOverlap property
If true, the icon will be visible even if it collides with other previously drawn symbols.
The IconIgnorePlacement property
If true, other symbols can be visible even if they collide with the icon.
The IconKeepUpright property
If true, the icon may be flipped to prevent it from being rendered upside-down.
The IconOptional property
If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not.
The IconPadding property
Size of the additional area around the icon bounding box used for detecting symbol collisions.
The IconPitchAlignment property
Orientation of icon when map is pitched.
The IconRotationAlignment property
In combination with {@link Property.SYMBOL_PLACEMENT}, determines the rotation behavior of icons.
The IconTextFit property
Scales the icon to fit around the associated text.
The IconTextFitPadding property
Size of the additional area added to dimensions determined by {@link Property.ICON_TEXT_FIT}, in clockwise order: top, right, bottom, left.
The IconTranslate property
Distance that the icon's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.
The IconTranslateAnchor property
Controls the frame of reference for {@link PropertyFactory#iconTranslate}.
The added interactionListener
The filter on the managed pointAnnotations.
The added longClickListeners
The SymbolAvoidEdges property
If true, the symbols will not cross tile edges to avoid mutual collisions. Recommended in layers that don't have enough padding in the vector tile to prevent collisions, or if it is a point symbol layer placed after a line symbol layer. When using a client that supports global collision detection, like Mapbox GL JS version 0.42.0 or greater, enabling this property is not needed to prevent clipped labels at tile boundaries.
The SymbolPlacement property
Label placement relative to its geometry.
The SymbolSpacing property
Distance between two symbol anchors.
The TextAllowOverlap property
If true, the text will be visible even if it collides with other previously drawn symbols.
The TextIgnorePlacement property
If true, other symbols can be visible even if they collide with the text.
The TextKeepUpright property
If true, the text may be flipped vertically to prevent it from being rendered upside-down.
The TextLineHeight property
Text leading value for multi-line text.
The TextMaxAngle property
Maximum angle change between adjacent characters.
The TextOptional property
If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not.
The TextPadding property
Size of the additional area around the text bounding box used for detecting symbol collisions.
The TextPitchAlignment property
Orientation of text when map is pitched.
The TextRotationAlignment property
In combination with {@link Property.SYMBOL_PLACEMENT}, determines the rotation behavior of the individual glyphs forming the text.
The TextTranslate property
Distance that the text's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.
The TextTranslateAnchor property
Controls the frame of reference for {@link PropertyFactory#textTranslate}.
The TextVariableAnchor property
To increase the chance of placing high-priority labels on the map, you can provide an array of {@link Property.TEXT_ANCHOR} locations: the renderer will attempt to place the label at each location, in order, before moving onto the next label. Use text-justify: auto
to choose justification based on anchor position. To apply an offset, use the {@link PropertyFactory#textRadialOffset} or the two-dimensional {@link PropertyFactory#textOffset}.
The TextWritingMode property
The property allows control over a symbol's orientation. Note that the property values act as a hint, so that a symbol whose language doesn’t support the provided orientation will be laid out in its natural orientation. Example: English point symbol will be rendered horizontally even if array value contains single 'vertical' enum value. The order of elements in an array define priority order for the placement of an orientation variant.