Skip to content

types.md

Latest commit

 

History

History
317 lines (188 loc) · 10.6 KB

types.md

File metadata and controls

317 lines (188 loc) · 10.6 KB

Types

The following types can be imported from react-map-gl/mapbox when using TypeScript.

Components

IControl

A custom control implementation.

CustomLayerInterface

A custom layer implementation.

MapRef

Instance ref of a Map component. See Map documentation for details.

Styling

StyleSpecification

An object conforming to the Mapbox Style Specification.

FogSpecification

An object conforming to the Fog Style Specification.

LightSpecification

An object conforming to the Light Style Specification.

TerrainSpecification

An object conforming to the Terrain Style Specification.

ProjectionSpecification

An object conforming to the Projection Style Specification.

BackgroundLayerSpecification

A JSON object that defines a background layer according to the Mapbox Style Specification.

CircleLayerSpecification

A JSON object that defines a circle layer according to the Mapbox Style Specification.

FillExtrusionLayerSpecification

A JSON object that defines a fill-extrusion layer according to the Mapbox Style Specification.

FillLayerSpecification

A JSON object that defines a fill layer according to the Mapbox Style Specification.

HeatmapLayerSpecification

A JSON object that defines a heatmap layer according to the Mapbox Style Specification.

HillshadeLayerSpecification

A JSON object that defines a hillshade layer according to the Mapbox Style Specification.

LineLayerSpecification

A JSON object that defines a line layer according to the Mapbox Style Specification.

RasterLayerSpecification

A JSON object that defines a raster layer according to the Mapbox Style Specification.

SymbolLayerSpecification

A JSON object that defines a symbol layer according to the Mapbox Style Specification.

SkyLayerSpecification

A JSON object that defines a sky layer according to the Mapbox Style Specification.

GeoJSONSourceSpecification

A JSON object that defines a geojson source according to the Mapbox Style Specification.

VideoSourceSpecification

A JSON object that defines a video source according to the Mapbox Style Specification.

ImageSourceSpecification

A JSON object that defines a image source according to the Mapbox Style Specification.

VectorSourceSpecification

A JSON object that defines a vector source according to the Mapbox Style Specification.

RasterSourceSpecification

A JSON object that defines a raster source according to the Mapbox Style Specification.

RasterDEMSourceSpecification

A JSON object that defines a raster-dem source according to the Mapbox Style Specification.

CanvasSourceSpecification

A JSON object that defines a canvas source type. See CanvasSourceOptions.

Configurations

ControlPosition

One of 'top-right', 'top-left', 'bottom-right' and 'bottom-left'.

PaddingOptions

An object with the following fields:

  • left: number - in pixels.
  • top: number - in pixels.
  • right: number - in pixels.
  • bottom: number - in pixels.

Data Types

LngLat

A Mapbox LngLat object.

LngLatLike

A Mapbox LngLatLike object.

LngLatBounds

A Mapbox LngLatBounds object.

LngLatBoundsLike

A Mapbox LngLatBoundsLike object.

Point

A Mapbox Point object.

PointLike

A Mapbox PointLike object.

MapGeoJSONFeature

A GeoJSON feature that also contains the following library-specific fields:

  • layer: Layer
  • source: string
  • sourceLayer: string
  • state: { [key: string]: any }

ViewState

An object with the following fields:

  • longitude: number - The longitude of the map center.
  • latitude: number - The latitude of the map center.
  • zoom: number - The zoom level.
  • pitch: number - The pitch (tilt) of the map, in degrees.
  • bearing: number - The bearing (rotation) of the map, in degrees.
  • elevation: number|undefined - The map center elevation from sea leavel on terrain surface, if any

Events

MapEvent

An object with the following fields:

  • type: string - Event type
  • target: Map
  • originalEvent?: Event

MapLayerMouseEvent

An object with the following fields:

MapWheelEvent

An object with the following fields:

  • type: string
  • target: Map
  • originalEvent?: WheelEvent
  • preventDefault: () => void
  • defaultPrevented: boolean

MapLayerTouchEvent

An object with the following fields:

ViewStateChangeEvent

An object with the following fields:

  • type: string - Event type
  • target: Map
  • viewState: ViewState - the next view state that the camera wants to change to based on user input or transition.

MapBoxZoomEvent

An object with the following fields:

MapStyleDataEvent

An object with the following fields:

  • type: string
  • target: Map
  • dataType: 'style'

MapSourceDataEvent

An object with the following fields:

  • type: string
  • target: Map
  • dataType: 'source'
  • isSourceLoaded: boolean
  • source: string
  • sourceId: string
  • sourceDataType: 'metadata' | 'content'
  • tile: any
  • coord: Coordinate

See MapDataEvent.

ErrorEvent

An object with the following fields:

  • type: 'error'
  • target: Map
  • error: Error

GeolocateEvent

An object with the following fields:

GeolocateResultEvent

An object with the following fields:

GeolocateErrorEvent

An object with the following fields:

  • type: string
  • target: GeolocateControl
  • code: PERMISSION_DENIED | POSITION_UNAVAILABLE | TIMEOUT - see GeolocationPositionError
  • message: string - the details of the error. Specifications note that this is primarily intended for debugging use and not to be shown directly in a user interface.

MarkerEvent

An object with the following fields:

MarkerDragEvent

An object with the following fields:

  • type: string
  • target: Marker
  • lngLat: LngLat - the new location of the marker

PopupEvent

An object with the following fields:

  • type: string
  • target: Popup