MarkCanvasProps

Defined in: packages/react/src/MarkCanvas.tsx:34

Props of MarkCanvas. A view’s canvas supplies marks, legends, arrange and viewBox.

Type Parameters

M

M extends PlacedMark = PlacedMark

Properties

arrange

arrange: string

Defined in: packages/react/src/MarkCanvas.tsx:40

The arranging dimension’s id: clicking a mark selects its category of this dimension.

---

background?

optional background?: ReactNode

Defined in: packages/react/src/MarkCanvas.tsx:65

Drawn inside the SVG, under the marks: a view’s guides.

---

children?

optional children?: ReactNode

Defined in: packages/react/src/MarkCanvas.tsx:69

Rendered after the SVG, inside the wrapper.

---

className?

optional className?: string

Defined in: packages/react/src/MarkCanvas.tsx:61

Extra class on the wrapper.

---

containerRef?

optional containerRef?: Ref<HTMLDivElement>

Defined in: packages/react/src/MarkCanvas.tsx:71

The wrapper element, for a view that measures it.

---

description

description: string

Defined in: packages/react/src/MarkCanvas.tsx:46

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

---

foreground?

optional foreground?: ReactNode

Defined in: packages/react/src/MarkCanvas.tsx:67

Drawn inside the SVG, over the marks: a view’s annotations.

---

legends

legends: readonly LegendGroup[]

Defined in: packages/react/src/MarkCanvas.tsx:38

The layout’s legends: which dimensions are encoded, and the selection’s counts.

---

markClassName?

optional markClassName?: string

Defined in: packages/react/src/MarkCanvas.tsx:63

Extra class on every mark’s group, beside dp-mark.

---

marks

marks: readonly M[]

Defined in: packages/react/src/MarkCanvas.tsx:36

The placed marks, from a view’s layout.

---

motion?

optional motion?: Motion

Defined in: packages/react/src/MarkCanvas.tsx:59

How marks move when the view changes. See Motion.

---

onSelect?

optional onSelect?: (selection) => void

Defined in: packages/react/src/MarkCanvas.tsx:55

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

Parameters

selection

Selection | null

Returns

void

---

renderer?

optional renderer?: Renderer<M>

Defined in: packages/react/src/MarkCanvas.tsx:48

Draws each mark. Defaults to shapesRenderer.

---

selected?

optional selected?: Selection | null

Defined in: packages/react/src/MarkCanvas.tsx:50

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

---

title

title: string

Defined in: packages/react/src/MarkCanvas.tsx:44

The drawing’s accessible name.

---

unit?

optional unit?: string

Defined in: packages/react/src/MarkCanvas.tsx:57

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

---

viewBox

viewBox: readonly [number, number, number, number]

Defined in: packages/react/src/MarkCanvas.tsx:42

[x, y, width, height] of the frame to show.