Options
All
  • Public
  • Public/Protected
  • All
Menu

Describes one column slot declared by a renderable series - the discoverable, queryable answer to "what fields does this series consume, and what are they currently bound to". TS analogue of the C++ SCRTColumnSlot (see SCRTRenderableSeries2D.h), plus a bindable flag gating which slots this phase of the substrate allows ColumnBindings.bind to target.

Hierarchy

  • IColumnSlot

Index

Properties

bindable

bindable: boolean

True when ColumnBindings.bind is currently allowed to target this slot

Optional boundColumn

boundColumn: string | number

The data-series column override for this slot; undefined = default (unbound)

Optional description

description: string

Human-readable purpose, surfaced to reflection/tooling

name

name: string

Slot name, e.g. "x", "y", "y1", "open", "high", "low", "close", "z"

required

required: boolean

True when the series cannot draw without this slot resolving

role

Which axis this slot participates in ranging for

usedForRange

usedForRange: boolean

True when this slot's values participate in the series' autorange

Generated using TypeDoc