Interface: GeovisWorkspaceContextValue
Defined in: context/GeovisWorkspaceContext.ts:775
Properties
config
config:
GeovisWorkspaceConfig
Defined in: context/GeovisWorkspaceContext.ts:777
The config that drives the sidebars.
dismissTimelineHud
dismissTimelineHud: () =>
void
Defined in: context/GeovisWorkspaceContext.ts:818
Hides the HUD until playback is started again.
Returns
void
hasResolvedOnce
hasResolvedOnce:
boolean
Defined in: context/GeovisWorkspaceContext.ts:834
Whether useGeoVis().result has ever been 'resolved' since this
workspace mounted. Shared through context (rather than each consumer
tracking it independently) so slots that mount only once there is
content — like the warnings panel — see the same history as slots
that are always mounted, such as map.
isLeftSidebarOpen
isLeftSidebarOpen:
boolean
Defined in: context/GeovisWorkspaceContext.ts:804
Whether the left sidebar is currently open.
isRightSidebarOpen
isRightSidebarOpen:
boolean
Defined in: context/GeovisWorkspaceContext.ts:808
Whether the right sidebar is currently open.
isTimelineHudVisible
isTimelineHudVisible:
boolean
Defined in: context/GeovisWorkspaceContext.ts:816
Whether the compact timeline HUD is showing. Decided by GeovisWorkspace,
not here: the same flag lifts the map's layer control clear of the bar, and
that offset is applied to the spec before it reaches GeoVisProvider.
notifyPlaybackStart
notifyPlaybackStart: () =>
void
Defined in: context/GeovisWorkspaceContext.ts:824
Reports that timeline playback has begun, which is what arms the HUD.
Called by useTimeline, whose own state cannot live high enough to feed
the control offset.
Returns
void
onRepair?
optionalonRepair?: (repair) =>void
Defined in: context/GeovisWorkspaceContext.ts:826
Called with the chosen RepairOption when a repair button is pressed.
Parameters
| Parameter | Type |
|---|---|
repair | RepairOption |
Returns
void
pendingSelection?
optionalpendingSelection?:GeovisWorkspacePendingSelection
Defined in: context/GeovisWorkspaceContext.ts:802
The variation change still in flight, if any. Menus render their rows inert while it is set — see GeovisWorkspacePendingSelection.
selection
selection:
GeovisWorkspaceSelection
Defined in: context/GeovisWorkspaceContext.ts:779
Active item value per menu group, keyed by menu id.
setLeftSidebarOpen
setLeftSidebarOpen: (
__namedParameters) =>void
Defined in: context/GeovisWorkspaceContext.ts:806
Opens or closes the left sidebar.
Parameters
| Parameter | Type |
|---|---|
__namedParameters | { open: boolean; } |
__namedParameters.open | boolean |
Returns
void
setRightSidebarOpen
setRightSidebarOpen: (
__namedParameters) =>void
Defined in: context/GeovisWorkspaceContext.ts:810
Opens or closes the right sidebar.
Parameters
| Parameter | Type |
|---|---|
__namedParameters | { open: boolean; } |
__namedParameters.open | boolean |
Returns
void
setSelection
setSelection: (
__namedParameters) =>void
Defined in: context/GeovisWorkspaceContext.ts:789
Sets the active item for a given menu group.
blocking marks the change as one the consumer may need time to serve: if
its selection handler returns a promise, that promise arms
pendingSelection until it settles. Menus pass it; the timeline and
the chips do not, since a timeline tick would otherwise freeze the sidebar
once per frame of playback.
Parameters
| Parameter | Type |
|---|---|
__namedParameters | { blocking?: boolean; menuId: string; value: string; } |
__namedParameters.blocking? | boolean |
__namedParameters.menuId | string |
__namedParameters.value | string |
Returns
void