Skip to content

Latest commit

 

History

History
28 lines (21 loc) · 2.33 KB

PointAnnotation.md

File metadata and controls

28 lines (21 loc) · 2.33 KB

<MapLibreGL.PointAnnotation />

PointAnnotation represents a one-dimensional shape located at a single geographical coordinate.

Consider using ShapeSource and SymbolLayer instead, if you have many points and you have static images,
they'll offer much better performance

.
If you need interctive views please use MarkerView,
as with PointAnnotation on Android child views are rendered onto a bitmap for better performance.

Props

Prop Type Default Required Description
id string none true A string that uniquely identifies the annotation
title string none false The string containing the annotation’s title. Note this is required to be set if you want to see a callout appear on iOS.
snippet string none false The string containing the annotation’s snippet(subtitle). Not displayed in the default callout.
selected boolean none false Manually selects/deselects annotation
@type {[type]}
draggable boolean false false Enable or disable dragging. Defaults to false.
coordinate Array none true The center point (specified as a map coordinate) of the annotation.
anchor shape { x: 0.5, y: 0.5 } false Specifies the anchor being set on a particular point of the annotation.
The anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0],
where (0, 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner.
Note this is only for custom annotations not the default pin view.
Defaults to the center of the view.
  x number none true See anchor
  y number none true See anchor
children React.ReactElement | [React.ReactElement, React.ReactElement] none true Expects one child, and an optional callout can be added as well
style ViewProps["style"] none false FIX ME NO DESCRIPTION

Methods

refresh()

On android point annotation is rendered offscreen with a canvas into an image.
To rerender the image from the current state of the view call refresh.
Call this for example from Image#onLoad.