FingerprintCanvasProps

Defined in: packages/fingerprint/src/react/FingerprintCanvas.tsx:12

Props of FingerprintCanvas. useFingerprint’s canvasProps supplies most of them.

Properties

annotations?

optional annotations?: readonly FingerprintAnnotation[]

Defined in: packages/fingerprint/src/react/FingerprintCanvas.tsx:31

Notes pinned to the print, each with a leader to a mark of the categories it names.

---

callouts?

optional callouts?: FingerprintCallouts

Defined in: packages/fingerprint/src/react/FingerprintCanvas.tsx:33

Where the annotations go. See FingerprintCallouts.

---

className?

optional className?: string

Defined in: packages/fingerprint/src/react/FingerprintCanvas.tsx:39

Extra class on the canvas’s wrapper.

---

description

description: string

Defined in: packages/fingerprint/src/react/FingerprintCanvas.tsx:18

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

---

layout

layout: FingerprintLayout

Defined in: packages/fingerprint/src/react/FingerprintCanvas.tsx:14

What to draw: from useFingerprint (canvasProps) or layoutFingerprint.

---

motion?

optional motion?: Motion

Defined in: packages/fingerprint/src/react/FingerprintCanvas.tsx:37

How marks move when the view changes. See FingerprintMotion.

---

onSelect?

optional onSelect?: (selection) => void

Defined in: packages/fingerprint/src/react/FingerprintCanvas.tsx:29

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?: FingerprintRenderer

Defined in: packages/fingerprint/src/react/FingerprintCanvas.tsx:20

Draws each mark. Defaults to shapesRenderer.

---

ridges?

optional ridges?: RidgeStyle

Defined in: packages/fingerprint/src/react/FingerprintCanvas.tsx:22

How the ridges behind the marks are drawn. Defaults to { show: "auto" }.

---

selected?

optional selected?: Selection | null

Defined in: packages/fingerprint/src/react/FingerprintCanvas.tsx:24

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

---

title

title: string

Defined in: packages/fingerprint/src/react/FingerprintCanvas.tsx:16

The drawing’s accessible name.

---

unit?

optional unit?: string

Defined in: packages/fingerprint/src/react/FingerprintCanvas.tsx:35

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