Skip to main content

RasterArraySource

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

RasterArraySource

RasterArraySource is a map content source that supplies raster array image tiles to be shown on the map. This is typically used for particle animations like wind or precipitation patterns. 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.

@experimental This component requires Mapbox Maps SDK v11.4.0 or later

props​

id​

string

A string that uniquely identifies the source.

defaults to: Mapbox.StyleSource.DefaultSourceID

existing​

boolean

The id refers to an 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/raster-tiles/{z}/{x}/{y}.png

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.

tileSize​

number

Size of the map tiles. Defaults to 512.

@platform android Note: This property is not supported on iOS due to SDK limitations. On iOS, tileSize will be derived from the TileJSON when using url, or use the default value. If you need custom tile size on iOS, include it in your TileJSON response.

children​

React.ReactElement | React.ReactElement[]

FIX ME NO DESCRIPTION

sourceBounds​

Array

An array containing the longitude and latitude of the southwest and northeast corners of the source's bounding box in the following order: [sw.lng, sw.lat, ne.lng, ne.lat]. When this property is included in a source, no tiles outside of the given bounds are requested by Mapbox GL.

@platform android Note: This property is not supported on iOS due to SDK limitations. On iOS, bounds will be derived from the TileJSON when using url. If you need custom bounds on iOS, include them in your TileJSON response.