Class GeoJSONSourceComponent

mgl-geojson-source - a geojson source component

See

Example

...
<mgl-map ...>
  <mgl-geojson-source id="symbols-source">
    <mgl-feature
      *ngFor="let geometry of geometries"
      [geometry]="geometry"
    ></mgl-feature>
  </mgl-geojson-source>
  ...
  <mgl-geojson-source
    id="earthquakes"
    [data]="earthquakes"
    [cluster]="true"
    [clusterMaxZoom]="14"
    [clusterRadius]="50"
  ></mgl-geojson-source>
</mgl-map>

Implements

OnChanges

Constructors

constructor

new GeoJSONSourceComponent(): GeoJSONSourceComponent
Returns GeoJSONSourceComponent
- Defined in projects/ngx-maplibre-gl/src/lib/source/geojson/geojson-source.component.ts:110

Properties

`Readonly`attribution

attribution: InputSignal<undefined | string> = ...

Dynamic input

`Readonly`buffer

buffer: InputSignal<undefined | number> = ...

Dynamic input

`Readonly`cluster

cluster: InputSignal<undefined | boolean> = ...

Dynamic input

`Readonly`clusterMaxZoom

clusterMaxZoom: InputSignal<undefined | number> = ...

Dynamic input

`Readonly`clusterMinPoints

clusterMinPoints: InputSignal<undefined | number> = ...

Dynamic input

`Readonly`clusterProperties

clusterProperties: InputSignal<unknown> = ...

Dynamic input

`Readonly`clusterRadius

clusterRadius: InputSignal<undefined | number> = ...

Dynamic input

`Readonly`data

data: InputSignal<string | GeoJSON<Geometry, GeoJsonProperties>> = ...

Dynamic input

`Readonly`filter

filter: InputSignal<unknown> = ...

Dynamic input

`Readonly`generateId

generateId: InputSignal<undefined | boolean> = ...

Dynamic input

`Readonly`lineMetrics

lineMetrics: InputSignal<undefined | boolean> = ...

Dynamic input

`Readonly`maxzoom

maxzoom: InputSignal<undefined | number> = ...

Dynamic input

`Readonly`promoteId

promoteId: InputSignal<undefined | PromoteIdSpecification> = ...

Dynamic input

`Readonly`tolerance

tolerance: InputSignal<undefined | number> = ...

Dynamic input

Methods

_addFeature

_addFeature(feature: Feature<Geometry>): void
Parameters
- feature: Feature<Geometry>
Returns void
- Defined in projects/ngx-maplibre-gl/src/lib/source/geojson/geojson-source.component.ts:188

_getNewFeatureId

_getNewFeatureId(): number
Returns number
- Defined in projects/ngx-maplibre-gl/src/lib/source/geojson/geojson-source.component.ts:211

_removeFeature

_removeFeature(feature: Feature<Geometry>): void
Parameters
- feature: Feature<Geometry>
Returns void
- Defined in projects/ngx-maplibre-gl/src/lib/source/geojson/geojson-source.component.ts:196

getClusterChildren

getClusterChildren(
clusterId: number,
): Promise<Feature<Geometry, GeoJsonProperties>[]>
For clustered sources, fetches the children of the given cluster on the next zoom level (as an array of GeoJSON features).
Parameters
- clusterId: number
  The value of the cluster's cluster_id property.
Returns Promise<Feature<Geometry, GeoJsonProperties>[]>
- Defined in projects/ngx-maplibre-gl/src/lib/source/geojson/geojson-source.component.ts:168

getClusterExpansionZoom

getClusterExpansionZoom(clusterId: number): Promise<number>
For clustered sources, fetches the zoom at which the given cluster expands.
Parameters
- clusterId: number
  The value of the cluster's cluster_id property.
Returns Promise<number>
- Defined in projects/ngx-maplibre-gl/src/lib/source/geojson/geojson-source.component.ts:157

getClusterLeaves

getClusterLeaves(
    clusterId: number,
    limit: number,
    offset: number,
): Promise<Feature<Geometry, GeoJsonProperties>[]>
For clustered sources, fetches the original points that belong to the cluster (as an array of GeoJSON features).
Parameters
- 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, GeoJsonProperties>[]>
- Defined in projects/ngx-maplibre-gl/src/lib/source/geojson/geojson-source.component.ts:181

ngOnChanges

ngOnChanges(changes: SimpleChanges): void
A callback method that is invoked immediately after the default change detector has checked data-bound properties if at least one has changed, and before the view and content children are checked.
Parameters
- changes: SimpleChanges
  The changed properties.
Returns void
Implementation of OnChanges.ngOnChanges
- Defined in projects/ngx-maplibre-gl/src/lib/source/geojson/geojson-source.component.ts:122

updateFeatureData

updateFeatureData(): void
Returns void
- Defined in projects/ngx-maplibre-gl/src/lib/source/geojson/geojson-source.component.ts:207

Class GeoJSONSourceComponent

See

Example

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns GeoJSONSourceComponent

Properties

Readonlyattribution

Readonlybuffer

Readonlycluster

ReadonlyclusterMaxZoom

ReadonlyclusterMinPoints

ReadonlyclusterProperties

ReadonlyclusterRadius

Readonlydata

Readonlyfilter

ReadonlygenerateId

ReadonlylineMetrics

Readonlymaxzoom

ReadonlypromoteId

Readonlytolerance

Methods

_addFeature

Parameters

Returns void

_getNewFeatureId

Returns number

_removeFeature

Parameters

Returns void

getClusterChildren

Parameters

Returns Promise<Feature<Geometry, GeoJsonProperties>[]>

getClusterExpansionZoom

Parameters

Returns Promise<number>

getClusterLeaves

Parameters

Returns Promise<Feature<Geometry, GeoJsonProperties>[]>

ngOnChanges

Parameters

Returns void

updateFeatureData

Returns void

Settings

On This Page

`Readonly`attribution

`Readonly`buffer

`Readonly`cluster

`Readonly`clusterMaxZoom

`Readonly`clusterMinPoints

`Readonly`clusterProperties

`Readonly`clusterRadius

`Readonly`data

`Readonly`filter

`Readonly`generateId

`Readonly`lineMetrics

`Readonly`maxzoom

`Readonly`promoteId

`Readonly`tolerance