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
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.
-
getIconIgnorePlacement(
) → Future< bool?> - If true, other symbols can be visible even if they collide with the icon.
-
getIconKeepUpright(
) → Future< bool?> - If true, the icon may be flipped to prevent it from being rendered upside-down.
-
getIconOptional(
) → Future< bool?> - If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not.
-
getIconPadding(
) → Future< double?> - Size of the additional area around the icon bounding box used for detecting symbol collisions.
-
getIconPitchAlignment(
) → Future< IconPitchAlignment?> - Orientation of icon when map is pitched.
-
getIconRotationAlignment(
) → Future< IconRotationAlignment?> -
In combination with
symbol-placement
, determines the rotation behavior of icons. -
getIconTextFit(
) → Future< IconTextFit?> - Scales the icon to fit around the associated text.
-
getIconTextFitPadding(
) → Future< List< double?> ?> -
Size of the additional area added to dimensions determined by
icon-text-fit
, in clockwise order: top, right, bottom, left. -
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.
-
getIconTranslateAnchor(
) → Future< IconTranslateAnchor?> -
Controls the frame of reference for
icon-translate
. -
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.
-
getSymbolPlacement(
) → Future< SymbolPlacement?> - Label placement relative to its geometry.
-
getSymbolSpacing(
) → Future< double?> - Distance between two symbol anchors.
-
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
. -
getTextAllowOverlap(
) → Future< bool?> - If true, the text will be visible even if it collides with other previously drawn symbols.
-
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.
-
getTextKeepUpright(
) → Future< bool?> - If true, the text may be flipped vertically to prevent it from being rendered upside-down.
-
getTextLineHeight(
) → Future< double?> - Text leading value for multi-line text.
-
getTextMaxAngle(
) → Future< double?> - Maximum angle change between adjacent characters.
-
getTextOptional(
) → Future< bool?> - If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not.
-
getTextPadding(
) → Future< double?> - Size of the additional area around the text bounding box used for detecting symbol collisions.
-
getTextPitchAlignment(
) → Future< TextPitchAlignment?> - Orientation of text when map is pitched.
-
getTextRotationAlignment(
) → Future< TextRotationAlignment?> -
In combination with
symbol-placement
, determines the rotation behavior of the individual glyphs forming the text. -
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.
-
getTextTranslateAnchor(
) → Future< TextTranslateAnchor?> -
Controls the frame of reference for
text-translate
. -
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.
-
setIconIgnorePlacement(
bool iconIgnorePlacement) → Future< void> - If true, other symbols can be visible even if they collide with the icon.
-
setIconKeepUpright(
bool iconKeepUpright) → Future< void> - If true, the icon may be flipped to prevent it from being rendered upside-down.
-
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.
-
setIconPadding(
double iconPadding) → Future< void> - Size of the additional area around the icon bounding box used for detecting symbol collisions.
-
setIconPitchAlignment(
IconPitchAlignment iconPitchAlignment) → Future< void> - Orientation of icon when map is pitched.
-
setIconRotationAlignment(
IconRotationAlignment iconRotationAlignment) → Future< void> -
In combination with
symbol-placement
, determines the rotation behavior of icons. -
setIconTextFit(
IconTextFit iconTextFit) → Future< void> - Scales the icon to fit around the associated text.
-
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. -
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.
-
setIconTranslateAnchor(
IconTranslateAnchor iconTranslateAnchor) → Future< void> -
Controls the frame of reference for
icon-translate
. -
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.
-
setSymbolPlacement(
SymbolPlacement symbolPlacement) → Future< void> - Label placement relative to its geometry.
-
setSymbolSpacing(
double symbolSpacing) → Future< void> - Distance between two symbol anchors.
-
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
. -
setTextAllowOverlap(
bool textAllowOverlap) → Future< void> - If true, the text will be visible even if it collides with other previously drawn symbols.
-
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.
-
setTextKeepUpright(
bool textKeepUpright) → Future< void> - If true, the text may be flipped vertically to prevent it from being rendered upside-down.
-
setTextLineHeight(
double textLineHeight) → Future< void> - Text leading value for multi-line text.
-
setTextMaxAngle(
double textMaxAngle) → Future< void> - Maximum angle change between adjacent characters.
-
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.
-
setTextPadding(
double textPadding) → Future< void> - Size of the additional area around the text bounding box used for detecting symbol collisions.
-
setTextPitchAlignment(
TextPitchAlignment textPitchAlignment) → Future< void> - Orientation of text when map is pitched.
-
setTextRotationAlignment(
TextRotationAlignment textRotationAlignment) → Future< void> -
In combination with
symbol-placement
, determines the rotation behavior of the individual glyphs forming the text. -
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.
-
setTextTranslateAnchor(
TextTranslateAnchor textTranslateAnchor) → Future< void> -
Controls the frame of reference for
text-translate
. -
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