Interface VectorLayerAdapter<M, L, O, F, PROP, P>

Adapter for vector data display control.

interface VectorLayerAdapter<M, L, O, F, PROP, P> {
    id?: string;
    layer?: L;
    map?: M;
    name?: string;
    options: O;
    order?: 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>[];
    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<P>, options?: FilterOptions<P>): Promise<void>;
    removeFilter?(): void;
    removeLayer?(): void;
    select?(findFeatureCb?: DataLayerFilter<F, L> | PropertiesFilter): 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?: DataLayerFilter<F, L> | PropertiesFilter): 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 VectorAdapterOptions = VectorAdapterOptions
  • F extends Feature = Feature
  • PROP extends Record<string, any> | null = F extends Feature
        ? F["properties"]
        : Record<string, string>
  • P extends Record<string, any> = PROP extends null
        ? Record<string, any>
        : PROP

Hierarchy (view full)

Properties

id? layer? map? name? options order? selected? source?

Methods

addData? addLayer beforeRemove? clearLayer? closePopup? filter? getBounds? getDependLayers? getExtent? getFiltered? getLayers? getLegend? getSelected? hideLabel? hideLayer? isLabelVisible? onLayerClick? openPopup? propertiesFilter? removeFilter? removeLayer? select? setData? setOpacity? setPaint? setSelectedPaint? showLabel? showLayer? unselect? updateLayer? updatePaint? updateSelectedPaint? updateTooltip?

Properties

Optionalid

id?: string

Optionallayer

layer?: L

Optionalmap

map?: M

Optionalname

name?: string

options

options: O

Optionalorder

order?: number

Optionalselected

selected?: boolean

True if there are selected features in the layer

Optionalsource

source?: unknown

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

Methods

OptionaladdData

addLayer

OptionalbeforeRemove

OptionalclearLayer

  • 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>

OptionalclosePopup

Optionalfilter

  • 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

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

OptionalgetBounds

OptionalgetDependLayers

OptionalgetExtent

OptionalgetFiltered

OptionalgetLayers

OptionalgetLegend

OptionalgetSelected

OptionalhideLabel

OptionalhideLayer

OptionalisLabelVisible

OptionalonLayerClick

OptionalopenPopup

OptionalpropertiesFilter

  • 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

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

OptionalremoveFilter

OptionalremoveLayer

Optionalselect

  • select(findFeatureCb?): void

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

    Parameters

    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.

OptionalsetData

OptionalsetOpacity

OptionalsetPaint

OptionalsetSelectedPaint

OptionalshowLabel

OptionalshowLayer

Optionalunselect

OptionalupdateLayer

OptionalupdatePaint

OptionalupdateSelectedPaint

OptionalupdateTooltip

Settings

Member Visibility

On This Page

Properties
Methods