PointAnnotationManager class
The PointAnnotationManager to add/update/delete PointAnnotationAnnotations on the map.
- Inheritance
-
- Object
- BaseAnnotationManager
- PointAnnotationManager
Properties
Methods
-
addOnPointAnnotationClickListener(
OnPointAnnotationClickListener listener) → void - Add a listener to receive the callback when an annotation is clicked.
-
create(
PointAnnotationOptions annotation) → Future< PointAnnotation> - Create a new annotation with the option.
-
createMulti(
List< PointAnnotationOptions> annotations) → Future<List< PointAnnotation?> > - Create multi annotations with the options.
-
delete(
PointAnnotation annotation) → Future< void> - Delete an added annotation.
-
deleteAll(
) → Future< void> - Delete all the annotation added by this manager.
-
getIconAllowOverlap(
) → Future< bool?> - If true, the icon will be visible even if it collides with other previously drawn symbols. Default value: false.
-
getIconAnchor(
) → Future< IconAnchor?> - Part of the icon placed closest to the anchor. Default value: "center".
-
getIconColor(
) → Future< int?> - The color of the icon. This can only be used with SDF icons. Default value: "#000000".
-
getIconColorSaturation(
) → Future< double?> -
Increase or reduce the saturation of the symbol icon. Default value: 0. Value range:
-1, 1 -
getIconEmissiveStrength(
) → Future< double?> - Controls the intensity of light emitted on the source features. Default value: 1. Minimum value: 0.
-
getIconHaloBlur(
) → Future< double?> - Fade out the halo towards the outside. Default value: 0. Minimum value: 0.
-
getIconHaloColor(
) → Future< int?> - The color of the icon's halo. Icon halos can only be used with SDF icons. Default value: "rgba(0, 0, 0, 0)".
-
getIconHaloWidth(
) → Future< double?> - Distance of halo to the icon outline. Default value: 0. Minimum value: 0.
-
getIconIgnorePlacement(
) → Future< bool?> - If true, other symbols can be visible even if they collide with the icon. Default value: false.
-
getIconImage(
) → Future< String?> - Name of image in sprite to use for drawing an image background.
-
getIconImageCrossFade(
) → Future< double?> -
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. Default value: 0. Value range:
0, 1 -
getIconKeepUpright(
) → Future< bool?> - If true, the icon may be flipped to prevent it from being rendered upside-down. Default value: false.
-
getIconOcclusionOpacity(
) → Future< double?> -
The opacity at which the icon will be drawn in case of being depth occluded. Absent value means full occlusion against terrain only. Default value: 0. Value range:
0, 1 -
getIconOffset(
) → Future< List< double?> ?> -
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-sizeto obtain the final offset in pixels. When combined withicon-rotatethe offset will be as if the rotated direction was up. Default value:0,0. -
getIconOpacity(
) → Future< double?> -
The opacity at which the icon will be drawn. Default value: 1. Value range:
0, 1 -
getIconOptional(
) → Future< bool?> - If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not. Default value: false.
-
getIconPadding(
) → Future< double?> - Size of the additional area around the icon bounding box used for detecting symbol collisions. Default value: 2. Minimum value: 0.
-
getIconPitchAlignment(
) → Future< IconPitchAlignment?> - Orientation of icon when map is pitched. Default value: "auto".
-
getIconRotate(
) → Future< double?> - Rotates the icon clockwise. Default value: 0.
-
getIconRotationAlignment(
) → Future< IconRotationAlignment?> -
In combination with
symbol-placement, determines the rotation behavior of icons. Default value: "auto". -
getIconSize(
) → Future< double?> -
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
icon-size. 1 is the original size; 3 triples the size of the image. Default value: 1. Minimum value: 0. -
getIconTextFit(
) → Future< IconTextFit?> - Scales the icon to fit around the associated text. Default value: "none".
-
getIconTextFitPadding(
) → Future< List< double?> ?> -
Size of the additional area added to dimensions determined by
icon-text-fit, in clockwise order: top, right, bottom, left. Default value:0,0,0,0. -
getIconTranslate(
) → Future< List< double?> ?> -
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. Default value:
0,0. -
getIconTranslateAnchor(
) → Future< IconTranslateAnchor?> -
Controls the frame of reference for
icon-translate. Default value: "map". -
getSymbolAvoidEdges(
) → Future< bool?> - 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. Default value: false.
-
getSymbolElevationReference(
) → Future< SymbolElevationReference?> - Selects the base of symbol-elevation. Default value: "ground".
-
getSymbolPlacement(
) → Future< SymbolPlacement?> - Label placement relative to its geometry. Default value: "point".
-
getSymbolSortKey(
) → Future< double?> -
Sorts features in ascending order based on this value. Features with lower sort keys are drawn and placed first. When
icon-allow-overlaportext-allow-overlapisfalse, features with a lower sort key will have priority during placement. Whenicon-allow-overlaportext-allow-overlapis set totrue, features with a higher sort key will overlap over features with a lower sort key. -
getSymbolSpacing(
) → Future< double?> - Distance between two symbol anchors. Default value: 250. Minimum value: 1.
-
getSymbolZElevate(
) → Future< bool?> -
Position symbol on buildings (both fill extrusions and models) rooftops. In order to have minimal impact on performance, this is supported only when
fill-extrusion-heightis 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 whenviewport-ysorting orsymbol-sort-keyare applied. Default value: false. -
getSymbolZOffset(
) → Future< double?> - Specifies an uniform elevation from the ground, in meters. Default value: 0. Minimum value: 0.
-
getSymbolZOrder(
) → Future< SymbolZOrder?> -
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
symbol-sort-key. Default value: "auto". -
getTextAllowOverlap(
) → Future< bool?> - If true, the text will be visible even if it collides with other previously drawn symbols. Default value: false.
-
getTextAnchor(
) → Future< TextAnchor?> - Part of the text placed closest to the anchor. Default value: "center".
-
getTextColor(
) → Future< int?> - The color with which the text will be drawn. Default value: "#000000".
-
getTextEmissiveStrength(
) → Future< double?> - Controls the intensity of light emitted on the source features. Default value: 1. Minimum value: 0.
-
getTextField(
) → Future< String?> -
Value to use for a text label. If a plain
stringis provided, it will be treated as aformattedwith default/inherited formatting options. SDF images are not supported in formatted text and will be ignored. Default value: "". -
getTextFont(
) → Future< List< String?> ?> - Font stack to use for displaying text.
-
getTextHaloBlur(
) → Future< double?> - The halo's fadeout distance towards the outside. Default value: 0. Minimum value: 0.
-
getTextHaloColor(
) → Future< int?> - The color of the text's halo, which helps it stand out from backgrounds. Default value: "rgba(0, 0, 0, 0)".
-
getTextHaloWidth(
) → Future< double?> - Distance of halo to the font outline. Max text halo width is 1/4 of the font-size. Default value: 0. Minimum value: 0.
-
getTextIgnorePlacement(
) → Future< bool?> - If true, other symbols can be visible even if they collide with the text. Default value: false.
-
getTextJustify(
) → Future< TextJustify?> - Text justification options. Default value: "center".
-
getTextKeepUpright(
) → Future< bool?> - If true, the text may be flipped vertically to prevent it from being rendered upside-down. Default value: true.
-
getTextLetterSpacing(
) → Future< double?> - Text tracking amount. Default value: 0.
-
getTextLineHeight(
) → Future< double?> - Text leading value for multi-line text. Default value: 1.2.
-
getTextMaxAngle(
) → Future< double?> - Maximum angle change between adjacent characters. Default value: 45.
-
getTextMaxWidth(
) → Future< double?> - The maximum line width for text wrapping. Default value: 10. Minimum value: 0.
-
getTextOcclusionOpacity(
) → Future< double?> -
The opacity at which the text will be drawn in case of being depth occluded. Absent value means full occlusion against terrain only. Default value: 0. Value range:
0, 1 -
getTextOffset(
) → Future< List< double?> ?> -
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. -
getTextOpacity(
) → Future< double?> -
The opacity at which the text will be drawn. Default value: 1. Value range:
0, 1 -
getTextOptional(
) → Future< bool?> - If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not. Default value: false.
-
getTextPadding(
) → Future< double?> - Size of the additional area around the text bounding box used for detecting symbol collisions. Default value: 2. Minimum value: 0.
-
getTextPitchAlignment(
) → Future< TextPitchAlignment?> - Orientation of text when map is pitched. Default value: "auto".
-
getTextRadialOffset(
) → Future< double?> -
Radial offset of text, in the direction of the symbol's anchor. Useful in combination with
text-variable-anchor, which defaults to using the two-dimensionaltext-offsetif present. Default value: 0. -
getTextRotate(
) → Future< double?> - Rotates the text clockwise. Default value: 0.
-
getTextRotationAlignment(
) → Future< TextRotationAlignment?> -
In combination with
symbol-placement, determines the rotation behavior of the individual glyphs forming the text. Default value: "auto". -
getTextSize(
) → Future< double?> - Font size. Default value: 16. Minimum value: 0.
-
getTextTransform(
) → Future< TextTransform?> -
Specifies how to capitalize text, similar to the CSS
text-transformproperty. Default value: "none". -
getTextTranslate(
) → Future< List< double?> ?> -
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. Default value:
0,0. -
getTextTranslateAnchor(
) → Future< TextTranslateAnchor?> -
Controls the frame of reference for
text-translate. Default value: "map". -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setIconAllowOverlap(
bool iconAllowOverlap) → Future< void> - If true, the icon will be visible even if it collides with other previously drawn symbols. Default value: false.
-
setIconAnchor(
IconAnchor iconAnchor) → Future< void> - Part of the icon placed closest to the anchor. Default value: "center".
-
setIconColor(
int iconColor) → Future< void> - The color of the icon. This can only be used with SDF icons. Default value: "#000000".
-
setIconColorSaturation(
double iconColorSaturation) → Future< void> -
Increase or reduce the saturation of the symbol icon. Default value: 0. Value range:
-1, 1 -
setIconEmissiveStrength(
double iconEmissiveStrength) → Future< void> - Controls the intensity of light emitted on the source features. Default value: 1. Minimum value: 0.
-
setIconHaloBlur(
double iconHaloBlur) → Future< void> - Fade out the halo towards the outside. Default value: 0. Minimum value: 0.
-
setIconHaloColor(
int iconHaloColor) → Future< void> - The color of the icon's halo. Icon halos can only be used with SDF icons. Default value: "rgba(0, 0, 0, 0)".
-
setIconHaloWidth(
double iconHaloWidth) → Future< void> - Distance of halo to the icon outline. Default value: 0. Minimum value: 0.
-
setIconIgnorePlacement(
bool iconIgnorePlacement) → Future< void> - If true, other symbols can be visible even if they collide with the icon. Default value: false.
-
setIconImage(
String iconImage) → Future< void> - Name of image in sprite to use for drawing an image background.
-
setIconImageCrossFade(
double iconImageCrossFade) → Future< void> -
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. Default value: 0. Value range:
0, 1 -
setIconKeepUpright(
bool iconKeepUpright) → Future< void> - If true, the icon may be flipped to prevent it from being rendered upside-down. Default value: false.
-
setIconOcclusionOpacity(
double iconOcclusionOpacity) → Future< void> -
The opacity at which the icon will be drawn in case of being depth occluded. Absent value means full occlusion against terrain only. Default value: 0. Value range:
0, 1 -
setIconOffset(
List< double?> iconOffset) → Future<void> -
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-sizeto obtain the final offset in pixels. When combined withicon-rotatethe offset will be as if the rotated direction was up. Default value:0,0. -
setIconOpacity(
double iconOpacity) → Future< void> -
The opacity at which the icon will be drawn. Default value: 1. Value range:
0, 1 -
setIconOptional(
bool iconOptional) → Future< void> - If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not. Default value: false.
-
setIconPadding(
double iconPadding) → Future< void> - Size of the additional area around the icon bounding box used for detecting symbol collisions. Default value: 2. Minimum value: 0.
-
setIconPitchAlignment(
IconPitchAlignment iconPitchAlignment) → Future< void> - Orientation of icon when map is pitched. Default value: "auto".
-
setIconRotate(
double iconRotate) → Future< void> - Rotates the icon clockwise. Default value: 0.
-
setIconRotationAlignment(
IconRotationAlignment iconRotationAlignment) → Future< void> -
In combination with
symbol-placement, determines the rotation behavior of icons. Default value: "auto". -
setIconSize(
double iconSize) → Future< void> -
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
icon-size. 1 is the original size; 3 triples the size of the image. Default value: 1. Minimum value: 0. -
setIconTextFit(
IconTextFit iconTextFit) → Future< void> - Scales the icon to fit around the associated text. Default value: "none".
-
setIconTextFitPadding(
List< double?> iconTextFitPadding) → Future<void> -
Size of the additional area added to dimensions determined by
icon-text-fit, in clockwise order: top, right, bottom, left. Default value:0,0,0,0. -
setIconTranslate(
List< double?> iconTranslate) → Future<void> -
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. Default value:
0,0. -
setIconTranslateAnchor(
IconTranslateAnchor iconTranslateAnchor) → Future< void> -
Controls the frame of reference for
icon-translate. Default value: "map". -
setSymbolAvoidEdges(
bool symbolAvoidEdges) → Future< void> - 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. Default value: false.
-
setSymbolElevationReference(
SymbolElevationReference symbolElevationReference) → Future< void> - Selects the base of symbol-elevation. Default value: "ground".
-
setSymbolPlacement(
SymbolPlacement symbolPlacement) → Future< void> - Label placement relative to its geometry. Default value: "point".
-
setSymbolSortKey(
double symbolSortKey) → Future< void> -
Sorts features in ascending order based on this value. Features with lower sort keys are drawn and placed first. When
icon-allow-overlaportext-allow-overlapisfalse, features with a lower sort key will have priority during placement. Whenicon-allow-overlaportext-allow-overlapis set totrue, features with a higher sort key will overlap over features with a lower sort key. -
setSymbolSpacing(
double symbolSpacing) → Future< void> - Distance between two symbol anchors. Default value: 250. Minimum value: 1.
-
setSymbolZElevate(
bool symbolZElevate) → Future< void> -
Position symbol on buildings (both fill extrusions and models) rooftops. In order to have minimal impact on performance, this is supported only when
fill-extrusion-heightis 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 whenviewport-ysorting orsymbol-sort-keyare applied. Default value: false. -
setSymbolZOffset(
double symbolZOffset) → Future< void> - Specifies an uniform elevation from the ground, in meters. Default value: 0. Minimum value: 0.
-
setSymbolZOrder(
SymbolZOrder symbolZOrder) → Future< void> -
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
symbol-sort-key. Default value: "auto". -
setTextAllowOverlap(
bool textAllowOverlap) → Future< void> - If true, the text will be visible even if it collides with other previously drawn symbols. Default value: false.
-
setTextAnchor(
TextAnchor textAnchor) → Future< void> - Part of the text placed closest to the anchor. Default value: "center".
-
setTextColor(
int textColor) → Future< void> - The color with which the text will be drawn. Default value: "#000000".
-
setTextEmissiveStrength(
double textEmissiveStrength) → Future< void> - Controls the intensity of light emitted on the source features. Default value: 1. Minimum value: 0.
-
setTextField(
String textField) → Future< void> -
Value to use for a text label. If a plain
stringis provided, it will be treated as aformattedwith default/inherited formatting options. SDF images are not supported in formatted text and will be ignored. Default value: "". -
setTextFont(
List< String?> textFont) → Future<void> - Font stack to use for displaying text.
-
setTextHaloBlur(
double textHaloBlur) → Future< void> - The halo's fadeout distance towards the outside. Default value: 0. Minimum value: 0.
-
setTextHaloColor(
int textHaloColor) → Future< void> - The color of the text's halo, which helps it stand out from backgrounds. Default value: "rgba(0, 0, 0, 0)".
-
setTextHaloWidth(
double textHaloWidth) → Future< void> - Distance of halo to the font outline. Max text halo width is 1/4 of the font-size. Default value: 0. Minimum value: 0.
-
setTextIgnorePlacement(
bool textIgnorePlacement) → Future< void> - If true, other symbols can be visible even if they collide with the text. Default value: false.
-
setTextJustify(
TextJustify textJustify) → Future< void> - Text justification options. Default value: "center".
-
setTextKeepUpright(
bool textKeepUpright) → Future< void> - If true, the text may be flipped vertically to prevent it from being rendered upside-down. Default value: true.
-
setTextLetterSpacing(
double textLetterSpacing) → Future< void> - Text tracking amount. Default value: 0.
-
setTextLineHeight(
double textLineHeight) → Future< void> - Text leading value for multi-line text. Default value: 1.2.
-
setTextMaxAngle(
double textMaxAngle) → Future< void> - Maximum angle change between adjacent characters. Default value: 45.
-
setTextMaxWidth(
double textMaxWidth) → Future< void> - The maximum line width for text wrapping. Default value: 10. Minimum value: 0.
-
setTextOcclusionOpacity(
double textOcclusionOpacity) → Future< void> -
The opacity at which the text will be drawn in case of being depth occluded. Absent value means full occlusion against terrain only. Default value: 0. Value range:
0, 1 -
setTextOffset(
List< double?> textOffset) → Future<void> -
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. -
setTextOpacity(
double textOpacity) → Future< void> -
The opacity at which the text will be drawn. Default value: 1. Value range:
0, 1 -
setTextOptional(
bool textOptional) → Future< void> - If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not. Default value: false.
-
setTextPadding(
double textPadding) → Future< void> - Size of the additional area around the text bounding box used for detecting symbol collisions. Default value: 2. Minimum value: 0.
-
setTextPitchAlignment(
TextPitchAlignment textPitchAlignment) → Future< void> - Orientation of text when map is pitched. Default value: "auto".
-
setTextRadialOffset(
double textRadialOffset) → Future< void> -
Radial offset of text, in the direction of the symbol's anchor. Useful in combination with
text-variable-anchor, which defaults to using the two-dimensionaltext-offsetif present. Default value: 0. -
setTextRotate(
double textRotate) → Future< void> - Rotates the text clockwise. Default value: 0.
-
setTextRotationAlignment(
TextRotationAlignment textRotationAlignment) → Future< void> -
In combination with
symbol-placement, determines the rotation behavior of the individual glyphs forming the text. Default value: "auto". -
setTextSize(
double textSize) → Future< void> - Font size. Default value: 16. Minimum value: 0.
-
setTextTransform(
TextTransform textTransform) → Future< void> -
Specifies how to capitalize text, similar to the CSS
text-transformproperty. Default value: "none". -
setTextTranslate(
List< double?> textTranslate) → Future<void> -
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. Default value:
0,0. -
setTextTranslateAnchor(
TextTranslateAnchor textTranslateAnchor) → Future< void> -
Controls the frame of reference for
text-translate. Default value: "map". -
toString(
) → String -
A string representation of this object.
inherited
-
update(
PointAnnotation annotation) → Future< void> - Update an added annotation with new properties.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited