Interface DataToMapLibreMapExperimental

Minimal injected MapLibre map surface. Source/layer mutation is required; event and feature-state methods are needed only when popup / hover options are requested, and fitBounds only when fitBounds is requested. A real maplibre-gl Map satisfies the whole interface.

interface DataToMapLibreMap {
    addLayer(layer: unknown, beforeId?: string): void;
    addSource(id: string, source: unknown): void;
    fitBounds?(bounds: [number, number, number, number], options?: Record<string, unknown>): void;
    getFeatureState?(target: {
        id: string | number;
        source: string;
        sourceLayer?: string;
    }): Record<string, unknown>;
    getLayer(id: string): unknown;
    getSource(id: string): unknown;
    off?(event: string, layerOrHandler: string | ((...args: unknown[]) => void), handler?: ((...args: unknown[]) => void)): void;
    on?(event: string, layerOrHandler: string | ((...args: unknown[]) => void), handler?: ((...args: unknown[]) => void)): void;
    removeFeatureState?(target: {
        id: string | number;
        source: string;
        sourceLayer?: string;
    }, key?: string): void;
    removeLayer(id: string): void;
    removeSource(id: string): void;
    setFeatureState?(target: {
        id: string | number;
        source: string;
        sourceLayer?: string;
    }, state: Record<string, unknown>): void;
    setFilter?(layerId: string, filter: unknown): void;
    setLayoutProperty?(layerId: string, name: string, value: unknown): void;
    setPaintProperty?(layerId: string, name: string, value: unknown): void;
}

Hierarchy (view full)

Methods

addLayer addSource fitBounds? getFeatureState? getLayer getSource off? on? removeFeatureState? removeLayer removeSource setFeatureState? setFilter? setLayoutProperty? setPaintProperty?

Methods

addLayer

addSource

OptionalfitBounds

OptionalgetFeatureState

  • getFeatureState(target): Record<string, unknown>
  • Experimental

    Parameters

    • target: {
          id: string | number;
          source: string;
          sourceLayer?: string;
      }
      • id: string | number
      • source: string
      • OptionalsourceLayer?: string

    Returns Record<string, unknown>

getLayer

getSource

Optionaloff

  • off(event, layerOrHandler, handler?): void
  • Experimental

    Parameters

    • event: string
    • layerOrHandler: string | ((...args: unknown[]) => void)
    • Optionalhandler: ((...args: unknown[]) => void)
        • (...args): void

        • Parameters

          • Rest...args: unknown[]

          Returns void

    Returns void

Optionalon

  • on(event, layerOrHandler, handler?): void
  • Experimental

    Parameters

    • event: string
    • layerOrHandler: string | ((...args: unknown[]) => void)
    • Optionalhandler: ((...args: unknown[]) => void)
        • (...args): void

        • Parameters

          • Rest...args: unknown[]

          Returns void

    Returns void

OptionalremoveFeatureState

  • removeFeatureState(target, key?): void
  • Experimental

    Parameters

    • target: {
          id: string | number;
          source: string;
          sourceLayer?: string;
      }
      • id: string | number
      • source: string
      • OptionalsourceLayer?: string
    • Optionalkey: string

    Returns void

removeLayer

removeSource

OptionalsetFeatureState

  • setFeatureState(target, state): void
  • Experimental

    Parameters

    • target: {
          id: string | number;
          source: string;
          sourceLayer?: string;
      }
      • id: string | number
      • source: string
      • OptionalsourceLayer?: string
    • state: Record<string, unknown>

    Returns void

OptionalsetFilter

OptionalsetLayoutProperty

OptionalsetPaintProperty

Settings

Member Visibility

On This Page

Methods