Skip to content

WaffleCell

Defined in: packages/waffle/src/types.ts:34

A cell: core’s Mark, placed in the grid.

categories: Readonly<Record<string, string>>

Defined in: packages/core/src/types.ts:97

The mark’s category in every encoded dimension, keyed by dimension id; an unknown value is UNKNOWN_CATEGORY_ID. The arranging category is categories[profile.encoding.arrange].

Mark.categories


color: string

Defined in: packages/core/src/types.ts:101

From the colour dimension; currentColor when nothing drives colour.

Mark.color


column: number

Defined in: packages/waffle/src/types.ts:44

Zero-based, left to right.


id: string

Defined in: packages/core/src/types.ts:90

The item id, or a combination key and index when the mark stands for several items.

Mark.id


itemIds: readonly string[]

Defined in: packages/core/src/types.ts:92

The items this mark stands for: one, unless the dataset exceeded maxMarks.

Mark.itemIds


lightness: number | null

Defined in: packages/core/src/types.ts:109

0 (faintest) to 1 (full strength) along an ordered dimension; null when unknown or not encoded.

Mark.lightness


rotation: number

Defined in: packages/waffle/src/types.ts:42

Always 0: cells face one way. There so a renderer written for any view draws a waffle.


row: number

Defined in: packages/waffle/src/types.ts:46

Zero-based, top to bottom.


shape: number | null

Defined in: packages/core/src/types.ts:107

The mark’s shape: the index of its category in the shape dimension (0, 1, 2, …). 0 also when nothing drives shape, so a plain mark is the first shape; null when its shape category is unknown.

Mark.shape


size: number

Defined in: packages/waffle/src/types.ts:40

Width of the mark drawn in the cell. Area is proportional to weight.


weight: number

Defined in: packages/core/src/types.ts:99

The summed weight of itemIds. Views make mark area proportional to it.

Mark.weight


x: number

Defined in: packages/waffle/src/types.ts:36

Centre, in the layout’s frame.


y: number

Defined in: packages/waffle/src/types.ts:38

Centre, in the layout’s frame.