Skip to content

@graphty/graphty-element / session / FieldBand

Interface: FieldBand ​

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

One band of a field's interpretation scale: a range of values and what a value in it means.

A band's lower bound is above (exclusive) or atLeast (inclusive), never both. The lowest band has neither and takes everything below the band above it.

Properties ​

above? ​

optional above?: number

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

A value strictly greater than this is in the band.


atLeast? ​

optional atLeast?: number

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

A value greater than or equal to this is in the band.


description ​

description: string

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

One plain-language sentence on what a value in this band means.


id ​

id: string

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

A stable id a consumer may key its own wording on, such as "clear".


plainName ​

plainName: string

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

The band in a few plain words, such as "Clearly separated".