Variable Baselayers`Const`

Baselayers: {
    init: (
        options?: BaselayersInitOptions,
    ) => { activeKey: string | null; layers: Record<string, unknown> };
    registerBaseLayer: (key: string, definition: BasemapDefinition) => void;
    registerBaseLayers: (
        definitions: Record<string, BasemapDefinition>,
    ) => void;
    setBaseLayer: (key: string, options?: SetBaseLayerOptions) => void;
    setActive: (key: string, options?: SetBaseLayerOptions) => void;
    refreshBasemap: () => void;
    getBaseLayers: () => { [key: string]: BaseLayerEntry };
    getActiveKey: () => string | null;
    getActiveId: () => string | null;
    getActiveLayer: () => BasemapDefinition | null;
    destroy: () => void;
} = ...

The GeoLeaf.Baselayers façade — registering, switching and rendering basemaps.

Two aliases exist for backward compatibility: setActive is setBaseLayer, and getActiveId is getActiveKey. destroy detaches the switcher listeners; it does not unregister the basemaps.

Type Declaration

init: (
options?: BaselayersInitOptions,
) => { activeKey: string | null; layers: Record<string, unknown> }
registerBaseLayer: (key: string, definition: BasemapDefinition) => void
registerBaseLayers: (definitions: Record<string, BasemapDefinition>) => void
setBaseLayer: (key: string, options?: SetBaseLayerOptions) => void
setActive: (key: string, options?: SetBaseLayerOptions) => void
refreshBasemap: () => void
getBaseLayers: () => { [key: string]: BaseLayerEntry }
getActiveKey: () => string | null
getActiveId: () => string | null
getActiveLayer: () => BasemapDefinition | null
destroy: () => void

Variable BaselayersConst

Type Declaration

init: ( options?: BaselayersInitOptions,) => { activeKey: string | null; layers: Record<string, unknown> }

registerBaseLayer: (key: string, definition: BasemapDefinition) => void

registerBaseLayers: (definitions: Record<string, BasemapDefinition>) => void

setBaseLayer: (key: string, options?: SetBaseLayerOptions) => void

setActive: (key: string, options?: SetBaseLayerOptions) => void

refreshBasemap: () => void

getBaseLayers: () => { [key: string]: BaseLayerEntry }

getActiveKey: () => string | null

getActiveId: () => string | null

getActiveLayer: () => BasemapDefinition | null

destroy: () => void

Settings

Variable Baselayers`Const`

init: (
options?: BaselayersInitOptions,
) => { activeKey: string | null; layers: Record<string, unknown> }