ViewsState
Defined in: packages/react/src/useViews.ts:31
What useViews returns.
Extended by
Section titled “Extended by”Properties
Section titled “Properties”legendProps
Section titled “legendProps”legendProps: (
group) =>GroupBinding
Defined in: packages/react/src/useViews.ts:45
Spread onto a Legend for one group.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”listProps
Section titled “listProps”listProps: (
group) =>GroupBinding&object
Defined in: packages/react/src/useViews.ts:47
Spread onto a CategoryList for one group, with unit included.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”GroupBinding & object
selected
Section titled “selected”selected:
Selection|null
Defined in: packages/react/src/useViews.ts:41
The selected category of a dimension, or null.
setSelected
Section titled “setSelected”setSelected: (
selection) =>void
Defined in: packages/react/src/useViews.ts:43
Selects a category of a dimension, or clears with null.
Parameters
Section titled “Parameters”selection
Section titled “selection”Selection | null
Returns
Section titled “Returns”void
setViewId
Section titled “setViewId”setViewId: (
viewId) =>void
Defined in: packages/react/src/useViews.ts:39
Switches view and clears the selection.
Parameters
Section titled “Parameters”viewId
Section titled “viewId”string
Returns
Section titled “Returns”void
view:
View|undefined
Defined in: packages/react/src/useViews.ts:35
The active view.
viewId
Section titled “viewId”viewId:
string
Defined in: packages/react/src/useViews.ts:37
The active view’s id.
views: readonly
View[]
Defined in: packages/react/src/useViews.ts:33
The views, as given or one per dimension.