GeoJSONSource

A source containing GeoJSON. (See the Style Specification for detailed documentation of options.)

Examples

map.addSource('some id', {
    type: 'geojson',
    data: 'https://d2ad6b4ur7yvpq.cloudfront.net/naturalearth-3.3.0/ne_10m_ports.geojson'
});

map.addSource('some id', {
   type: 'geojson',
   data: {
       "type": "FeatureCollection",
       "features": [{
           "type": "Feature",
           "properties": {},
           "geometry": {
               "type": "Point",
               "coordinates": [
                   -76.53063297271729,
                   39.18174077994108
               ]
           }
       }]
   }
});

map.getSource('some id').setData({
  "type": "FeatureCollection",
  "features": [{
      "type": "Feature",
      "properties": { "name": "Null Island" },
      "geometry": {
          "type": "Point",
          "coordinates": [ 0, 0 ]
      }
  }]
});

See

• Draw GeoJSON points
• Add a GeoJSON line
• Create a heatmap from points
• Create and style clusters

Extends

• Evented<SourceEventType>

Implements

• Source

Methods

_updateWorkerData()

_updateWorkerData(): Promise<void>

Responsible for invoking WorkerSource's geojson.loadData target, which handles loading the geojson data and preparing to serve it up as tiles, using geojson-vt or supercluster as appropriate.

Returns

Promise<void>

abortTile()

abortTile(tile: Tile): Promise<void>

Allows to abort a tile loading.

Parameters

Returns

Promise<void>

Implementation of

Source.abortTile

fire()

Call Signature

fire(event: ErrorEvent | MapSourceDataEvent): this

Calls every listener registered for the event's type.

Parameters

Returns

this

Implementation of

Source.fire

Inherited from

Evented.fire

Call Signature

fire(type: keyof SourceEventType, properties?: object): this

Compatibility with the (type: string, properties: Object) signature from previous versions. See https://github.com/mapbox/mapbox-gl-js/issues/6522, https://github.com/mapbox/mapbox-gl-draw/issues/766

Parameters

Returns

this

Implementation of

Source.fire

Inherited from

Evented.fire

getBounds()

getBounds(): Promise<LngLatBounds>

Allows getting the source's boundaries. If there's a problem with the source's data, it will return an empty LngLatBounds.

Returns

Promise<LngLatBounds>

a promise which resolves to the source's boundaries

getClusterChildren()

getClusterChildren(clusterId: number): Promise<Feature<Geometry, {[name: string]: any; }>[]>

For clustered sources, fetches the children of the given cluster on the next zoom level (as an array of GeoJSON features).

Parameters

Returns

Promise<Feature<Geometry, {[name: string]: any; }>[]>

a promise that is resolved when the features are retrieved

getClusterExpansionZoom()

getClusterExpansionZoom(clusterId: number): Promise<number>

For clustered sources, fetches the zoom at which the given cluster expands.

Parameters

Returns

Promise<number>

a promise that is resolved with the zoom number

getClusterLeaves()

getClusterLeaves(clusterId: number, limit: number, offset: number): Promise<Feature<Geometry, {[name: string]: any; }>[]>

For clustered sources, fetches the original points that belong to the cluster (as an array of GeoJSON features).

Parameters

Returns

Promise<Feature<Geometry, {[name: string]: any; }>[]>

a promise that is resolved when the features are retrieved

Example

Retrieve cluster leaves on click

map.on('click', 'clusters', (e) => {
  let features = map.queryRenderedFeatures(e.point, {
    layers: ['clusters']
  });

  let clusterId = features[0].properties.cluster_id;
  let pointCount = features[0].properties.point_count;
  let clusterSource = map.getSource('clusters');

  const features = await clusterSource.getClusterLeaves(clusterId, pointCount);
  // Print cluster leaves in the console
  console.log('Cluster leaves:', features);
});

getClusterOptions()

getClusterOptions(): GetClusterOptions

Gets the cluster options currently configured on the source. The returned values mirror the options accepted by setClusterOptions.

Returns

GetClusterOptions

the source's current cluster options

Example

const {cluster, clusterMaxZoom, clusterRadius} = map.getSource('some id').getClusterOptions();

getData()

getData(): Promise<GeoJSON<Geometry, {[name: string]: any; }>>

Allows to get the source's actual GeoJSON data.

Returns

Promise<GeoJSON<Geometry, {[name: string]: any; }>>

a promise which resolves to the source's actual GeoJSON data

hasTransition()

hasTransition(): boolean

True if the source has transition, false otherwise.

Returns

boolean

Implementation of

Source.hasTransition

listens()

