Interface ResourceAdapter<M, L, O, F>

Adapter for vector data display control.

interface ResourceAdapter<M, L, O, F> {
    baselayer?: boolean;
    id?: string;
    item?: CompositeRead;
    layer?: L;
    map?: M;
    name?: string;
    options: O;
    order?: number;
    resourceId: number;
    selected?: boolean;
    source?: unknown;
    addData?(geojson: GeoJsonObject): void | Promise<void>;
    addLayer(options: O): undefined | L | Promise<L>;
    beforeRemove?(): void;
    clearLayer?(cb?: ((feature: F) => boolean)): void | Promise<void>;
    closePopup?(findFeatureCb?: DataLayerFilter<F, L>): void;
    filter?(cb: DataLayerFilter<F, L>): LayerDefinition<Feature<Geometry, GeoJsonProperties>, L>[];
    getBounds?(): undefined | LngLatBoundsArray | Promise<(LngLatBoundsArray | undefined)>;
    getDependLayers?(): L[];
    getExtent?(): undefined | LngLatBoundsArray | Promise<(LngLatBoundsArray | undefined)>;
    getFiltered?(): LayerDefinition<Feature<Geometry, GeoJsonProperties>, L>[];
    getIdentificationIds(): Promise<undefined | number[]>;
    getLayers?(): LayerDefinition<F, L>[];
    getLegend?(options?: GetLegendOptions): Promise<LayerLegend[]>;
    getSelected?(): LayerDefinition<Feature<Geometry, GeoJsonProperties>, L>[];
    hideLabel?(): void;
    hideLayer?(layer?: L): void;
    isLabelVisible?(): boolean;
    onLayerClick?(event: OnLayerMouseOptions<Feature<Geometry, GeoJsonProperties>, LayerAdapter<any, any, AdapterOptions<Record<string, any>, Record<string, any>>>>): Promise<any>;
    openPopup?(findFeatureCb?: DataLayerFilter<F, L>, options?: PopupOptions<Feature<Geometry, GeoJsonProperties>, any>): void;
    propertiesFilter?(filters: PropertiesFilter<(F extends Feature<Geometry, GeoJsonProperties>
            ? F<F>["properties"]
            : Record<string, string>) extends null
        ? Record<string, any>
        : F extends Feature<Geometry, GeoJsonProperties>
            ? F<F>["properties"]
            : Record<string, string>>, options?: FilterOptions<(F extends Feature<Geometry, GeoJsonProperties>
            ? F<F>["properties"]
            : Record<string, string>) extends null
        ? Record<string, any>
        : F extends Feature<Geometry, GeoJsonProperties>
            ? F<F>["properties"]
            : Record<string, string>>): Promise<void>;
    removeFilter?(): void;
    removeLayer?(): void;
    select?(findFeatureCb?: PropertiesFilter | DataLayerFilter<F, L>): void;
    setData?(geojson: GeoJsonObject): void | Promise<void>;
    setOpacity?(val: number): void;
    setPaint?(paint: Paint): void;
    setSelectedPaint?(paint: Paint): void;
    showLabel?(): void;
    showLayer?(layer?: L): void;
    unselect?(findFeatureCb?: PropertiesFilter | DataLayerFilter<F, L>): void;
    updateLayer?(options?: UpdateLayerAdapterOptions): void;
    updatePaint?(paint: Partial<Paint>): void;
    updateSelectedPaint?(paint: Partial<Paint>): void;
    updateTooltip?(layerDef?: LayerDefinition<F, L>): void;
}

Type Parameters

M = any
L = any
O extends GeoJsonAdapterOptions = GeoJsonAdapterOptions
F extends Feature = Feature

Hierarchy (view full)

VectorLayerAdapter<M, L, O, F>
- ResourceAdapter

Implemented by

NgwWebmapLayerAdapter

Properties

`Optional`baselayer

baselayer?: boolean

`Optional`id

id?: string

`Optional`item

item?: CompositeRead

`Optional`layer

layer?: L

`Optional`map

map?: M

`Optional`name

name?: string

options

options: O

`Optional`order

order?: number

resourceId

resourceId: number

`Optional`selected

selected?: boolean

True if there are selected features in the layer

`Optional`source

source?: unknown

Experimental option, only for MVT. Points to a data source instead of loading data into a layer.

