FingerprintLayout
Defined in: packages/fingerprint/src/types.ts:113
What layoutFingerprint returns: everything a renderer needs, in a fixed frame. Core’s Profile
with its marks placed as nodes, and the ridges they sit on.
Extends
Section titled “Extends”Omit<Profile,"marks">
Properties
Section titled “Properties”encoding
Section titled “encoding”encoding:
Required<Encoding>
Defined in: packages/core/src/types.ts:152
Every property resolved to a dimension id, or null when off.
Inherited from
Section titled “Inherited from”form:
FingerprintForm
Defined in: packages/fingerprint/src/types.ts:123
The form actually drawn, every field resolved.
height
Section titled “height”height:
number
Defined in: packages/fingerprint/src/types.ts:117
The fixed coordinate frame’s height.
itemCount
Section titled “itemCount”itemCount:
number
Defined in: packages/core/src/types.ts:162
All the items, whatever itemsPerMark.
Inherited from
Section titled “Inherited from”itemsPerMark
Section titled “itemsPerMark”itemsPerMark:
number
Defined in: packages/core/src/types.ts:160
1 unless the item count exceeded maxMarks. Say so on screen when it is not 1.
Inherited from
Section titled “Inherited from”legends
Section titled “legends”legends:
LegendGroup[]
Defined in: packages/core/src/types.ts:156
One group per encoded dimension: colour first, then shape, lightness and arrangement.
Inherited from
Section titled “Inherited from”nodes:
FingerprintNode[]
Defined in: packages/fingerprint/src/types.ts:119
The marks, laid along the ridges from the core outwards.
ridges
Section titled “ridges”ridges: (readonly [
number,number])[][]
Defined in: packages/fingerprint/src/types.ts:121
The ridges marks sit on, core outwards, as polylines of [x, y] points, for renderers that draw them.
ridgeSpacing
Section titled “ridgeSpacing”ridgeSpacing:
number
Defined in: packages/fingerprint/src/types.ts:125
Centre-to-centre distance between neighbouring ridges.
warnings
Section titled “warnings”warnings:
string[]
Defined in: packages/core/src/types.ts:158
Encodings that will be hard to read, such as more colours than stay distinguishable.
Inherited from
Section titled “Inherited from”width:
number
Defined in: packages/fingerprint/src/types.ts:115
The fixed coordinate frame’s width; resizing scales it, never changes it.