WaffleCanvasProps

Props of WaffleCanvas. useWaffle’s canvasProps supplies most of them.

Properties

optional className?: string

Extra class on the canvas’s wrapper, beside dp-canvas and dp-waffle.

description: string

What it shows, in words (core’s describeProfile writes one).

layout: WaffleLayout

What to draw: from useWaffle (canvasProps) or layoutWaffle.

optional motion?: Motion

How cells move when the view changes. See @data-profile/react’s Motion.

optional onSelect?: (selection) => void

Called when a cell is clicked, with its category in the arranging dimension, or null when that is already the selection.

void

optional renderer?: Renderer<WaffleCell>

Draws each cell’s mark. Defaults to @data-profile/react’s shapesRenderer.

optional selected?: Selection | null

Cells in this category of this dimension are highlighted, the rest dimmed.

title: string

The drawing’s accessible name.

optional unit?: string

Names what one item is, for the selection announcement. Defaults to “items”.