Methods

`Optional`addData

addData(geojson): void | Promise<void>
Add GeoJson data to layer.
Parameters
- geojson: GeoJsonObject
  GeoJson object.
Returns void | Promise<void>
Inherited from VectorLayerAdapter.addData
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:680

addLayer

addLayer(options): undefined | L | Promise<L>
Parameters
- options: O
Returns undefined | L | Promise<L>
Inherited from VectorLayerAdapter.addLayer
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:549

`Optional`beforeRemove

beforeRemove(): void
Returns void
Inherited from VectorLayerAdapter.beforeRemove
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:552

`Optional`clearLayer

clearLayer(cb?): void | Promise<void>
Remove layer data.
Parameters
- Optionalcb: ((feature: F) => boolean)
  Delete only those objects that match the filter.
  - - (feature): boolean
    - Parameters
      feature: F
      Returns boolean
Returns void | Promise<void>
Inherited from VectorLayerAdapter.clearLayer
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:690

`Optional`closePopup

closePopup(findFeatureCb?): void
Parameters
- OptionalfindFeatureCb: DataLayerFilter<F, L>
Returns void
Inherited from VectorLayerAdapter.closePopup
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:702

`Optional`filter

filter(cb): LayerDefinition<Feature<Geometry, GeoJsonProperties>, L>[]
Ability to filter a layer with a callback function. It is necessary for the adapter to provide access to the layer objects before output to the map. It is not possible to apply such a filter to vector tiles and data on the remote server. So, where possible, use the VectorLayerAdapter.propertiesFilter.
Parameters
- cb: DataLayerFilter<F, L>
Returns LayerDefinition<Feature<Geometry, GeoJsonProperties>, L>[]
Example
```
layer.filter((e) => e.feature.properties.id === 2011);
// but in this case it’s better to do so:
layer.propertiesFilter([['id', 'eq', 2011]])
```
Inherited from VectorLayerAdapter.filter
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:650

`Optional`getBounds

getBounds(): undefined | LngLatBoundsArray | Promise<(LngLatBoundsArray | undefined)>
Returns undefined | LngLatBoundsArray | Promise<(LngLatBoundsArray | undefined)>
Overrides VectorLayerAdapter.getBounds
- Defined in packages/ngw-kit/src/interfaces.ts:210

`Optional`getDependLayers

getDependLayers(): L[]
Returns L[]
Inherited from VectorLayerAdapter.getDependLayers
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:567

`Optional`getExtent

getExtent(): undefined | LngLatBoundsArray | Promise<(LngLatBoundsArray | undefined)>
Returns undefined | LngLatBoundsArray | Promise<(LngLatBoundsArray | undefined)>
Deprecated
use ResourceAdapter.getBounds
Overrides VectorLayerAdapter.getExtent
- Defined in packages/ngw-kit/src/interfaces.ts:215

`Optional`getFiltered

getFiltered(): LayerDefinition<Feature<Geometry, GeoJsonProperties>, L>[]
Get the filtered objects of the vector layer.

Returns LayerDefinition<Feature<Geometry, GeoJsonProperties>, L>[]
Inherited from VectorLayerAdapter.getFiltered
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:637

getIdentificationIds

getIdentificationIds(): Promise<undefined | number[]>
Returns Promise<undefined | number[]>
- Defined in packages/ngw-kit/src/interfaces.ts:220

`Optional`getLayers

getLayers(): LayerDefinition<F, L>[]
Allows to get all vector objects of the layer. Does not work for vector tiles.

Returns LayerDefinition<F, L>[]
Inherited from VectorLayerAdapter.getLayers
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:614

`Optional`getLegend

getLegend(options?): Promise<LayerLegend[]>
Parameters
- Optionaloptions: GetLegendOptions
Returns Promise<LayerLegend[]>
Inherited from VectorLayerAdapter.getLegend
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:575

`Optional`getSelected

getSelected(): LayerDefinition<Feature<Geometry, GeoJsonProperties>, L>[]
Get the selected objects of the vector layer.

Returns LayerDefinition<Feature<Geometry, GeoJsonProperties>, L>[]
Inherited from VectorLayerAdapter.getSelected
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:633

`Optional`hideLabel

hideLabel(): void
Returns void
Inherited from VectorLayerAdapter.hideLabel
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:706

