KeyEntry

One category in the scene's colour key: a name and the colour it is drawn in.

@internote/canvas-sdkInterface
On this page
import { KeyEntry } from '@internote/canvas-sdk';

Two entries are the same entry when their names match, ignoring case, and their colours and strokes match. A matching name in a different colour is a different claim about the picture, and keeps its own entry.

#Fields

active
Whether the pointer is lighting something of this category on the picture, which stands the entry up.
boolean
colourRequired
The hue or colour it is drawn in; the key shows it as a disc.
string
fill
The fill it is drawn in, where that is what it means — a forecast bar hatched against the recorded ones. The key shows a square filled so in place of the disc.
soliddottedhatchedoutlined
nameRequired
What the key calls it.
string
shape
The marker it is drawn as, where that is what it means — a censored reading's cross against an event's circle. The key shows that marker in the entry's colour in place of the disc.
string
stroke
The stroke it is drawn in, where that is what it means — a projection dashed against the solid record. The key shows a short line, solid, dashed or dotted, in place of the disc.
soliddasheddotted

Declared in packages/canvas-sdk/src/footer/index.ts:87.

Last updated