@graphty/graphty-element / session / Binding

Type Alias: Binding

Binding = { value: ChannelValue; } | { bins?: number; by: Path; clamp?: [number, number]; domain?: [number, number] | "auto"; exponent?: number; hidden?: (string | number | boolean)[]; map?: Record<string, string | number>; midpoint?: number; missing?: "skip" | { value: string | number; }; other?: { threshold: number; value: string | number; }; overflow?: BindingOverflow; palette?: PaletteId; range?: [number, number]; reverse?: boolean; scale?: "linear" | "log" | "neglog10" | "sqrt" | "pow" | "bins" | "quantile" | "ordinal" | "passthrough" | string & object; }

Defined in: graphty-element/src/catalog/types.ts:575

One channel's binding: a literal, or a declarative mapping from a value in the data.

Union Members

Type Literal

{ value: ChannelValue; }

---

Type Literal

{ bins?: number; by: Path; clamp?: [number, number]; domain?: [number, number] | "auto"; exponent?: number; hidden?: (string | number | boolean)[]; map?: Record<string, string | number>; midpoint?: number; missing?: "skip" | { value: string | number; }; other?: { threshold: number; value: string | number; }; overflow?: BindingOverflow; palette?: PaletteId; range?: [number, number]; reverse?: boolean; scale?: "linear" | "log" | "neglog10" | "sqrt" | "pow" | "bins" | "quantile" | "ordinal" | "passthrough" | string & object; }

bins?

optional bins?: number

by

by: Path

clamp?

optional clamp?: [number, number]

domain?

optional domain?: [number, number] | "auto"

exponent?

optional exponent?: number

hidden?

optional hidden?: (string | number | boolean)[]

Values this binding does not paint: an element carrying one is left exactly as the layers beneath paint it, as an unmeasured element is. Compared as the legend spells a category, so the group 0 and the text "0" are the same value. The legend keeps the value's row, marked hidden, so it can be shown again. Set it per value with styles.setValueHidden(), which is one undoable step.

map?

optional map?: Record<string, string | number>

midpoint?

optional midpoint?: number

missing?

optional missing?: "skip" | { value: string | number; }

other?

optional other?: object

other.threshold

threshold: number

other.value

value: string | number

overflow?

optional overflow?: BindingOverflow

What a categorical colour binding does with more groups than its palette can keep apart. See BindingOverflow. Absent, a palette the binding names is refused with E_CAP_EXCEEDED and one it leaves to the element is chosen large enough.

palette?

optional palette?: PaletteId

range?

optional range?: [number, number]

reverse?

optional reverse?: boolean

scale?

optional scale?: "linear" | "log" | "neglog10" | "sqrt" | "pow" | "bins" | "quantile" | "ordinal" | "passthrough" | string & object