PointAnnotationOptions class

Constructors

PointAnnotationOptions({required Point geometry, Uint8List? image, IconAnchor? iconAnchor, String? iconImage, List<double?>? iconOffset, double? iconRotate, double? iconSize, IconTextFit? iconTextFit, List<double?>? iconTextFitPadding, double? symbolSortKey, TextAnchor? textAnchor, String? textField, TextJustify? textJustify, double? textLetterSpacing, double? textLineHeight, double? textMaxWidth, List<double?>? textOffset, double? textRadialOffset, double? textRotate, double? textSize, TextTransform? textTransform, int? iconColor, double? iconEmissiveStrength, double? iconHaloBlur, int? iconHaloColor, double? iconHaloWidth, double? iconImageCrossFade, double? iconOcclusionOpacity, double? iconOpacity, double? symbolZOffset, int? textColor, double? textEmissiveStrength, double? textHaloBlur, int? textHaloColor, double? textHaloWidth, double? textOcclusionOpacity, double? textOpacity, bool? isDraggable, Map<String, Object>? customData})

Properties

customData ↔ Map<String, Object>?
JSON convertible properties associated with the annotation, used to enrich Feature GeoJSON properties["custom_data"] field.
getter/setter pair
geometry ↔ Point
The geometry that determines the location/shape of this annotation
getter/setter pair
hashCode → int
The hash code for this object.
no setteroverride
iconAnchor ↔ IconAnchor?
Part of the icon placed closest to the anchor. Default value: "center".
getter/setter pair
iconColor ↔ int?
The color of the icon. This can only be used with SDF icons. Default value: "#000000".
getter/setter pair
iconEmissiveStrength ↔ double?
Controls the intensity of light emitted on the source features. Default value: 1. Minimum value: 0. The unit of iconEmissiveStrength is in intensity.
getter/setter pair
iconHaloBlur ↔ double?
Fade out the halo towards the outside. Default value: 0. Minimum value: 0. The unit of iconHaloBlur is in pixels.
getter/setter pair
iconHaloColor ↔ int?
The color of the icon's halo. Icon halos can only be used with SDF icons. Default value: "rgba(0, 0, 0, 0)".
getter/setter pair
iconHaloWidth ↔ double?
Distance of halo to the icon outline. Default value: 0. Minimum value: 0. The unit of iconHaloWidth is in pixels.
getter/setter pair
iconImage ↔ String?
Name of image in sprite to use for drawing an image background.
getter/setter pair
iconImageCrossFade ↔ 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. . Both images should be the same size and have the same type (either raster or vector). Default value: 0. Value range: 0, 1 Deprecated: Use PointAnnotationManager.iconImageCrossFade instead.
getter/setter pair
iconOcclusionOpacity ↔ 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
getter/setter pair
iconOffset ↔ 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-size to obtain the final offset in pixels. When combined with icon-rotate the offset will be as if the rotated direction was up. Default value: 0,0.
getter/setter pair
iconOpacity ↔ double?
The opacity at which the icon will be drawn. Default value: 1. Value range: 0, 1
getter/setter pair
iconRotate ↔ double?
Rotates the icon clockwise. Default value: 0. The unit of iconRotate is in degrees.
getter/setter pair
iconSize ↔ 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. The unit of iconSize is in factor of the original icon size.
getter/setter pair
iconTextFit ↔ IconTextFit?
Scales the icon to fit around the associated text. Default value: "none".
getter/setter pair
iconTextFitPadding ↔ 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. The unit of iconTextFitPadding is in pixels.
getter/setter pair
image ↔ Uint8List?
The bitmap image for this Annotation Will not take effect if iconImage has been set.
getter/setter pair
isDraggable ↔ bool?
Property to determine whether annotation can be manually moved around map.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
symbolSortKey ↔ double?
Sorts features in ascending order based on this value. Features with lower sort keys are drawn and placed first. When icon-allow-overlap or text-allow-overlap is false, features with a lower sort key will have priority during placement. When icon-allow-overlap or text-allow-overlap is set to true, features with a higher sort key will overlap over features with a lower sort key.
getter/setter pair
symbolZOffset ↔ double?
Specifies an uniform elevation from the ground, in meters. Default value: 0. Minimum value: 0.
getter/setter pair
textAnchor ↔ TextAnchor?
Part of the text placed closest to the anchor. Default value: "center".
getter/setter pair
textColor ↔ int?
The color with which the text will be drawn. Default value: "#000000".
getter/setter pair
textEmissiveStrength ↔ double?
Controls the intensity of light emitted on the source features. Default value: 1. Minimum value: 0. The unit of textEmissiveStrength is in intensity.
getter/setter pair
textField ↔ String?
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. Default value: "".
getter/setter pair
textHaloBlur ↔ double?
The halo's fadeout distance towards the outside. Default value: 0. Minimum value: 0. The unit of textHaloBlur is in pixels.
getter/setter pair
textHaloColor ↔ int?
The color of the text's halo, which helps it stand out from backgrounds. Default value: "rgba(0, 0, 0, 0)".
getter/setter pair
textHaloWidth ↔ 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. The unit of textHaloWidth is in pixels.
getter/setter pair
textJustify ↔ TextJustify?
Text justification options. Default value: "center".
getter/setter pair
textLetterSpacing ↔ double?
Text tracking amount. Default value: 0. The unit of textLetterSpacing is in ems.
getter/setter pair
textLineHeight ↔ double?
Text leading value for multi-line text. Default value: 1.2. The unit of textLineHeight is in ems.
getter/setter pair
textMaxWidth ↔ double?
The maximum line width for text wrapping. Default value: 10. Minimum value: 0. The unit of textMaxWidth is in ems.
getter/setter pair
textOcclusionOpacity ↔ 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
getter/setter pair
textOffset ↔ 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. The unit of textOffset is in ems.
getter/setter pair
textOpacity ↔ double?
The opacity at which the text will be drawn. Default value: 1. Value range: 0, 1
getter/setter pair
textRadialOffset ↔ 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-dimensional text-offset if present. Default value: 0. The unit of textRadialOffset is in ems.
getter/setter pair
textRotate ↔ double?
Rotates the text clockwise. Default value: 0. The unit of textRotate is in degrees.
getter/setter pair
textSize ↔ double?
Font size. Default value: 16. Minimum value: 0. The unit of textSize is in pixels.
getter/setter pair
textTransform ↔ TextTransform?
Specifies how to capitalize text, similar to the CSS text-transform property. Default value: "none".
getter/setter pair

Methods

encode() → Object
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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

Static Methods

decode(Object result) → PointAnnotationOptions