Interface ResourceAdapter<M, L, O, F>

Optional id

Optional layer

Optional map

Optional name

options

Optional order

Optional selected

Optional source

Optional addData

• addData(geojson): void | Promise<void>

• Add GeoJson data to layer.

  Parameters

  • geojson: GeoJsonObject

    GeoJson object.

  Returns void | Promise<void>

addLayer

• addLayer(options): undefined | L | Promise<L>

• Parameters

  • options: O

  Returns undefined | L | Promise<L>

Optional beforeRemove

• beforeRemove(): void

• Returns void

Optional clearLayer

• clearLayer(cb?): void | Promise<void>

• Remove layer data.

  Parameters

  • Optional cb: ((feature) => boolean)

    Delete only those objects that match the filter.

    • • (feature): boolean

      • Parameters

        • feature: F

        Returns boolean

  Returns void | Promise<void>

Optional closePopup

• closePopup(findFeatureCb?): void

• Parameters

  • Optional findFeatureCb: DataLayerFilter<F, L>

  Returns void

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]])
  Copy

Optional getDependLayers

• getDependLayers(): L[]

• Returns L[]

Optional getFiltered

• getFiltered(): LayerDefinition<Feature<Geometry, GeoJsonProperties>, L>[]

• Get the filtered objects of the vector layer.

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

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>[]

Optional getLegend

• getLegend(options?): Promise<LayerLegend[]>

• Parameters

  • Optional options: GetLegendOptions

  Returns Promise<LayerLegend[]>

Optional getSelected

• getSelected(): LayerDefinition<Feature<Geometry, GeoJsonProperties>, L>[]

• Get the selected objects of the vector layer.

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

Optional hideLabel

• hideLabel(): void

• Returns void

Optional hideLayer

• hideLayer(layer?): void

• Parameters

  • Optional layer: L

  Returns void

Optional isLabelVisible

• isLabelVisible(): boolean

• Returns boolean

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>

Optional openPopup

• openPopup(findFeatureCb?, options?): void

• Parameters

  • Optional findFeatureCb: DataLayerFilter<F, L>

  • Optional options: PopupOptions<Feature<Geometry, GeoJsonProperties>, any>

  Returns void

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["properties"]
            : Record<string, string>) extends null
        ? Record<string, any>
        : F extends Feature<Geometry, GeoJsonProperties>
            ? F["properties"]
            : Record<string, string>>

    Filter, conforming to the PropertiesFilter expression specification's.

  • Optional options: FilterOptions<(F extends Feature<Geometry, GeoJsonProperties>
            ? F["properties"]
            : Record<string, string>) extends null
        ? Record<string, any>
        : F extends Feature<Geometry, GeoJsonProperties>
            ? 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]
  ]);
  Copy

Optional removeFilter

• removeFilter(): void

• Cancel the filter, return all objects to the map.

  Returns void

Optional removeLayer

• removeLayer(): void

• Returns void

Optional select

• select(findFeatureCb?): void

• Method for selecting objects on the map. The selectedPaint option will be applied to the selected objects.

  Parameters

  • Optional findFeatureCb: 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.

Optional setData

• setData(geojson): void | Promise<void>

• Update layer with new geojson.

  Parameters

  • geojson: GeoJsonObject

    GeoJson object.

  Returns void | Promise<void>

Optional setOpacity

• setOpacity(val): void

• Parameters

  • val: number

  Returns void

Optional setPaint

• setPaint(paint): void

• Parameters

  • paint: Paint

  Returns void

Optional setSelectedPaint

• setSelectedPaint(paint): void

• Parameters

  • paint: Paint

  Returns void

Optional showLabel

• showLabel(): void

• Returns void

Optional showLayer

• showLayer(layer?): void

• Parameters

  • Optional layer: L

  Returns void

Optional unselect

• unselect(findFeatureCb?): void

• Deselect all objects in the vector layer.

  Parameters

  • Optional findFeatureCb: 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.

Optional updateLayer

• updateLayer(): void

• Returns void

Optional updatePaint

• updatePaint(paint): void

• Parameters

  • paint: Partial<Paint>

  Returns void

Optional updateSelectedPaint

• updateSelectedPaint(paint): void

• Parameters

  • paint: Partial<Paint>

  Returns void

Optional updateTooltip

• updateTooltip(layerDef?): void

• Parameters

  • Optional layerDef: LayerDefinition<F, L>

  Returns void