FingerprintState
Defined in: packages/fingerprint/src/react/useFingerprint.ts:57
What useFingerprint returns.
Properties
Section titled “Properties”canvasProps
Section titled “canvasProps”canvasProps:
FingerprintCanvasBinding
Defined in: packages/fingerprint/src/react/useFingerprint.ts:77
Spread onto FingerprintCanvas, with a title.
description
Section titled “description”description:
string
Defined in: packages/fingerprint/src/react/useFingerprint.ts:61
A plain-language summary of the layout, for the canvas’s description.
error:
DataError|null
Defined in: packages/fingerprint/src/react/useFingerprint.ts:63
Invalid data (duplicate ids, lightness on an unordered dimension, …), or null.
layout
Section titled “layout”layout:
FingerprintLayout
Defined in: packages/fingerprint/src/react/useFingerprint.ts:59
The current view’s layout; empty while error is set.
legendProps
Section titled “legendProps”legendProps: (
group) =>GroupBinding
Defined in: packages/fingerprint/src/react/useFingerprint.ts:79
Spread onto a FingerprintLegend for one group.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”listProps
Section titled “listProps”listProps: (
group) =>GroupBinding&object
Defined in: packages/fingerprint/src/react/useFingerprint.ts:81
Spread onto a FingerprintList 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/fingerprint/src/react/useFingerprint.ts:73
The selected category of a dimension, or null.
setSelected
Section titled “setSelected”setSelected: (
selection) =>void
Defined in: packages/fingerprint/src/react/useFingerprint.ts:75
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/fingerprint/src/react/useFingerprint.ts:71
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/fingerprint/src/react/useFingerprint.ts:67
The active view.
viewId
Section titled “viewId”viewId:
string
Defined in: packages/fingerprint/src/react/useFingerprint.ts:69
The active view’s id.
views: readonly
View[]
Defined in: packages/fingerprint/src/react/useFingerprint.ts:65
The views, as given or one per dimension.