@squareys/webdecks-sdk - v0.0.0
    Preparing search index...

    Class Chart

    A chart on a sheet, addressed by (sheet, index). Reads are direct model reads; authoring builds categories + series; the Chart.beginEdit session drives the Edit-Data modal (which needs a live renderer — a viewport attached). Mutators chain and repaint.

    Hierarchy (View Summary)

    Index
    • get isValid(): boolean

      Whether this wrapper still refers to a live engine object.

      Returns boolean

    • set _index(value: number): void

      Parameters

      • value: number

      Returns void

    • get kind(): number

      The classic plot kind (see ChartKind); -1 if the chart is gone.

      Returns number

    • get seriesCount(): number

      Number of series.

      Returns number

    • get categoryCount(): number

      Number of categories.

      Returns number

    • get isTransposed(): boolean

      Whether the source row/column mapping is transposed.

      Returns boolean

    • Reference equality is the identity test — prefer a === b. This is retained only for the rare cross-realm case where two wrappers describe the same handle by value. Reads the raw index so comparing a stale wrapper never throws.

      Parameters

      • other: Handle<unknown> | null

      Returns boolean

    • A readable identity for logs and diagnostics, never [object Object].

      Returns string

    • One value of a series.

      Parameters

      • series: number
      • point: number

      Returns number

    • A series' own plot kind (combo charts); -1 if none.

      Parameters

      • series: number

      Returns number

    • A series' packed 0xRRGGBB colour; -1 if none.

      Parameters

      • series: number

      Returns number

    • A series' trendline kind (see TrendlineKind); -1 if the series has none.

      Parameters

      • series: number

      Returns number

    • Change the chart's classic plot kind (see ChartKind).

      Parameters

      • kind: number

      Returns this

    • Mark the chart a modern (chartEx) kind (see ModernChartKind).

      Parameters

      • kind: number

      Returns this

    • Set legend, labels, grouping, and title in one call.

      Parameters

      Returns this

    • Append a category label.

      Parameters

      • label: string

      Returns this

    • Add a series (name + 0xRRGGBB colour); returns its series index.

      Parameters

      • name: string
      • color: number = -1

      Returns number

    • Append a Y value to a series.

      Parameters

      • series: number
      • value: number

      Returns this

    • Set the category (x) and value (y) axis titles (a blank string leaves that side untitled).

      Parameters

      • x: string
      • y: string

      Returns this

    • Toggle value-axis major gridlines.

      Parameters

      • on: boolean

      Returns this

    • Add a regression trendline to a series (type is a TrendlineKind).

      Parameters

      Returns this

    • Remove a series' trendline.

      Parameters

      • series: number

      Returns this

    • Open the Edit-Data session on this chart; returns whether it opened (needs a viewport).

      Returns boolean

    • Add an empty series to the open Edit-Data session.

      Returns this

    • Remove a series from the open Edit-Data session.

      Parameters

      • series: number

      Returns this

    • Add an empty category to the open Edit-Data session.

      Returns this

    • Remove a category from the open Edit-Data session.

      Parameters

      • category: number

      Returns this

    • Swap the row/column source mapping in the open Edit-Data session.

      Returns this

    • Write a datasheet cell in the open session (row 0 = series headers, col 0 = categories).

      Parameters

      • dataRow: number
      • dataColumn: number
      • text: string

      Returns this

    • Re-pick the chart's backing range from an A1 string (e.g. "A1:C6") in the open session.

      Parameters

      • reference: string

      Returns this

    • Close the Edit-Data session.

      Returns this