Skip to main content

Interface: GeovisWorkspaceSidebarTimelineFilter

Defined in: context/GeovisWorkspaceContext.ts:188

A timeline filter: a numeric range (years, months, days, or any step) with an optional mini histogram and prev / play-pause / next controls.

When menuId is set, the current value is written to the shared selection (selection[menuId], as a string) so the app can react to it — this is how the time-lapse drives the map. Without it the value stays local to the preview (visual-only).

Properties​

closeOnPlay?​

optional closeOnPlay?: boolean

Defined in: context/GeovisWorkspaceContext.ts:217

Closes the left sidebar when playback starts, clearing it off the map that is about to animate. Defaults to false.

Only the transition into playback closes it — not pausing, not the prev/next steppers, and not each auto-advance tick. That is why this is a timeline field rather than one on GeovisWorkspaceLeftSidebarState: every control in the sidebar has a different terminal action (see GeovisWorkspaceSidebarVariationsBody.closeOnSelect).

defaultValue?​

optional defaultValue?: number

Defined in: context/GeovisWorkspaceContext.ts:202

Value selected on first render. Defaults to min.

histogram?​

optional histogram?: object[]

Defined in: context/GeovisWorkspaceContext.ts:204

Per-key counts for the mini histogram; omit to hide the bars.

count​

count: number

key​

key: number

kind​

kind: "timeline"

Defined in: context/GeovisWorkspaceContext.ts:189

max​

max: number

Defined in: context/GeovisWorkspaceContext.ts:198

Highest selectable value.

optional menuId?: string

Defined in: context/GeovisWorkspaceContext.ts:194

Keys the shared selection this timeline drives (selection[menuId], as a stringified number). Omit to keep the value local (visual-only).

min​

min: number

Defined in: context/GeovisWorkspaceContext.ts:196

Lowest selectable value.

step?​

optional step?: number

Defined in: context/GeovisWorkspaceContext.ts:200

Step between values. Defaults to 1.

unitLabel?​

optional unitLabel?: string

Defined in: context/GeovisWorkspaceContext.ts:206

Unit noun shown next to the value, e.g. "registros".