Function useGridStore

  • useGridStore(pinia?, hot?): Store<"grid", _UnwrapAll<Pick<{
        addGrid: ((value: GridConfig) => void);
        currentId: Ref<undefined | string, undefined | string>;
        getGridId: ((id: string) => undefined | string);
        grids: Ref<{
            [id: string]: GridConfig;
        }, {
            [id: string]: GridConfig;
        }>;
        panel: Ref<undefined | PanelConfig, undefined | PanelConfig>;
        removeGrid: ((id: string) => void);
        removeLayer: ((gridId: string, layerId: string) => void);
    }, "panel" | "grids" | "currentId">>, Pick<{
        addGrid: ((value: GridConfig) => void);
        currentId: Ref<undefined | string, undefined | string>;
        getGridId: ((id: string) => undefined | string);
        grids: Ref<{
            [id: string]: GridConfig;
        }, {
            [id: string]: GridConfig;
        }>;
        panel: Ref<undefined | PanelConfig, undefined | PanelConfig>;
        removeGrid: ((id: string) => void);
        removeLayer: ((gridId: string, layerId: string) => void);
    }, never>, Pick<{
        addGrid: ((value: GridConfig) => void);
        currentId: Ref<undefined | string, undefined | string>;
        getGridId: ((id: string) => undefined | string);
        grids: Ref<{
            [id: string]: GridConfig;
        }, {
            [id: string]: GridConfig;
        }>;
        panel: Ref<undefined | PanelConfig, undefined | PanelConfig>;
        removeGrid: ((id: string) => void);
        removeLayer: ((gridId: string, layerId: string) => void);
    },
        | "removeLayer"
        | "addGrid"
        | "removeGrid"
        | "getGridId">>

  • Returns a store, creates it if necessary.

    Parameters

    • Optionalpinia: null | Pinia

      Pinia instance to retrieve the store

    • Optionalhot: StoreGeneric

      dev only hot module replacement

    Returns Store<"grid", _UnwrapAll<Pick<{
        addGrid: ((value: GridConfig) => void);
        currentId: Ref<undefined | string, undefined | string>;
        getGridId: ((id: string) => undefined | string);
        grids: Ref<{
            [id: string]: GridConfig;
        }, {
            [id: string]: GridConfig;
        }>;
        panel: Ref<undefined | PanelConfig, undefined | PanelConfig>;
        removeGrid: ((id: string) => void);
        removeLayer: ((gridId: string, layerId: string) => void);
    }, "panel" | "grids" | "currentId">>, Pick<{
        addGrid: ((value: GridConfig) => void);
        currentId: Ref<undefined | string, undefined | string>;
        getGridId: ((id: string) => undefined | string);
        grids: Ref<{
            [id: string]: GridConfig;
        }, {
            [id: string]: GridConfig;
        }>;
        panel: Ref<undefined | PanelConfig, undefined | PanelConfig>;
        removeGrid: ((id: string) => void);
        removeLayer: ((gridId: string, layerId: string) => void);
    }, never>, Pick<{
        addGrid: ((value: GridConfig) => void);
        currentId: Ref<undefined | string, undefined | string>;
        getGridId: ((id: string) => undefined | string);
        grids: Ref<{
            [id: string]: GridConfig;
        }, {
            [id: string]: GridConfig;
        }>;
        panel: Ref<undefined | PanelConfig, undefined | PanelConfig>;
        removeGrid: ((id: string) => void);
        removeLayer: ((gridId: string, layerId: string) => void);
    },
        | "removeLayer"
        | "addGrid"
        | "removeGrid"
        | "getGridId">>

Properties

$id

Properties

$id

$id: "grid"

Id of the store. Used by map helpers.

Settings

Member Visibility

On This Page

Properties