SDK Reference

ChartType

Chart types

Enumeration Members

Enumeration Member	Value
`BAR`	`"bar"`
`BOX_AND_WHISKER`	`"box_and_whisker"`
`LINE`	`"line"`
`PIE`	`"pie"`
`SCATTER`	`"scatter"`
`SUPERCHART`	`"superchart"`
`UNKNOWN`	`"unknown"`

ScaleType

Ax scale types

Enumeration Members

Enumeration Member	Value
`ASINH`	`"asinh"`
`CATEGORICAL`	`"categorical"`
`DATETIME`	`"datetime"`
`FUNCTION`	`"function"`
`FUNCTIONLOG`	`"functionlog"`
`LINEAR`	`"linear"`
`LOG`	`"log"`
`LOGIT`	`"logit"`
`SYMLOG`	`"symlog"`

Type Aliases

BarChart

type BarChart: Chart2D & object;

Type declaration

Name	Type
`elements`	`BarData`[]
`type`	`ChartType.BAR`

BarData

type BarData: object;

Type declaration

Name	Type
`group`	`string`
`label`	`string`
`value`	`string`

BoxAndWhiskerChart

type BoxAndWhiskerChart: Chart2D & object;

Type declaration

Name	Type
`elements`	`BoxAndWhiskerData`[]
`type`	`ChartType.BOX_AND_WHISKER`

BoxAndWhiskerData

type BoxAndWhiskerData: object;

Type declaration

Name	Type
`first_quartile`	`number`
`label`	`string`
`max`	`number`
`median`	`number`
`min`	`number`
`outliers`	`number`[]
`third_quartile`	`number`

Chart

type Chart: object;

Represents a chart.

Type declaration

Name	Type
`elements`	`any`[]
`title`	`string`
`type`	`ChartType`

ChartTypes

type ChartTypes: 
  | LineChart
  | ScatterChart
  | BarChart
  | PieChart
  | BoxAndWhiskerChart
  | SuperChart;

LineChart

type LineChart: PointChart & object;

Type declaration

Name	Type
`type`	`ChartType.LINE`

PieChart

type PieChart: Chart & object;

Type declaration

Name	Type
`elements`	`PieData`[]
`type`	`ChartType.PIE`

PieData

type PieData: object;

Type declaration

Name	Type
`angle`	`number`
`label`	`string`
`radius`	`number`

PointData

type PointData: object;

Type declaration

Name	Type
`label`	`string`
`points`	[`number` \| `string`, `number` \| `string`][]

ScatterChart

type ScatterChart: PointChart & object;

Type declaration

Name	Type
`type`	`ChartType.SCATTER`

SuperChart

type SuperChart: Chart & object;

Type declaration

Name	Type
`elements`	`Chart`[]
`type`	`ChartType.SUPERCHART`

Functions

deserializeChart()

function deserializeChart(data: any): Chart

Parameters

Parameter	Type
`data`	`any`

Returns

Chart