charton API / @chart-on/core / testing / SceneDescription
Interface: SceneDescription
Defined in: packages/core/src/testing/kit.ts:199
What describeScene reports: a plain, serialisable summary of a chart for snapshots.
Properties
annotations
annotations:
object[]
Defined in: packages/core/src/testing/kit.ts:207
App-owned annotations in data coordinates; targets use pane/series indices, never generated ids.
kind
kind:
"marker"|"trade"|"price-line"|"trade-line"|"alert-line"|"draft-line"|"time-band"|"price-zone"|"text-label"
options
options:
Record<string,string|number|boolean|null>
Scalar options only: callbacks, images, series references and structured options are omitted.
pane
pane:
number
series
series:
number|null
visible
visible:
boolean
barSpacing
barSpacing:
number
Defined in: packages/core/src/testing/kit.ts:201
drawings
drawings:
object[]
Defined in: packages/core/src/testing/kit.ts:205
pane
pane:
number
points
points:
object[]
type
type:
string
panes
panes:
ScenePane[]
Defined in: packages/core/src/testing/kit.ts:204
size
size:
object
Defined in: packages/core/src/testing/kit.ts:200
height
height:
number
width
width:
number
visibleRange
visibleRange: {
from:number;to:number; } |null
Defined in: packages/core/src/testing/kit.ts:203
Times at the edges of the visible bars, or null without bars.