PointAnnotation class

Constructors

PointAnnotation({required String id, 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})

Properties

geometry ↔ Point
The geometry that determines the location/shape of this annotation
read / write
hashCode → int
The hash code for this object.
read-onlyinherited
iconAnchor ↔ IconAnchor?
Part of the icon placed closest to the anchor. Default value: "center".
read / write
iconColor ↔ int?
The color of the icon. This can only be used with SDF icons. Default value: "#000000".
read / write
iconEmissiveStrength ↔ double?
Controls the intensity of light emitted on the source features. Default value: 1. Minimum value: 0.
read / write
iconHaloBlur ↔ double?
Fade out the halo towards the outside. Default value: 0. Minimum value: 0.
read / write
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)".
read / write
iconHaloWidth ↔ double?
Distance of halo to the icon outline. Default value: 0. Minimum value: 0.
read / write
iconImage ↔ String?
Name of image in sprite to use for drawing an image background.
read / write
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. Default value: 0. Value range: 0, 1
read / write
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
read / write
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.
read / write
iconOpacity ↔ double?
The opacity at which the icon will be drawn. Default value: 1. Value range: 0, 1
read / write
iconRotate ↔ double?
Rotates the icon clockwise. Default value: 0.
read / write
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.
read / write
iconTextFit ↔ IconTextFit?
Scales the icon to fit around the associated text. Default value: "none".
read / write
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.
read / write
id ↔ String
The id for annotation
read / write
image ↔ Uint8List?
The bitmap image for this Annotation Will not take effect if iconImage has been set.
read / write
runtimeType → Type
A representation of the runtime type of the object.
read-onlyinherited
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.
read / write
symbolZOffset ↔ double?
Specifies an uniform elevation from the ground, in meters. Default value: 0. Minimum value: 0.
read / write
textAnchor ↔ TextAnchor?
Part of the text placed closest to the anchor. Default value: "center".
read / write
textColor ↔ int?
The color with which the text will be drawn. Default value: "#000000".
read / write
textEmissiveStrength ↔ double?
Controls the intensity of light emitted on the source features. Default value: 1. Minimum value: 0.
read / write
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: "".
read / write
textHaloBlur ↔ double?
The halo's fadeout distance towards the outside. Default value: 0. Minimum value: 0.
read / write
textHaloColor ↔ int?
The color of the text's halo, which helps it stand out from backgrounds. Default value: "rgba(0, 0, 0, 0)".
read / write
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.
read / write
textJustify ↔ TextJustify?
Text justification options. Default value: "center".
read / write
textLetterSpacing ↔ double?
Text tracking amount. Default value: 0.
read / write
textLineHeight ↔ double?
Text leading value for multi-line text. Default value: 1.2.
read / write
textMaxWidth ↔ double?
The maximum line width for text wrapping. Default value: 10. Minimum value: 0.
read / write
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
read / write
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.
read / write
textOpacity ↔ double?
The opacity at which the text will be drawn. Default value: 1. Value range: 0, 1
read / write
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.
read / write
textRotate ↔ double?
Rotates the text clockwise. Default value: 0.
read / write
textSize ↔ double?
Font size. Default value: 16. Minimum value: 0.
read / write
textTransform ↔ TextTransform?
Specifies how to capitalize text, similar to the CSS text-transform property. Default value: "none".
read / write

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.
inherited

Static Methods

decode(Object result) → PointAnnotation