Skip to content

Latest commit

 

History

History
149 lines (86 loc) · 2.88 KB

VectorSource.md

File metadata and controls

149 lines (86 loc) · 2.88 KB
Raw
import { VectorSource } from '@rnmapbox/maps';

VectorSource

VectorSource is a map content source that supplies tiled vector data in Mapbox Vector Tile format to be shown on the map. The location of and metadata about the tiles are defined either by an option dictionary or by an external file that conforms to the TileJSON specification.

props

id

string

A string that uniquely identifies the source.

defaults to: MapboxGL.StyleSource.DefaultSourceID

existing

boolean

The id refers to en existing source in the style. Does not create a new source.

url

string

A URL to a TileJSON configuration file describing the source’s contents and other metadata.

tileUrlTemplates

Array

An array of tile URL templates. If multiple endpoints are specified, clients may use any combination of endpoints. Example: https://example.com/vector-tiles/{z}/{x}/{y}.pbf

Third Party Vector Source

minZoomLevel

number

An unsigned integer that specifies the minimum zoom level at which to display tiles from the source. The value should be between 0 and 22, inclusive, and less than maxZoomLevel, if specified. The default value for this option is 0.

maxZoomLevel

number

An unsigned integer that specifies the maximum zoom level at which to display tiles from the source. The value should be between 0 and 22, inclusive, and less than minZoomLevel, if specified. The default value for this option is 22.

tms

boolean

Influences the y direction of the tile coordinates. (tms inverts y axis)

attribution

string

An HTML or literal text string defining the buttons to be displayed in an action sheet when the source is part of a map view’s style and the map view’s attribution button is pressed.

onPress

func

Source press listener, gets called when a user presses one of the children layers only if that layer has a higher z-index than another source layers

  • event: Object
  • event.features: Object[] - the geojson features that have hit by the press (might be multiple)
  • event.coordinates: Object - the coordinates of the click
  • event.point: Object - the point of the click signature:(event:OnPressEvent) => void

hitbox

type Hitbox = {
  width: number; /* `width` of hitbox */
  height: number; /* `height` of hitbox */
}

Overrides the default touch hitbox(44x44 pixels) for the source layers

children

React.ReactElement | React.ReactElement[]

FIX ME NO DESCRIPTION

methods

onPress(event)

arguments

Name Type Required Description
event NativeSyntheticEvent Yes undefined