JavaScript Maps SDK

GeoJSONSource

Contents

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

Extends

Implements

Methods

_updateWorkerData()

_updateWorkerData(diff?: GeoJSONSourceDiff): 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.

Parameters

Parameter Type Description
diff? GeoJSONSourceDiff the diff object

Returns

Promise<void>

abortTile()

abortTile(tile: Tile): Promise<void>

Allows to abort a tile loading.

Parameters

Parameter Type Description
tile Tile The tile to abort

Returns

Promise<void>

Implementation of

Source.abortTile

getClusterChildren()

getClusterChildren(clusterId: number): Promise<Feature<Geometry, object>[]>

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

Parameters

Parameter Type Description
clusterId number The value of the cluster’s cluster_id property.

Returns

Promise<Feature<Geometry, object>[]>

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

Parameter Type Description
clusterId number The value of the cluster’s cluster_id property.

Returns

Promise<number>

a promise that is resolved with the zoom number

getClusterLeaves()

getClusterLeaves(clusterId: number, limit: number, offset: number): Promise<Feature<Geometry, object>[]>

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

Parameters

Parameter Type Description
clusterId number The value of the cluster’s cluster_id property.
limit number The maximum number of features to return.
offset number The number of features to skip (e.g. for pagination).

Returns

Promise<Feature<Geometry, object>[]>

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);
});

getData()

getData(): Promise<GeoJSON>

Allows to get the source’s actual GeoJSON data.

Returns

Promise<GeoJSON>

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: string): boolean

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

Parameters

Parameter Type Description
type string The event type

Returns

boolean

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

Inherited from

Evented.listens

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

Parameter Type Description
tile Tile The tile to load

Returns

Promise<void>

Implementation of

Source.loadTile

loaded()

loaded(): boolean

True if the source is loaded, false otherwise.

Returns

boolean

Implementation of

Source.loaded

off()

off(type: string, listener: Listener): GeoJSONSource

Removes a previously registered event listener.

Parameters

Parameter Type Description
type string The event type to remove listeners for.
listener Listener The listener function to remove.

Returns

GeoJSONSource

Inherited from

Evented.off

on()

on(type: string, listener: Listener): this

Adds a listener to a specified event type.

Parameters

Parameter Type Description
type string The event type to add a listen for.
listener Listener The function to be called when the event is fired. The listener function is called with the data object passed to fire, extended with target and type properties.

Returns

this

Inherited from

Evented.on

onAdd()

onAdd(map: Map): void

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

Parameters

Parameter Type Description
map Map The map instance

Returns

void

Implementation of

Source.onAdd

onRemove()

onRemove(): void

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

Returns

void

Implementation of

Source.onRemove

once()

once(type: string, listener?: Listener): Promise<any> | GeoJSONSource

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.

Parameters

Parameter Type Description
type string The event type to listen for.
listener? Listener The function to be called when the event is fired the first time.

Returns

Promise<any> | GeoJSONSource

this or a promise if a listener is not provided

Inherited from

Evented.once

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): this

To disable/enable clustering on the source options

Parameters

Parameter Type Description
options SetClusterOptions The options to set

Returns

this

Example 

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

setData()

setData(data: string | GeoJSON): this

Sets the GeoJSON data and re-renders the map.

Parameters

Parameter Type Description
data string | GeoJSON A GeoJSON data object or a URL to one. The latter is preferable in the case of large GeoJSON files.

Returns

this

setEventedParent()

setEventedParent(parent?: Evented, data?: any): GeoJSONSource

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

Parameters

Parameter Type
parent? Evented
data? any

Returns

GeoJSONSource

Inherited from

Evented.setEventedParent

unloadTile()

unloadTile(tile: Tile): Promise<void>

Allows to unload a tile.

Parameters

Parameter Type Description
tile Tile The tile to unload

Returns

Promise<void>

Implementation of

Source.unloadTile

updateData()

updateData(diff: GeoJSONSourceDiff): this

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

Parameter Type Description
diff GeoJSONSourceDiff The changes that need to be applied.

Returns

this

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

Last updated August 23, 2024.
Contents