WaffleLayout
Defined in: packages/waffle/src/types.ts:53
What layoutWaffle returns: core’s Profile with its marks placed as cells, in a frame of
fixed width whose height follows the number of rows.
Extends
Section titled “Extends”Omit<Profile,"marks">
Properties
Section titled “Properties”cells:
WaffleCell[]
Defined in: packages/waffle/src/types.ts:59
In reading order: left to right, then top to bottom, following core’s mark order.
columns
Section titled “columns”columns:
number
Defined in: packages/waffle/src/types.ts:61
Cells per row.
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”height
Section titled “height”height:
number
Defined in: packages/waffle/src/types.ts:57
The frame’s height: the rows, at the same pitch as the columns.
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”pitch:
number
Defined in: packages/waffle/src/types.ts:65
Centre-to-centre distance between neighbouring cells.
rows:
number
Defined in: packages/waffle/src/types.ts:63
Rows, the last possibly part-filled.
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/waffle/src/types.ts:55
The fixed coordinate frame’s width; resizing scales it, never changes it.