Skip to content

PlacedMark

Defined in: packages/react/src/types.ts:26

A mark a view has placed: core’s Mark with a centre, a footprint and a direction, in the view’s coordinate frame. Every view’s laid-out marks have this shape, so any renderer draws any view.

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


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/react/src/types.ts:34

Degrees: the direction the mark runs in. 0 in a view whose marks all face one way.


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/react/src/types.ts:32

Diameter of the mark’s footprint. 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/react/src/types.ts:28

Centre, in the view’s frame.


y: number

Defined in: packages/react/src/types.ts:30

Centre, in the view’s frame.