Class GeoJSONVT

Main class for creating and managing a vector tile index from GeoJSON data.

Index

Constructors

Accessors

stats tiles total

Methods

getClusterChildren getClusterExpansionZoom getClusterLeaves getData getTile updateClusterOptions updateData

Constructors

constructor

new GeoJSONVT(data: GeoJSON, options?: GeoJSONVTOptions): GeoJSONVT
Parameters
- data: GeoJSON
- Optionaloptions: GeoJSONVTOptions
Returns GeoJSONVT
- Defined in geojsonvt.ts:60

Accessors

stats

get stats(): any
Internal
This is for the tests

Returns any
- Defined in geojsonvt.ts:42

tiles

get tiles(): any
Internal
This is for the tests

Returns any
- Defined in geojsonvt.ts:34

total

get total(): any
Internal
This is for the tests

Returns any
- Defined in geojsonvt.ts:50

Methods

getClusterChildren

getClusterChildren(clusterId: number): ClusterOrPointFeature[]
Returns the immediate children (clusters or points) of a cluster as GeoJSON.
Parameters
- clusterId: number
  The target cluster id.
Returns ClusterOrPointFeature[]
the immediate children or null in case of non-clustered source
- Defined in geojsonvt.ts:195

getClusterExpansionZoom

getClusterExpansionZoom(clusterId: number): number
Returns the zoom level at which a cluster expands into multiple children.
Parameters
- clusterId: number
  The target cluster id.
Returns number
the expansion zoom or null in case of non-clustered source
- Defined in geojsonvt.ts:186

getClusterLeaves

getClusterLeaves(
    clusterId: number,
    limit: number,
    offset: number,
): Feature<Point, { [name: string]: any }>[]
Returns leaf point features under a cluster, paginated by limit and offset.
Parameters
- clusterId: number
  The target cluster id.
- limit: number
  Maximum number of points to return (defaults to 10).
- offset: number
  Number of points to skip before collecting results (defaults to 0).
Returns Feature<Point, { [name: string]: any }>[]
leaf point features under a cluster or null in case of non-clustered source
- Defined in geojsonvt.ts:206

getData

getData(): GeoJSON
Returns source data as GeoJSON - only available when updateable option is set to true.

Returns GeoJSON
- Defined in geojsonvt.ts:158

getTile

getTile(
    z: string | number,
    x: string | number,
    y: string | number,
): GeoJSONVTTile
Given z, x, and y tile coordinates, returns the corresponding tile with geometries in tile coordinates, much like MVT data is stored.
Parameters
- z: string | number
  tile zoom level
- x: string | number
  tile x coordinate
- y: string | number
  tile y coordinate
Returns GeoJSONVTTile
the transformed tile or null if not found
- Defined in geojsonvt.ts:103

updateClusterOptions

updateClusterOptions(
cluster: boolean,
clusterOptions: SuperclusterOptions,
): void
Update supercluster options and regenerate the index.
Parameters
- cluster: boolean
  whether to enable clustering
- clusterOptions: SuperclusterOptions
  SuperclusterOptions
Returns void
- Defined in geojsonvt.ts:168

updateData

updateData(
diff: GeoJSONVTSourceDiff,
filter?: (feature: Feature) => boolean,
): void
Updates the source data feature set using a GeoJSONVTSourceDiff
Parameters
- diff: GeoJSONVTSourceDiff
  the source diff object
- Optionalfilter: (feature: Feature) => boolean
Returns void
- Defined in geojsonvt.ts:117