Interface DateRangeOptions

interface DateRangeOptions {
    dateFormat?: string;
    end: DateRangeInput;
    endInclusive?: boolean;
    start: DateRangeInput;
    state?: FacetValueState;
}

Properties

dateFormat? end endInclusive? start state?

Properties

OptionaldateFormat

dateFormat?: string

Allows specifying a custom string date format. See Day.js for possible parsing tokens. Assumes ISO 8601 format by default.

end

end: DateRangeInput

The ending value for the date range. A date range can be either absolute or relative.

OptionalendInclusive

endInclusive?: boolean

Whether to include the end value in the range.

Default Value

false

start

start: DateRangeInput

The starting value for the date range. A date range can be either absolute or relative.

Optionalstate

state?: FacetValueState

The current facet value state.

Default Value

idle

Settings

Member Visibility

On This Page

Properties