Skip to content

Profile

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

What encodeProfile returns: the marks in drawing order with every visual property resolved, and the legends that explain them. A view gives each mark a position and a size.

encoding: Required<Encoding>

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

Every property resolved to a dimension id, or null when off.


itemCount: number

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

All the items, whatever 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.


legends: LegendGroup[]

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

One group per encoded dimension: colour first, then shape, lightness and arrangement.


marks: Mark[]

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

In order: by the arranging dimension’s categories, then the other encoded ones, then id.


warnings: string[]

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

Encodings that will be hard to read, such as more colours than stay distinguishable.