PointAnnotation.md

import { PointAnnotation } from '@rnmapbox/maps';

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 static images, they'll offer much better performance.

If you need interactive views please use MarkerView because PointAnnotation will render children onto a bitmap. Also disable any kind of animations like fadeDuration of Image. Otherwise, the bitmap might be rendered at an unknown state of the animation.

props

id

string

required A string that uniquely identifies the annotation

title

string

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

The string containing the annotation’s snippet(subtitle). Not displayed in the default callout.

selected

boolean

Manually selects/deselects annotation

draggable

boolean

Enable or disable dragging. Defaults to false.

defaults to: false

coordinate

Position

required The center point (specified as a map coordinate) of the annotation.

anchor

type Anchor = {
  x: number; /* See anchor */
  y: number; /* See anchor */
}

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.

defaults to: { x: 0.5, y: 0.5 }

onSelected

func

This callback is fired once this annotation is selected. Returns a Feature as the first param. signature:(payload:Feature) => void

onDeselected

func

This callback is fired once this annotation is deselected. signature:(payload:Feature) => void

onDragStart

func

This callback is fired once this annotation has started being dragged. signature:(payload:Feature) => void

onDragEnd

func

This callback is fired once this annotation has stopped being dragged. signature:(payload:Feature) => void

onDrag

func

This callback is fired while this annotation is being dragged. signature:(payload:Feature) => void

children

React.ReactElement | [React.ReactElement, React.ReactElement]

required Expects one child, and an optional callout can be added as well

style

ViewProps['style']

FIX ME NO DESCRIPTION

methods

refresh()

On v10 and pre v10 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.

arguments

Name	Type	Required	Description

Show Point Annotations