Skip to main content

Interface: GeovisWorkspaceSidebarSettingsBlock

Defined in: context/GeovisWorkspaceContext.ts:840

A headed block wrapping one settings control.

Properties​

collapsible?​

optional collapsible?: boolean

Defined in: context/GeovisWorkspaceContext.ts:848

Turns the header into a toggle for the block's body. Defaults to false.


control​

control: GeovisWorkspaceSidebarSettingsControl

Defined in: context/GeovisWorkspaceContext.ts:864

The control rendered inside the block.


defaultOpen?​

optional defaultOpen?: boolean

Defined in: context/GeovisWorkspaceContext.ts:850

Whether the block starts expanded. Read only while collapsible.


hint?​

optional hint?: string

Defined in: context/GeovisWorkspaceContext.ts:852

Explanatory line under the header, above the control.


icon?​

optional icon?: string

Defined in: context/GeovisWorkspaceContext.ts:846

Iconify token rendered before the title.


id​

id: string

Defined in: context/GeovisWorkspaceContext.ts:842

Unique id of the block.


shownWhen?​

optional shownWhen?: GeovisWorkspaceSidebarEnabledWhen

Defined in: context/GeovisWorkspaceContext.ts:862

Renders the block only while another menu's value is one of the gate's values — e.g. the extrusion height, shown only while the view is 3d. Omit to always render it.

Hidden rather than disabled, unlike a section's enabledWhen: these are controls of another choice, and while it is off they have nothing to adjust. A hidden block keeps its value, so it returns as it was left.


subBlocks?​

optional subBlocks?: GeovisWorkspaceSidebarSettingsSubBlock[]

Defined in: context/GeovisWorkspaceContext.ts:866

Controls nested under the block's own, top to bottom.


title​

title: string

Defined in: context/GeovisWorkspaceContext.ts:844

Heading shown on the block's header.