Skip to main content

Interface: GeovisWorkspaceProviderProps

Defined in: GeovisWorkspaceProvider.tsx:11

Properties​

children​

children: ReactNode

Defined in: GeovisWorkspaceProvider.tsx:13

Content to render inside the provider.

config​

config: GeovisWorkspaceConfig

Defined in: GeovisWorkspaceProvider.tsx:15

Config describing the sidebars.

hasResolvedOnce?​

optional hasResolvedOnce?: boolean

Defined in: GeovisWorkspaceProvider.tsx:48

Whether the GeoVis runtime has ever resolved successfully. Computed by GeovisWorkspace (which has runtime access) and forwarded here so it reaches context; defaults to false for standalone usage without a GeoVis runtime.

isLeftSidebarOpen?​

optional isLeftSidebarOpen?: boolean

Defined in: GeovisWorkspaceProvider.tsx:55

Whether the left sidebar is open. Provide it to control the open state from the parent (as GeovisWorkspace does, so it can shift the map's layer control clear of the open sidebar). Omit it to let the provider manage the state internally (seeded from config.leftSidebar.initialState).

isRightSidebarOpen?​

optional isRightSidebarOpen?: boolean

Defined in: GeovisWorkspaceProvider.tsx:67

Whether the right sidebar is open. Provide it to control the open state from the parent (as GeovisWorkspace does, so it can shift a right-anchored legend clear of the open sidebar). Omit it to let the provider manage the state internally (seeded from config.rightSidebar.initialState).

isTimelineHudVisible?​

optional isTimelineHudVisible?: boolean

Defined in: GeovisWorkspaceProvider.tsx:78

Whether the compact timeline HUD is showing. Decided by GeovisWorkspace, which needs the same flag to lift the map's layer control clear of the bar. Defaults to false, so the provider is usable standalone.

onLeftSidebarOpenChange?​

optional onLeftSidebarOpenChange?: (open) => void

Defined in: GeovisWorkspaceProvider.tsx:60

Called with the next open state whenever the left sidebar is opened or closed. Pair it with isLeftSidebarOpen to control the open state.

Parameters​

ParameterType
openboolean

Returns​

void

onPlaybackStart?​

optional onPlaybackStart?: () => void

Defined in: GeovisWorkspaceProvider.tsx:80

Called when timeline playback begins — what arms the HUD.

Returns​

void

onRepair?​

optional onRepair?: (repair) => void

Defined in: GeovisWorkspaceProvider.tsx:41

Called with the chosen RepairOption when a repair button is pressed in the warnings slot's default panel. Omit to render repair buttons disabled rather than absent.

Parameters​

ParameterType
repairRepairOption

Returns​

void

onRightSidebarOpenChange?​

optional onRightSidebarOpenChange?: (open) => void

Defined in: GeovisWorkspaceProvider.tsx:72

Called with the next open state whenever the right sidebar is opened or closed. Pair it with isRightSidebarOpen to control the open state.

Parameters​

ParameterType
openboolean

Returns​

void

onSelectionChange?​

optional onSelectionChange?: (selection) => void | Promise<unknown>

Defined in: GeovisWorkspaceProvider.tsx:33

Called with the full next selection whenever a variation is chosen (or the timeline advances). Use it to rebuild the visualizationSpec in the parent.

Return a promise when serving a variation costs a request, and the menus go inert until it settles — no second pick can race the first, and none is queued behind it. Nothing else has to be wired: the promise is the signal. A rejection re-enables them the same way a resolve does, since a failed request is a reason to let the user try again, not to strand the sidebar. Returns from a timeline tick are ignored (see setSelection).

Parameters​

ParameterType
selectionGeovisWorkspaceSelection

Returns​

void | Promise<unknown>

onTimelineHudDismiss?​

optional onTimelineHudDismiss?: () => void

Defined in: GeovisWorkspaceProvider.tsx:82

Called when the HUD's close button is pressed.

Returns​

void

selection?​

optional selection?: GeovisWorkspaceSelection

Defined in: GeovisWorkspaceProvider.tsx:21

Active item value per menu group, keyed by menu id. Provide it to control the selection from the parent. Omit it to let the provider manage the selection internally (seeded from each menu's defaultValue).