Skip to content

Interface: TraceDescription ​

Experimental

A trace's accessible description (E17.1).

Properties ​

PropertyModifierTypeDescription
insight?readonlyTraceInsightExperimental Facts for the generated summary (E17.2): the runtime's lazily loaded summary code turns them into localized sentences about trends and extremes ("Revenue rises from 1.2M (Jan) to 3.4M (Dec). It peaks at 3.6M (Nov)."). Arrays are the calc's own (not copied); keep this cheap.
kind?readonlystringExperimental What kind of chart this trace makes, as a lowercase noun for the chart-level summary ("Line and bar chart with 3 traces"): 'line', 'area', 'bubble', 'horizontal bar', 'donut', … Default: the trace type.
summaryreadonlystringExperimental One or two plain-text sentences, e.g. "Scatter 'Revenue': 120 points; x 2020–2024; y 3.1–9.8."
table?readonlyobjectExperimental An optional data table rendered as a hidden <table> (the table trace's cells, or a sample of a trace's points). Cell text is plain text.
table.caption?readonlystring-
table.columnsreadonlyreadonly string[]-
table.row?readonly(i) => readonly string[]Row i of all total rows (E17.3), for the visible data table (config.a11y.dataTable: 'visible'), which formats only the rows scrolled into view. Without it the visible table shows rows only.
table.rowsreadonlyreadonly readonly string[][]-
table.total?readonlynumberRows the data has when rows holds only the first DescribeContext.maxRows: the table then says "first N of M". Default: rows.length.

Released under the MIT License.