@graphty/graphty-element / session / LegendReading

Interface: LegendReading

Defined in: graphty-element/src/session/styles/legend.ts:113

What a higher value means on the drawing, as a fact for a legend to put in its own words.

code names the fact and params carries its parts, so an application writes the sentence ("Darker means more Influence", with the field's words from LegendBlock.field) in its own language and voice.

Properties

code

readonly code: "legend.higher"

Defined in: graphty-element/src/session/styles/legend.ts:115

A higher value of field is drawn further in direction on channel.

---

params

readonly params: object

Defined in: graphty-element/src/session/styles/legend.ts:117

The parts of the fact.

channel

readonly channel: Channel

The channel the block describes.

direction

readonly direction: "darker" | "lighter" | "larger" | "smaller"

Which way a higher value moves the paint: "darker" or "lighter" for a colour (by the luminance of the colours painted at the two ends of the domain), "larger" or "smaller" for a number such as a size, a width or an opacity.

field

readonly field: string

The column path the encoding reads.