CircleAnnotationManager class

The CircleAnnotationManager to add/update/delete CircleAnnotationAnnotations on the map.

Inheritance

Properties

hashCode → int
The hash code for this object.
no setterinherited
id → String
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addOnCircleAnnotationClickListener(OnCircleAnnotationClickListener listener) → void
Add a listener to receive the callback when an annotation is clicked.
create(CircleAnnotationOptions annotation) → Future<CircleAnnotation>
Create a new annotation with the option.
createMulti(List<CircleAnnotationOptions> annotations) → Future<List<CircleAnnotation?>>
Create multi annotations with the options.
delete(CircleAnnotation annotation) → Future<void>
Delete an added annotation.
deleteAll() → Future<void>
Delete all the annotation added by this manager.
deleteMulti(List<CircleAnnotation> annotations) → Future<void>
Delete multiple annotations added by this manager.
dragEvents({dynamic onBegin(CircleAnnotation)?, dynamic onChanged(CircleAnnotation)?, dynamic onEnd(CircleAnnotation)?}) → Cancelable
Registers drag event callbacks for the annotations managed by this manager.
getAnnotations() → Future<List<CircleAnnotation>>
Get all annotations of manager.
getCircleBlur() → Future<double?>
Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity. Setting a negative value renders the blur as an inner glow effect. Default value: 0.
getCircleColor() → Future<int?>
The fill color of the circle. Default value: "#000000".
getCircleElevationReference() → Future<CircleElevationReference?>
Selects the base of circle-elevation. Some modes might require precomputed elevation data in the tileset. Default value: "none".
getCircleEmissiveStrength() → Future<double?>
Controls the intensity of light emitted on the source features. Default value: 0. Minimum value: 0. The unit of circleEmissiveStrength is in intensity.
getCircleOpacity() → Future<double?>
The opacity at which the circle will be drawn. Default value: 1. Value range: 0, 1
getCirclePitchAlignment() → Future<CirclePitchAlignment?>
Orientation of circle when map is pitched. Default value: "viewport".
getCirclePitchScale() → Future<CirclePitchScale?>
Controls the scaling behavior of the circle when the map is pitched. Default value: "map".
getCircleRadius() → Future<double?>
Circle radius. Default value: 5. Minimum value: 0. The unit of circleRadius is in pixels.
getCircleSortKey() → Future<double?>
Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
getCircleStrokeColor() → Future<int?>
The stroke color of the circle. Default value: "#000000".
getCircleStrokeOpacity() → Future<double?>
The opacity of the circle's stroke. Default value: 1. Value range: 0, 1
getCircleStrokeWidth() → Future<double?>
The width of the circle's stroke. Strokes are placed outside of the circle-radius. Default value: 0. Minimum value: 0. The unit of circleStrokeWidth is in pixels.
getCircleTranslate() → Future<List<double?>?>
The geometry's offset. Values are x, y where negatives indicate left and up, respectively. Default value: 0,0. The unit of circleTranslate is in pixels.
getCircleTranslateAnchor() → Future<CircleTranslateAnchor?>
Controls the frame of reference for circle-translate. Default value: "map".
longPressEvents({required dynamic onLongPress(CircleAnnotation)}) → Cancelable
Registers long press event callbacks for the annotations managed by this manager.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setCircleBlur(double circleBlur) → Future<void>
Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity. Setting a negative value renders the blur as an inner glow effect. Default value: 0.
setCircleColor(int circleColor) → Future<void>
The fill color of the circle. Default value: "#000000".
setCircleElevationReference(CircleElevationReference circleElevationReference) → Future<void>
Selects the base of circle-elevation. Some modes might require precomputed elevation data in the tileset. Default value: "none".
setCircleEmissiveStrength(double circleEmissiveStrength) → Future<void>
Controls the intensity of light emitted on the source features. Default value: 0. Minimum value: 0. The unit of circleEmissiveStrength is in intensity.
setCircleOpacity(double circleOpacity) → Future<void>
The opacity at which the circle will be drawn. Default value: 1. Value range: 0, 1
setCirclePitchAlignment(CirclePitchAlignment circlePitchAlignment) → Future<void>
Orientation of circle when map is pitched. Default value: "viewport".
setCirclePitchScale(CirclePitchScale circlePitchScale) → Future<void>
Controls the scaling behavior of the circle when the map is pitched. Default value: "map".
setCircleRadius(double circleRadius) → Future<void>
Circle radius. Default value: 5. Minimum value: 0. The unit of circleRadius is in pixels.
setCircleSortKey(double circleSortKey) → Future<void>
Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.
setCircleStrokeColor(int circleStrokeColor) → Future<void>
The stroke color of the circle. Default value: "#000000".
setCircleStrokeOpacity(double circleStrokeOpacity) → Future<void>
The opacity of the circle's stroke. Default value: 1. Value range: 0, 1
setCircleStrokeWidth(double circleStrokeWidth) → Future<void>
The width of the circle's stroke. Strokes are placed outside of the circle-radius. Default value: 0. Minimum value: 0. The unit of circleStrokeWidth is in pixels.
setCircleTranslate(List<double?> circleTranslate) → Future<void>
The geometry's offset. Values are x, y where negatives indicate left and up, respectively. Default value: 0,0. The unit of circleTranslate is in pixels.
setCircleTranslateAnchor(CircleTranslateAnchor circleTranslateAnchor) → Future<void>
Controls the frame of reference for circle-translate. Default value: "map".
tapEvents({required dynamic onTap(CircleAnnotation)}) → Cancelable
Registers tap event callbacks for the annotations managed by this manager.
toString() → String
A string representation of this object.
inherited
update(CircleAnnotation annotation) → Future<void>
Update an added annotation with new properties.

Operators

operator ==(Object other) → bool
The equality operator.
inherited