`Optional`hideLayer

hideLayer(layer?): void
Parameters
- Optionallayer: L
Returns void
Inherited from VectorLayerAdapter.hideLayer
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:555

`Optional`isLabelVisible

isLabelVisible(): boolean
Returns boolean
Inherited from VectorLayerAdapter.isLabelVisible
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:708

`Optional`onLayerClick

onLayerClick(event): Promise<any>
Callback function that will be called when clicking on a layer.
Parameters
- event: OnLayerMouseOptions<Feature<Geometry, GeoJsonProperties>, LayerAdapter<any, any, AdapterOptions<Record<string, any>, Record<string, any>>>>
  Data that is transmitted when you click on a layer.
Returns Promise<any>
Inherited from VectorLayerAdapter.onLayerClick
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:695

`Optional`openPopup

openPopup(findFeatureCb?, options?): void
Parameters
- OptionalfindFeatureCb: DataLayerFilter<F, L>
- Optionaloptions: PopupOptions<Feature<Geometry, GeoJsonProperties>, any>
Returns void
Inherited from VectorLayerAdapter.openPopup
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:697

`Optional`propertiesFilter

propertiesFilter(filters, options?): Promise<void>
The way to filter layer objects through serializable expressions. To clear the filter, pass null or undefined as the second parameter.
Parameters
- filters: PropertiesFilter<(F extends Feature<Geometry, GeoJsonProperties>
          ? F<F>["properties"]
          : Record<string, string>) extends null
      ? Record<string, any>
      : F extends Feature<Geometry, GeoJsonProperties>
          ? F<F>["properties"]
          : Record<string, string>>
  Filter, conforming to the PropertiesFilter expression specification's.
- Optionaloptions: FilterOptions<(F extends Feature<Geometry, GeoJsonProperties>
          ? F<F>["properties"]
          : Record<string, string>) extends null
      ? Record<string, any>
      : F extends Feature<Geometry, GeoJsonProperties>
          ? F<F>["properties"]
          : Record<string, string>>
  Options object.
Returns Promise<void>
Example
```
layer.propertiesFilter(['all', ['color', 'eq', 'green'], ['year', 'gt', 2011]]);
layer.propertiesFilter([[
  'any',
  ['color', 'eq', 'green'],
  ['color', 'eq', 'red']
],
  ['year', 'gt', 2011]
]);
```
Inherited from VectorLayerAdapter.propertiesFilter
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:668

`Optional`removeFilter

removeFilter(): void
Cancel the filter, return all objects to the map.

Returns void
Inherited from VectorLayerAdapter.removeFilter
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:675

`Optional`removeLayer

removeLayer(): void
Returns void
Inherited from VectorLayerAdapter.removeLayer
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:551

`Optional`select

select(findFeatureCb?): void
Method for selecting objects on the map. The selectedPaint option will be applied to the selected objects.
Parameters
- OptionalfindFeatureCb: PropertiesFilter | DataLayerFilter<F, L>
Returns void
Remarks
It is strongly recommended to use an PtropertiesFilter expression to set selected objects, since the selecting by the callback function is not supported by vector tiles and other asynchronous adapters.
Inherited from VectorLayerAdapter.select
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:621

`Optional`setData

setData(geojson): void | Promise<void>
Update layer with new geojson.
Parameters
- geojson: GeoJsonObject
  GeoJson object.
Returns void | Promise<void>
Inherited from VectorLayerAdapter.setData
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:685

`Optional`setOpacity

setOpacity(val): void
Parameters
- val: number
Returns void
Inherited from VectorLayerAdapter.setOpacity
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:573

`Optional`setPaint

setPaint(paint): void
Parameters
- paint: Paint
Returns void
Inherited from VectorLayerAdapter.setPaint
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:569

`Optional`setSelectedPaint

setSelectedPaint(paint): void
Parameters
- paint: Paint
Returns void
Inherited from VectorLayerAdapter.setSelectedPaint
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:571

`Optional`showLabel

showLabel(): void
Returns void
Inherited from VectorLayerAdapter.showLabel
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:707

`Optional`showLayer

showLayer(layer?): void
Parameters
- Optionallayer: L
Returns void
Inherited from VectorLayerAdapter.showLayer
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:554

`Optional`unselect

