Skip to main content

<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

PropTypeDefaultRequiredDescription
idstringMLRNModule.StyleSource.DefaultSourceIDfalseA string that uniquely identifies the source.
urlstringnonefalseA URL to a TileJSON configuration file describing the source’s contents and other metadata.
tileUrlTemplatesArraynonefalseAn 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
minZoomLevelnumbernonefalseAn 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.
maxZoomLevelnumbernonefalseAn 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.
tmsbooleannonefalseInfluences the y direction of the tile coordinates. (tms inverts y axis)
attributionstringnonefalseAn 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.
onPressfuncnonefalseSource 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
signature:(event:OnPressEvent) => void
hitboxshapenonefalseOverrides the default touch hitbox(44x44 pixels) for the source layers
  widthnumbernonetruewidth of hitbox
  heightnumbernonetrueheight of hitbox
childrenReactNodenonefalseFIX ME NO DESCRIPTION

Methods

features([layerIDs], [filter])

Returns all features that match the query parameters regardless of whether or not the feature is
currently rendered on the map. The domain of the query includes all currently-loaded vector tiles
and GeoJSON source tiles. This function does not check tiles outside of the visible viewport.

Arguments

NameTypeRequiredDescription
layerIDsArrayNoA set of strings that correspond to the names of layers defined in the current style. Only the features contained in these layers are included in the returned array.
filterFilterExpressionNoan optional filter statement to filter the returned Features.
vectorSource.features(["id1", "id2"]);

onPress(event)

Arguments

NameTypeRequiredDescription
eventNativeSyntheticEventYesundefined