geoview-core - v2.2.0
    Preparing search index...

    Interface ILayerState

    Represents the layer Zustand store slice.

    Manages state for the layer panel including legend layers, the selected and highlighted layer, the display state (view / add / reorder), and a loading indicator.

    interface ILayerState {
        actions: {
            setDisplayState: (newDisplayState: TypeLayersViewDisplayState) => void;
            setHighlightLayer: (layerPath: string) => void;
            setInitialFilters: (filters: Record<string, string>) => void;
            setLayerDeletionStartTime: (
                layerPath: string,
                startTime: number | undefined,
            ) => void;
            setLayersAreLoading: (areLoading: boolean) => void;
            setLegendLayers: (legendLayers: TypeLegendLayer[]) => void;
            setOrderedLayers: (newOrder: string[]) => void;
            setSelectedLayerPath: (layerPath: string | undefined) => void;
            updateLayerByPath: (
                layerPath: string,
                updater: (layer: TypeLegendLayer) => TypeLegendLayer,
            ) => void;
        };
        displayState: TypeLayersViewDisplayState;
        highlightedLayer: string;
        initialFilters: Record<string, string>;
        layersAreLoading: boolean;
        legendLayers: TypeLegendLayer[];
        orderedLayers: string[];
        selectedLayerPath?: string;
        setDefaultConfigValues: (geoviewConfig: TypeMapFeaturesConfig) => void;
    }
    Index

    Properties

    actions displayState highlightedLayer initialFilters layersAreLoading legendLayers orderedLayers selectedLayerPath? setDefaultConfigValues

    Properties

    actions: {
        setDisplayState: (newDisplayState: TypeLayersViewDisplayState) => void;
        setHighlightLayer: (layerPath: string) => void;
        setInitialFilters: (filters: Record<string, string>) => void;
        setLayerDeletionStartTime: (
            layerPath: string,
            startTime: number | undefined,
        ) => void;
        setLayersAreLoading: (areLoading: boolean) => void;
        setLegendLayers: (legendLayers: TypeLegendLayer[]) => void;
        setOrderedLayers: (newOrder: string[]) => void;
        setSelectedLayerPath: (layerPath: string | undefined) => void;
        updateLayerByPath: (
            layerPath: string,
            updater: (layer: TypeLegendLayer) => TypeLegendLayer,
        ) => void;
    }

    Store setter actions callable from adaptors.

    displayState: TypeLayersViewDisplayState

    The current layers panel display state (e.g. 'view', 'add', 'reorder').

    highlightedLayer: string

    The layer path of the currently highlighted layer.

    initialFilters: Record<string, string>

    The initial filter strings keyed by layer path.

    layersAreLoading: boolean

    Whether one or more layers are currently loading.

    legendLayers: TypeLegendLayer[]

    The array of legend layer objects representing the full layer tree.

    orderedLayers: string[]

    The ordered layer paths controlling display and Z-index order.

    selectedLayerPath?: string

    The layer path of the currently selected layer, or undefined if none is selected.

    setDefaultConfigValues: (geoviewConfig: TypeMapFeaturesConfig) => void

    Applies default configuration values from the map config to the layer store.

    Type Declaration

    Settings

    Member Visibility

    On This Page

    Properties