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

    Interface IMapState

    Represents the Map Zustand store slice.

    Manages state for the map including center coordinates, zoom level, basemap options, feature highlights, and various map interactions.

    interface IMapState {
        actions: {
            setAttribution: (attribution: string[]) => void;
            setClickCoordinates: (clickCoordinates: TypeMapMouseInfo) => void;
            setClickMarker: (coord: number[] | undefined) => void;
            setCurrentBasemapOptions: (basemapOptions: TypeBasemapOptions) => void;
            setFixNorth: (ifFix: boolean) => void;
            setGeolocatorSearchArea: (
                area:
                    | { bbox?: Extent; coords: Coordinate; searchItem: string }
                    | undefined,
            ) => void;
            setHighlightedFeatures: (
                highlightedFeatures: TypeFeatureInfoEntry[],
            ) => void;
            setHomeView: (view: TypeMapViewSettings) => void;
            setHoverFeatureInfo: (hoverFeatureInfo: TypeHoverFeatureInfo) => void;
            setInitialView: (view: Extent | TypeZoomAndCenter) => void;
            setInteraction: (interaction: TypeInteraction) => void;
            setIsMouseInsideMap: (isMouseInsideMap: boolean) => void;
            setMapDisplayed: () => void;
            setMapLoaded: (mapLoaded: boolean) => void;
            setMapMoveEnd: (
                centerCoordinates: Coordinate,
                pointerPosition: TypeMapMouseInfo,
                degreeRotation: string,
                isNorthVisible: boolean,
                mapExtent: Extent,
                scale: TypeScaleInfo,
            ) => void;
            setMapScale: (scale: TypeScaleInfo) => void;
            setMapSize: (size: Size) => void;
            setPointerPosition: (pointerPosition: TypeMapMouseInfo) => void;
            setPointMarkers: (pointMarkers: Record<string, TypePointMarker[]>) => void;
            setProjection: (projectionCode: TypeValidMapProjectionCodes) => void;
            setRotation: (rotation: number) => void;
            setZoom: (zoom: number) => void;
        };
        attribution: string[];
        basemapOptions: TypeBasemapOptions;
        centerCoordinates: Coordinate;
        clickCoordinates?: TypeMapMouseInfo;
        clickMarker: TypeClickMarker
        | undefined;
        currentBasemapOptions: TypeBasemapOptions;
        currentProjection: TypeValidMapProjectionCodes;
        featureHighlightColor: TypeHighlightColors;
        fixNorth: boolean;
        geolocatorSearchArea:
            | { bbox?: Extent; coords: Coordinate; searchItem: string }
            | undefined;
        hasGeoviewBasemapLayer: boolean;
        highlightedFeatures: TypeFeatureInfoEntry[];
        homeView: TypeMapViewSettings | undefined;
        hoverFeatureInfo: TypeHoverFeatureInfo;
        initialView: TypeMapViewSettings;
        interaction: TypeInteraction;
        isMouseInsideMap: boolean;
        mapDisplayed: boolean;
        mapExtent: Extent | undefined;
        mapLoaded: boolean;
        northArrow: boolean;
        northArrowElement: TypeNorthArrow;
        overviewMap: boolean;
        overviewMapHideZoom: number;
        pointerPosition?: TypeMapMouseInfo;
        pointMarkers: Record<string, TypePointMarker[]>;
        rotation: number;
        scale: TypeScaleInfo;
        setDefaultConfigValues: (config: TypeMapFeaturesConfig) => void;
        size: Size;
        zoom: number;
    }
    Index

    Properties

    actions: {
        setAttribution: (attribution: string[]) => void;
        setClickCoordinates: (clickCoordinates: TypeMapMouseInfo) => void;
        setClickMarker: (coord: number[] | undefined) => void;
        setCurrentBasemapOptions: (basemapOptions: TypeBasemapOptions) => void;
        setFixNorth: (ifFix: boolean) => void;
        setGeolocatorSearchArea: (
            area:
                | { bbox?: Extent; coords: Coordinate; searchItem: string }
                | undefined,
        ) => void;
        setHighlightedFeatures: (
            highlightedFeatures: TypeFeatureInfoEntry[],
        ) => void;
        setHomeView: (view: TypeMapViewSettings) => void;
        setHoverFeatureInfo: (hoverFeatureInfo: TypeHoverFeatureInfo) => void;
        setInitialView: (view: Extent | TypeZoomAndCenter) => void;
        setInteraction: (interaction: TypeInteraction) => void;
        setIsMouseInsideMap: (isMouseInsideMap: boolean) => void;
        setMapDisplayed: () => void;
        setMapLoaded: (mapLoaded: boolean) => void;
        setMapMoveEnd: (
            centerCoordinates: Coordinate,
            pointerPosition: TypeMapMouseInfo,
            degreeRotation: string,
            isNorthVisible: boolean,
            mapExtent: Extent,
            scale: TypeScaleInfo,
        ) => void;
        setMapScale: (scale: TypeScaleInfo) => void;
        setMapSize: (size: Size) => void;
        setPointerPosition: (pointerPosition: TypeMapMouseInfo) => void;
        setPointMarkers: (pointMarkers: Record<string, TypePointMarker[]>) => void;
        setProjection: (projectionCode: TypeValidMapProjectionCodes) => void;
        setRotation: (rotation: number) => void;
        setZoom: (zoom: number) => void;
    }
    attribution: string[]
    basemapOptions: TypeBasemapOptions
    centerCoordinates: Coordinate
    clickCoordinates?: TypeMapMouseInfo
    clickMarker: TypeClickMarker | undefined
    currentBasemapOptions: TypeBasemapOptions
    currentProjection: TypeValidMapProjectionCodes
    featureHighlightColor: TypeHighlightColors
    fixNorth: boolean
    geolocatorSearchArea:
        | { bbox?: Extent; coords: Coordinate; searchItem: string }
        | undefined
    hasGeoviewBasemapLayer: boolean
    highlightedFeatures: TypeFeatureInfoEntry[]
    homeView: TypeMapViewSettings | undefined
    hoverFeatureInfo: TypeHoverFeatureInfo
    initialView: TypeMapViewSettings
    interaction: TypeInteraction
    isMouseInsideMap: boolean
    mapDisplayed: boolean
    mapExtent: Extent | undefined
    mapLoaded: boolean
    northArrow: boolean
    northArrowElement: TypeNorthArrow
    overviewMap: boolean
    overviewMapHideZoom: number
    pointerPosition?: TypeMapMouseInfo
    pointMarkers: Record<string, TypePointMarker[]>
    rotation: number
    setDefaultConfigValues: (config: TypeMapFeaturesConfig) => void
    size: Size
    zoom: number