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

    Type Alias TimeDimension

    Represents the normalized OGC time dimension metadata used by GeoView layers and time controls.

    type TimeDimension = {
        default: string[];
        displayDateFormat?: TypeDisplayDateFormat;
        displayDateFormatShort?: TypeDisplayDateFormat;
        displayDateTimezone?: TimeIANA;
        field: string;
        isGroupDimension?: boolean;
        isValid: boolean;
        nearestValues: "discrete" | "continuous";
        rangeItems: RangeItems;
        serviceDateTemporalMode?: TemporalMode;
        singleHandle: boolean;
        unitSymbol?: string;
    }
    Index
    default displayDateFormat? displayDateFormatShort? displayDateTimezone? field isGroupDimension? isValid nearestValues rangeItems serviceDateTemporalMode? singleHandle unitSymbol?
    default: string[]

    Default values selected by the service, normalized to an array of ISO strings.

    displayDateFormat?: TypeDisplayDateFormat

    Display format used when rendering dates in the current locale.

    displayDateFormatShort?: TypeDisplayDateFormat

    Short display format used when space is limited.

    displayDateTimezone?: TimeIANA

    Timezone used for display and interpretation of the time values.

    field: string

    Field name exposed by the service for the time dimension.

    isGroupDimension?: boolean

    Indicates if the time dimension is part of a group dimension. Notably useful for some QGIS-based services.

    isValid: boolean

    Whether the parsed time dimension is valid for use.

    nearestValues: "discrete" | "continuous"

    Whether the time values are treated as discrete or continuous.

    rangeItems: RangeItems

    Parsed range metadata for the normalized time values.

    serviceDateTemporalMode?: TemporalMode

    Temporal interpretation applied to the values when formatting them.

    singleHandle: boolean

    Whether the time control is configured for a single handle or a range selection.

    unitSymbol?: string

    Optional unit symbol associated with the time values, such as Y, M, or D.

    Settings
    Member Visibility

    On This Page
    Properties