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

    Interface IAppState

    Represents the application-level Zustand store slice.

    Holds global settings such as display language, theme, date formatting, notification state, and various UI toggles.

    interface IAppState {
        actions: {
            setCircularProgress: (active: boolean) => void;
            setCrosshairActive: (active: boolean) => void;
            setDisplayDateMode: (displayDateMode: DisplayDateMode) => void;
            setDisplayDateTimezone: (displayDateTimezone: string) => void;
            setDisplayLanguage: (lang: TypeDisplayLanguage) => void;
            setDisplayTheme: (theme: TypeDisplayTheme) => void;
            setFullScreenActive: (active: boolean) => void;
            setGuide: (guide: TypeGuideObject) => void;
            setNotifications: (notifications: NotificationDetailsType[]) => void;
        };
        disabledLayerTypes: TypeInitialGeoviewLayerType[];
        displayDateMode: DisplayDateMode;
        displayDateTimezone: string;
        displayLanguage: TypeDisplayLanguage;
        displayTheme: TypeDisplayTheme;
        geolocatorServiceURL: string
        | undefined;
        geoviewAssetsURL: string;
        geoviewHTMLElement: HTMLElement;
        guide: TypeGuideObject | undefined;
        height: number;
        isCircularProgressActive: boolean;
        isCrosshairsActive: boolean;
        isFullscreenActive: boolean;
        metadataServiceURL: string | undefined;
        notifications: NotificationDetailsType[];
        setDefaultConfigValues: (geoviewConfig: TypeMapFeaturesConfig) => void;
        showLayerHighlightLayerBbox: boolean;
        showUnsymbolizedFeatures: boolean;
    }
    Index

    Properties

    actions disabledLayerTypes displayDateMode displayDateTimezone displayLanguage displayTheme geolocatorServiceURL geoviewAssetsURL geoviewHTMLElement guide height isCircularProgressActive isCrosshairsActive isFullscreenActive metadataServiceURL notifications setDefaultConfigValues showLayerHighlightLayerBbox showUnsymbolizedFeatures

    Properties

    actions: {
        setCircularProgress: (active: boolean) => void;
        setCrosshairActive: (active: boolean) => void;
        setDisplayDateMode: (displayDateMode: DisplayDateMode) => void;
        setDisplayDateTimezone: (displayDateTimezone: string) => void;
        setDisplayLanguage: (lang: TypeDisplayLanguage) => void;
        setDisplayTheme: (theme: TypeDisplayTheme) => void;
        setFullScreenActive: (active: boolean) => void;
        setGuide: (guide: TypeGuideObject) => void;
        setNotifications: (notifications: NotificationDetailsType[]) => void;
    }

    Store actions callable from adaptors.

    disabledLayerTypes: TypeInitialGeoviewLayerType[]

    Layer types that are disabled and cannot be added to the map.

    displayDateMode: DisplayDateMode

    The date display mode controlling how dates are formatted (e.g. 'iso', 'default').

    displayDateTimezone: string

    The IANA timezone used when displaying dates (e.g. 'local', 'America/Toronto').

    displayLanguage: TypeDisplayLanguage

    The current display language of the viewer (e.g. 'en' or 'fr').

    displayTheme: TypeDisplayTheme

    The current UI theme applied to the viewer.

    geolocatorServiceURL: string | undefined

    The URL of the geolocator service used for address/location searches.

    geoviewAssetsURL: string

    The base URL for GeoView static assets (scripts, images, etc.).

    geoviewHTMLElement: HTMLElement

    The root HTML element that hosts the GeoView map instance.

    guide: TypeGuideObject | undefined

    The guide content object rendered in the guide panel.

    height: number

    The current height (in pixels) of the map container.

    isCircularProgressActive: boolean

    Whether the circular progress indicator is currently displayed.

    isCrosshairsActive: boolean

    Whether the map crosshairs overlay is currently active.

    isFullscreenActive: boolean

    Whether the viewer is currently in fullscreen mode.

    metadataServiceURL: string | undefined

    The URL of the metadata service used for layer metadata lookups.

    notifications: NotificationDetailsType[]

    The list of active notification messages shown to the user.

    setDefaultConfigValues: (geoviewConfig: TypeMapFeaturesConfig) => void

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

    Type Declaration

    showLayerHighlightLayerBbox: boolean

    Whether to display highlight bounding boxes around layer features.

    showUnsymbolizedFeatures: boolean

    Whether to display features that have no associated symbology.

    Settings

    Member Visibility

    On This Page

    Properties