Skip to content

ProfileInput

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

encodeProfile’s one argument. The items array is treated as immutable: work is cached against it, so pass a new array when the dataset changes.

dimensions: readonly Dimension[]

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

Every dimension the items carry values for; the encoding picks among them.


optional encoding?: Encoding

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

Which dimension drives what. Defaults to the first dimension arranging, colouring and shaping.


items: readonly Item[]

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

One per mark (below the cap). Unique ids.


optional maxMarks?: number

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

Above this many items, marks stand for several items each. No cap by default: a view sets the most marks it can draw well. A profile can exceed it slightly, since every combination of encoded categories needs a mark.