PointAnnotationManager class

The PointAnnotationManager to add/update/delete PointAnnotationAnnotations on the map.

Inheritance

• Object
• BaseAnnotationManager
• PointAnnotationManager

Constructors

PointAnnotationManager({required String id, required BinaryMessenger messenger})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

id → String

final, inherited

messenger ↔ _PointAnnotationMessenger

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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.

getIconColorSaturation() → Future<double?>

Increase or reduce the saturation of the symbol icon. Default value: 0. Value range: -1, 1

getIconIgnorePlacement() → Future<bool?>

If true, other symbols can be visible even if they collide with the icon. Default value: false.

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. Not supported on globe zoom levels. 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".

getIconRotationAlignment() → Future<IconRotationAlignment?>

In combination with symbol-placement, determines the rotation behavior of icons. Default value: "auto".

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.

getSymbolPlacement() → Future<SymbolPlacement?>

Label placement relative to its geometry. Default value: "point".

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-height 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 symbol-sort-key are applied. Default value: false.

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.

getTextFont() → Future<List<String?>?>

Font stack to use for displaying text.

getTextIgnorePlacement() → Future<bool?>

If true, other symbols can be visible even if they collide with the text. Default value: false.

getTextKeepUpright() → Future<bool?>

If true, the text may be flipped vertically to prevent it from being rendered upside-down. Default value: true.

getTextMaxAngle() → Future<double?>

Maximum angle change between adjacent characters. Default value: 45.

getTextOcclusionOpacity() → Future<double?>

The opacity at which the text will be drawn in case of being depth occluded. Not supported on globe zoom levels. 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".

getTextRotationAlignment() → Future<TextRotationAlignment?>

In combination with symbol-placement, determines the rotation behavior of the individual glyphs forming the text. Default value: "auto".

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.

setIconColorSaturation(double iconColorSaturation) → Future<void>

Increase or reduce the saturation of the symbol icon. Default value: 0. Value range: -1, 1

setIconIgnorePlacement(bool iconIgnorePlacement) → Future<void>

If true, other symbols can be visible even if they collide with the icon. Default value: false.

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. Not supported on globe zoom levels. 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".

setIconRotationAlignment(IconRotationAlignment iconRotationAlignment) → Future<void>

In combination with symbol-placement, determines the rotation behavior of icons. Default value: "auto".

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.

setSymbolPlacement(SymbolPlacement symbolPlacement) → Future<void>

Label placement relative to its geometry. Default value: "point".

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-height 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 symbol-sort-key are applied. Default value: false.

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.

setTextFont(List<String?> textFont) → Future<void>

Font stack to use for displaying text.

setTextIgnorePlacement(bool textIgnorePlacement) → Future<void>

If true, other symbols can be visible even if they collide with the text. Default value: false.

setTextKeepUpright(bool textKeepUpright) → Future<void>

If true, the text may be flipped vertically to prevent it from being rendered upside-down. Default value: true.

setTextMaxAngle(double textMaxAngle) → Future<void>

Maximum angle change between adjacent characters. Default value: 45.

setTextOcclusionOpacity(double textOcclusionOpacity) → Future<void>

The opacity at which the text will be drawn in case of being depth occluded. Not supported on globe zoom levels. 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".

setTextRotationAlignment(TextRotationAlignment textRotationAlignment) → Future<void>

In combination with symbol-placement, determines the rotation behavior of the individual glyphs forming the text. Default value: "auto".

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