listens(type: keyof SourceEventType): boolean

Returns a true if this instance of Evented or any forwardeed instances of Evented have a listener for the specified type.

Parameters

Returns

boolean

true if there is at least one registered listener for specified event type, false otherwise

Inherited from

Evented.listens

loaded()

loaded(): boolean

True if the source is loaded, false otherwise.

Returns

boolean

Implementation of

Source.loaded

loadTile()

loadTile(tile: Tile): Promise<void>

This method does the heavy lifting of loading a tile. In most cases it will defer the work to the relevant worker source.

Parameters

Returns

Promise<void>

Implementation of

Source.loadTile

off()

off<T extends keyof SourceEventType>(type: T, listener: (event: SourceEventType[T]) => void): this

Removes a previously registered event listener.

Type Parameters

Parameters

Returns

this

Inherited from

Evented.off

on()

on<T extends keyof SourceEventType>(type: T, listener: (event: SourceEventType[T]) => void): Subscription

Adds a listener to a specified event type.

Type Parameters

Parameters

Returns

Subscription

Inherited from

Evented.on

onAdd()

onAdd(map: Map): void

This method is called when the source is added to the map.

Parameters

Returns

void

Implementation of

Source.onAdd

once()

Call Signature

once<T extends keyof SourceEventType>(type: T): Promise<SourceEventType[T]>

Adds a listener that will be called only once to a specified event type.

The listener will be called first time the event fires after the listener is registered.

Type Parameters

Parameters

Returns

Promise<SourceEventType[T]>

a promise that resolves with the event

Inherited from

Evented.once

Call Signature

once<T extends keyof SourceEventType>(type: T, listener: (event: SourceEventType[T]) => void): this

Adds a listener that will be called only once to a specified event type.

The listener will be called first time the event fires after the listener is registered.

Type Parameters

Parameters

Returns

this

this when a listener is provided

Inherited from

Evented.once

onRemove()

onRemove(): void

This method is called when the source is removed from the map.

Returns

void

Implementation of

Source.onRemove

serialize()

serialize(): GeoJSONSourceSpecification

Returns

GeoJSONSourceSpecification

A plain (stringifiable) JS object representing the current state of the source. Creating a source using the returned object as the options should result in a Source that is equivalent to this one.

Implementation of

Source.serialize

setClusterOptions()

setClusterOptions(options: SetClusterOptions): Promise<void>

To disable/enable clustering on the source options

Parameters

Returns

Promise<void>

Example

map.getSource('some id').setClusterOptions({cluster: false});
map.getSource('some id').setClusterOptions({cluster: false, clusterRadius: 50, clusterMaxZoom: 14});

setData()

setData(data: string | GeoJSON<Geometry, {[name: string]: any; }>): Promise<void>

Sets the GeoJSON data and re-renders the map.

Parameters

Returns

Promise<void>

setEventedParent()

setEventedParent(parent?: Evented<EventTypeMap>, data?: EventedParentData | (() => EventedParentData)): this

Bubble all events fired by this instance of Evented to this parent instance of Evented.

Parameters

Returns

this

Inherited from

Evented.setEventedParent

unloadTile()

unloadTile(tile: Tile): Promise<void>

Allows to unload a tile.

Parameters

Returns

Promise<void>

Implementation of

Source.unloadTile

updateData()

updateData(diff: GeoJSONSourceDiff): Promise<void>

Updates the source's GeoJSON, and re-renders the map.

For sources with lots of features, this method can be used to make updates more quickly.

This approach requires unique IDs for every feature in the source. The IDs can either be specified on the feature, or by using the promoteId option to specify which property should be used as the ID.

It is an error to call updateData on a source that did not have unique IDs for each of its features already.

Updates are applied on a best-effort basis, updating an ID that does not exist will not result in an error.

Parameters

Returns

Promise<void>

Properties

attribution

attribution: string

The attribution for the source.

Implementation of

Source.attribution

id

id: string

The id for the source. Must not be used by any existing source.

Implementation of

Source.id

isTileClipped

isTileClipped: boolean

false if tiles can be drawn outside their boundaries, true if they cannot.

Implementation of

Source.isTileClipped

maxzoom

maxzoom: number

The maximum zoom level for the source.

Implementation of

Source.maxzoom

minzoom

minzoom: number

The minimum zoom level for the source.

Implementation of

Source.minzoom

reparseOverscaled

reparseOverscaled: boolean

true if tiles should be sent back to the worker for each overzoomed zoom level, false if not.

Implementation of

Source.reparseOverscaled

tileSize

tileSize: number

The tile size for the source.

Implementation of

Source.tileSize