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

    Interface ITimeSliderState

    Represents the TimeSlider Zustand store slice.

    Manages state for the time slider including layer paths, selected layer, and filter expressions.

    interface ITimeSliderState {
        actions: {
            addTimeSliderLayer: (newLayer: TimeSliderLayerSet) => void;
            removeTimeSliderLayer: (layerPath: string) => void;
            setDelay: (layerPath: string, delay: number) => void;
            setDescription: (layerPath: string, description: string) => void;
            setDisplayDateFormat: (
                layerPath: string,
                displayDateFormat: TypeDisplayDateFormat,
            ) => void;
            setDisplayDateFormatShort: (
                layerPath: string,
                displayDateFormatShort: TypeDisplayDateFormat,
            ) => void;
            setDisplayDateTimezone: (
                layerPath: string,
                displayDateTimezone: string,
            ) => void;
            setFiltering: (layerPath: string, filter: boolean) => void;
            setLocked: (layerPath: string, locked: boolean) => void;
            setReversed: (layerPath: string, locked: boolean) => void;
            setSelectedLayerPath: (layerPath: string) => void;
            setSliderFilters: (newSliderFilters: Record<string, string>) => void;
            setStep: (layerPath: string, step: number) => void;
            setTitle: (layerPath: string, title: string) => void;
            setValues: (layerPath: string, values: number[]) => void;
        };
        selectedLayerPath: string;
        setDefaultConfigValues: (geoviewConfig: TypeMapFeaturesConfig) => void;
        sliderFilters: Record<string, string>;
        timeSliderLayers: TimeSliderLayerSet;
    }
    Index

    Properties

    actions selectedLayerPath setDefaultConfigValues sliderFilters timeSliderLayers

    Properties

    actions: {
        addTimeSliderLayer: (newLayer: TimeSliderLayerSet) => void;
        removeTimeSliderLayer: (layerPath: string) => void;
        setDelay: (layerPath: string, delay: number) => void;
        setDescription: (layerPath: string, description: string) => void;
        setDisplayDateFormat: (
            layerPath: string,
            displayDateFormat: TypeDisplayDateFormat,
        ) => void;
        setDisplayDateFormatShort: (
            layerPath: string,
            displayDateFormatShort: TypeDisplayDateFormat,
        ) => void;
        setDisplayDateTimezone: (
            layerPath: string,
            displayDateTimezone: string,
        ) => void;
        setFiltering: (layerPath: string, filter: boolean) => void;
        setLocked: (layerPath: string, locked: boolean) => void;
        setReversed: (layerPath: string, locked: boolean) => void;
        setSelectedLayerPath: (layerPath: string) => void;
        setSliderFilters: (newSliderFilters: Record<string, string>) => void;
        setStep: (layerPath: string, step: number) => void;
        setTitle: (layerPath: string, title: string) => void;
        setValues: (layerPath: string, values: number[]) => void;
    }

    Actions to mutate the TimeSlider state.

    Type Declaration

    • addTimeSliderLayer: (newLayer: TimeSliderLayerSet) => void

      Adds a new time-slider layer to the set.

    • removeTimeSliderLayer: (layerPath: string) => void

      Removes a time-slider layer by its path.

    • setDelay: (layerPath: string, delay: number) => void

      Sets the animation delay for a time-slider layer.

    • setDescription: (layerPath: string, description: string) => void

      Sets the description of a time-slider layer.

    • setDisplayDateFormat: (layerPath: string, displayDateFormat: TypeDisplayDateFormat) => void

      Sets the display date format for a time-slider layer.

    • setDisplayDateFormatShort: (layerPath: string, displayDateFormatShort: TypeDisplayDateFormat) => void

      Sets the short display date format for a time-slider layer.

    • setDisplayDateTimezone: (layerPath: string, displayDateTimezone: string) => void

      Sets the display date timezone for a time-slider layer.

    • setFiltering: (layerPath: string, filter: boolean) => void

      Sets the filtering flag for a time-slider layer.

    • setLocked: (layerPath: string, locked: boolean) => void

      Sets the locked flag for a time-slider layer.

    • setReversed: (layerPath: string, locked: boolean) => void

      Sets the reversed flag for a time-slider layer.

    • setSelectedLayerPath: (layerPath: string) => void

      Sets the currently selected layer path.

    • setSliderFilters: (newSliderFilters: Record<string, string>) => void

      Sets the full slider filters record.

    • setStep: (layerPath: string, step: number) => void

      Sets the step value for a time-slider layer.

    • setTitle: (layerPath: string, title: string) => void

      Sets the title of a time-slider layer.

    • setValues: (layerPath: string, values: number[]) => void

      Sets the current slider values (timestamps) for a time-slider layer.

    selectedLayerPath: string

    The currently selected layer path in the time slider.

    setDefaultConfigValues: (geoviewConfig: TypeMapFeaturesConfig) => void

    Sets default configuration values from the map features config.

    sliderFilters: Record<string, string>

    Filter expressions keyed by layer path applied by the slider.

    timeSliderLayers: TimeSliderLayerSet

    The set of time-slider layers keyed by layer path.

    Settings

    Member Visibility

    On This Page

    Properties