PointAnnotation
  • id

    Identifier for this annotation

  • The geometry backing this annotation

  • The point backing this annotation

  • Properties associated with the annotation

  • Toggles the annotation’s selection state. If the annotation is deselected, it becomes selected. If the annotation is selected, it becomes deselected.

  • Property to determine whether annotation can be manually moved around map

  • Create a point annotation with a Point and an optional identifier.

  • Create a point annotation with a coordinate and an optional identifier

Style Properties

  • Part of the icon placed closest to the anchor.

  • Name of image in sprite to use for drawing an image background.

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

  • Rotates the icon clockwise.

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

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

  • Part of the text placed closest to the anchor.

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

  • Text justification options.

  • Text tracking amount.

  • Text leading value for multi-line text.

  • The maximum line width for text wrapping.

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

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

  • Rotates the text clockwise.

  • Font size.

  • Specifies how to capitalize text, similar to the CSS text-transform property.

  • The color of the icon. This can only be used with SDF icons.

  • Fade out the halo towards the outside.

  • The color of the icon’s halo. Icon halos can only be used with SDF icons.

  • Distance of halo to the icon outline.

  • The opacity at which the icon will be drawn.

  • The color with which the text will be drawn.

  • The halo’s fadeout distance towards the outside.

  • The color of the text’s halo, which helps it stand out from backgrounds.

  • Distance of halo to the font outline. Max text halo width is ¼ of the font-size.

  • The opacity at which the text will be drawn.

Image Convenience