Interface ISparkline

A sparkline: one cell's view of its group.

Remarks

Transient and read-only, as ITable.IColumn is: it answers for the group as the group is when asked, and changes go through the group.

interface ISparkline {
    isISparkline: true;
    getDataRange(): ICellRange;
    getGroup(): ISparklineGroup;
    getLayout(size: Size): SparklineLayout;
    getRange(): ICellRange;
}

Index

Properties

Methods

getDataRange getGroup getLayout getRange

Properties

`Readonly`isISparkline

isISparkline: true

For runtime type checking.

Methods

getDataRange

getDataRange(): ICellRange
The cells the sparkline draws.

Returns ICellRange
Remarks
- Never null. Once its cells are deleted it is an invalid range; ask ICellRange.isInvalid.
- The data follows its cells as a formula does, so this answers where they are now.

getGroup

getGroup(): ISparklineGroup

The group whose properties the sparkline draws with.

Returns ISparklineGroup

getLayout

getLayout(size: Size): SparklineLayout
The sparkline laid out in a box: its line or columns, markers and axis, in px, with every color concrete. What a painter draws.
Parameters
- size: Size
  The box in px, unzoomed: the cell's.
Returns SparklineLayout
Remarks
Read from its data now: the hidden rows and columns left out unless the group shows them, text and errors as empty cells. An axis whose type is 'group' reads the data of the whole group.
Example
```
const layout = sheet.getSparklineGroups().getItems()[0].getSparklineAt(0)!.getLayout({ width: 64, height: 20 });
console.log(layout.min, layout.max, layout.line?.runs.length);
```

getRange

getRange(): ICellRange

The cell the sparkline draws in.

Returns ICellRange