Point Annotation Group
Composable function to add a PointAnnotationGroup to the Map.
The PointAnnotationGroup is more performant than adding multiple PointAnnotation individually, because the PointAnnotationGroup is added to the map as a single layer.
PointAnnotationGroup and CircleAnnotationGroup can also be clustered based on the configuration, see AnnotationConfig.annotationSourceOptions and ClusterOptions for more details.
Parameters
List of PointAnnotationOptions to be added to the group.
Configuration for PointAnnotationCluster.
If true, the icon will be visible even if it collides with other previously drawn symbols.
If true, other symbols can be visible even if they collide with the icon.
If true, the icon may be flipped to prevent it from being rendered upside-down.
If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not.
Size of the additional area around the icon bounding box used for detecting symbol collisions. The unit of iconPadding is in density-independent pixels.
Orientation of icon when map is pitched.
In combination with {@link Property.SYMBOL_PLACEMENT}, determines the rotation behavior of icons.
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.
Label placement relative to its geometry.
Distance between two symbol anchors. The unit of symbolSpacing is in density-independent pixels.
Position symbol on buildings (both fill extrusions and models) rooftops. In order to have minimal impact on performance, this is supported only when {@link PropertyFactory#fillExtrusionHeight} is not zoom-dependent and remains unchanged. For fading in buildings when zooming in, fill-extrusion-vertical-scale should be used and symbols would raise with building rooftops. Symbols are sorted by elevation, except in cases when viewport-y
sorting or {@link PropertyFactory#symbolSortKey} are applied.
Determines whether overlapping symbols in the same layer are rendered in the order that they appear in the data source or by their y-position relative to the viewport. To control the order and prioritization of symbols otherwise, use {@link PropertyFactory#symbolSortKey}.
If true, the text will be visible even if it collides with other previously drawn symbols.
Font stack to use for displaying text.
If true, other symbols can be visible even if they collide with the text.
If true, the text may be flipped vertically to prevent it from being rendered upside-down.
Maximum angle change between adjacent characters. The unit of textMaxAngle is in degrees.
If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not.
Size of the additional area around the text bounding box used for detecting symbol collisions. The unit of textPadding is in density-independent pixels.
Orientation of text when map is pitched.
In combination with {@link Property.SYMBOL_PLACEMENT}, determines the rotation behavior of the individual glyphs forming the text.
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 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. For symbol with point placement, the order of elements in an array define priority order for the placement of an orientation variant. For symbol with line placement, the default text writing mode is either 'horizontal', 'vertical' or 'vertical', 'horizontal', the order doesn't affect the placement.
Controls saturation level of the symbol icon. With the default value of 1 the icon color is preserved while with a value of 0 it is fully desaturated and looks black and white. The unit of iconColorSaturation is in intensity.
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 unit of iconTranslate is in density-independent pixels.
Controls the frame of reference for {@link PropertyFactory#iconTranslate}.
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 unit of textTranslate is in density-independent pixels.
Controls the frame of reference for {@link PropertyFactory#textTranslate}.
Callback to be invoked when one of the PointAnnotation in the cluster is clicked. The clicked PointAnnotation will be passed as parameter.