unselect(findFeatureCb?): void
Deselect all objects in the vector layer.
Parameters
- OptionalfindFeatureCb: PropertiesFilter | DataLayerFilter<F, L>
Returns void
Remarks
The parameter findFeatureCb is deprecated and will be deleted soon. Instead, it’s better to deselect all and select again.
Inherited from VectorLayerAdapter.unselect
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:629

`Optional`updateLayer

updateLayer(options?): void
Parameters
- Optionaloptions: UpdateLayerAdapterOptions
Returns void
Inherited from VectorLayerAdapter.updateLayer
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:550

`Optional`updatePaint

updatePaint(paint): void
Parameters
- paint: Partial<Paint>
Returns void
Inherited from VectorLayerAdapter.updatePaint
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:570

`Optional`updateSelectedPaint

updateSelectedPaint(paint): void
Parameters
- paint: Partial<Paint>
Returns void
Inherited from VectorLayerAdapter.updateSelectedPaint
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:572

`Optional`updateTooltip

updateTooltip(layerDef?): void
Parameters
- OptionallayerDef: LayerDefinition<F, L>
Returns void
Inherited from VectorLayerAdapter.updateTooltip
- Defined in packages/webmap/src/interfaces/LayerAdapter.ts:704

Interface ResourceAdapter<M, L, O, F>

Type Parameters

Hierarchy (view full)

Implemented by

Index

Properties

Methods

Properties

Optionalbaselayer

Optionalid

Optionalitem

Optionallayer

Optionalmap

Optionalname

options

Optionalorder

resourceId

Optionalselected

Optionalsource

Methods

OptionaladdData

Parameters

Returns void | Promise<void>

addLayer

Parameters

Returns undefined | L | Promise<L>

OptionalbeforeRemove

Returns void

OptionalclearLayer

Parameters

Parameters

Returns boolean

Returns void | Promise<void>

OptionalclosePopup

Parameters

Returns void

Optionalfilter

Parameters

Returns LayerDefinition<Feature<Geometry, GeoJsonProperties>, L>[]

Example

OptionalgetBounds

Returns undefined | LngLatBoundsArray | Promise<(LngLatBoundsArray | undefined)>

OptionalgetDependLayers

Returns L[]

OptionalgetExtent

Returns undefined | LngLatBoundsArray | Promise<(LngLatBoundsArray | undefined)>

Deprecated

OptionalgetFiltered

Returns LayerDefinition<Feature<Geometry, GeoJsonProperties>, L>[]

getIdentificationIds

Returns Promise<undefined | number[]>

OptionalgetLayers

Returns LayerDefinition<F, L>[]

OptionalgetLegend

Parameters

Returns Promise<LayerLegend[]>

OptionalgetSelected

Returns LayerDefinition<Feature<Geometry, GeoJsonProperties>, L>[]

OptionalhideLabel

Returns void

OptionalhideLayer

Parameters

Returns void

OptionalisLabelVisible

Returns boolean

OptionalonLayerClick

Parameters

Returns Promise<any>

OptionalopenPopup

Parameters

Returns void

OptionalpropertiesFilter

Parameters

Returns Promise<void>

Example

OptionalremoveFilter

Returns void

OptionalremoveLayer

Returns void

Optionalselect

`Optional`baselayer

`Optional`id

`Optional`item

`Optional`layer

`Optional`map

`Optional`name

`Optional`order

`Optional`selected

`Optional`source

`Optional`addData

`Optional`beforeRemove

`Optional`clearLayer

`Optional`closePopup

`Optional`filter

`Optional`getBounds

`Optional`getDependLayers

`Optional`getExtent

`Optional`getFiltered

`Optional`getLayers

`Optional`getLegend

`Optional`getSelected

`Optional`hideLabel

`Optional`hideLayer

`Optional`isLabelVisible

`Optional`onLayerClick

`Optional`openPopup

`Optional`propertiesFilter

`Optional`removeFilter

`Optional`removeLayer

`Optional`select

`Optional`setData

`Optional`setOpacity

`Optional`setPaint

`Optional`setSelectedPaint

`Optional`showLabel

`Optional`showLayer

`Optional`unselect

`Optional`updateLayer

`Optional`updatePaint

`Optional`updateSelectedPaint

`Optional`updateTooltip