Point Annotation
Composable function to add a PointAnnotation to the Map.
Parameters
The Point of the pointAnnotation, which represents the location of the pointAnnotation on the map.
The bitmap image for this Symbol. Not it will not take effect if iconImage has been set.
Part of the icon placed closest to the anchor.
Name of image in sprite to use for drawing an image background.
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.
Rotates the icon clockwise. The unit of iconRotate is in degrees.
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.
Scales the icon to fit around the associated text.
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.
Part of the text placed closest to the anchor.
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.
Text justification options.
Text tracking amount. The unit of textLetterSpacing is in ems.
Text leading value for multi-line text. The unit of textLineHeight is in ems.
The maximum line width for text wrapping. The unit of textMaxWidth is in ems.
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.
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.
Rotates the text clockwise. The unit of textRotate is in degrees.
Font size. The unit of textSize is in density-independent pixels.
Specifies how to capitalize text, similar to the CSS {@link PropertyFactory#textTransform} property.
The color of the icon. This can only be used with /help/troubleshooting/using-recolorable-images-in-mapbox-maps/. The property is set as Color Int.
The color of the icon. This can only be used with /help/troubleshooting/using-recolorable-images-in-mapbox-maps/. The property is set as Color String.
Controls the intensity of light emitted on the source features. The unit of iconEmissiveStrength is in intensity.
Fade out the halo towards the outside. The unit of iconHaloBlur is in density-independent pixels.
The color of the icon's halo. Icon halos can only be used with /help/troubleshooting/using-recolorable-images-in-mapbox-maps/. The property is set as Color Int.
The color of the icon's halo. Icon halos can only be used with /help/troubleshooting/using-recolorable-images-in-mapbox-maps/. The property is set as Color String.
Distance of halo to the icon outline. The unit of iconHaloWidth is in density-independent pixels.
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.
The opacity at which the icon will be drawn.
The color with which the text will be drawn. The property is set as Color Int.
The color with which the text will be drawn. The property is set as Color String.
Controls the intensity of light emitted on the source features. The unit of textEmissiveStrength is in intensity.
The halo's fadeout distance towards the outside. The unit of textHaloBlur is in density-independent pixels.
The color of the text's halo, which helps it stand out from backgrounds. The property is set as Color Int.
The color of the text's halo, which helps it stand out from backgrounds. The property is set as Color String.
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.
The opacity at which the text will be drawn.
Callback to be invoked when the PointAnnotation is clicked. The clicked PointAnnotation will be passed as parameter.