mappls-map-react-native
Version:
A Mappls GL react native module for creating custom maps
35 lines (26 loc) • 2.79 kB
Markdown
<!-- This file was autogenerated from PointAnnotation.js do not modify -->
## <MapplsGL.PointAnnotation />
### PointAnnotation represents a one-dimensional shape located at a single geographical coordinate.<br/><br/>Consider using ShapeSource and SymbolLayer instead, if you have many points and you have static images,<br/>they'll offer much better performance<br/><br/>.<br/>If you need interctive views please use MarkerView,<br/>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 | `bool` | `none` | `false` | Manually selects/deselects annotation<br/> {[type]} |
| draggable | `bool` | `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.<br/>The anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0],<br/>where (0, 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner.<br/>Note this is only for custom annotations not the default pin view.<br/>Defaults to the center of the view. |
| x | `number` | `none` | `true` | See anchor |
| y | `number` | `none` | `true` | See anchor |
| onSelected | `func` | `none` | `false` | This callback is fired once this annotation is selected. Returns a Feature as the first param. |
| onDeselected | `func` | `none` | `false` | This callback is fired once this annotation is deselected. |
| onDragStart | `func` | `none` | `false` | This callback is fired once this annotation has started being dragged. |
| onDragEnd | `func` | `none` | `false` | This callback is fired once this annotation has stopped being dragged. |
| onDrag | `func` | `none` | `false` | This callback is fired while this annotation is being dragged. |
### methods
#### refresh()
On android point annotation is rendered offscreen with a canvas into an image.<br/>To rerender the image from the current state of the view call refresh.<br/>Call this for example from Image#onLoad.
##### arguments
| Name | Type | Required | Description |
| ---- | :--: | :------: | :----------: |