WaffleState
Defined in: packages/waffle/src/react/useWaffle.ts:45
What useWaffle returns: useViews’s state, with the layout for it.
Extends
Section titled “Extends”Properties
Section titled “Properties”canvasProps
Section titled “canvasProps”canvasProps:
WaffleCanvasBinding
Defined in: packages/waffle/src/react/useWaffle.ts:53
Spread onto WaffleCanvas, with a title.
description
Section titled “description”description:
string
Defined in: packages/waffle/src/react/useWaffle.ts:49
A plain-language summary of the layout, for the canvas’s description.
error:
DataError|null
Defined in: packages/waffle/src/react/useWaffle.ts:51
Invalid data (duplicate ids, lightness on an unordered dimension, …), or null.
layout
Section titled “layout”layout:
WaffleLayout
Defined in: packages/waffle/src/react/useWaffle.ts:47
The current view’s layout; empty while error is set.
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”Inherited from
Section titled “Inherited from”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
Inherited from
Section titled “Inherited from”selected
Section titled “selected”selected:
Selection|null
Defined in: packages/react/src/useViews.ts:41
The selected category of a dimension, or null.
Inherited from
Section titled “Inherited from”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
Inherited from
Section titled “Inherited from”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
Inherited from
Section titled “Inherited from”view:
View|undefined
Defined in: packages/react/src/useViews.ts:35
The active view.
Inherited from
Section titled “Inherited from”viewId
Section titled “viewId”viewId:
string
Defined in: packages/react/src/useViews.ts:37
The active view’s id.
Inherited from
Section titled “Inherited from”views: readonly
View[]
Defined in: packages/react/src/useViews.ts:33
The views, as given or one per dimension.