Skip to content
View as Markdown

ChartType

Section titled “ChartType”

Enum Members:

  • BAR (“bar”)
  • LINE (“line”)
  • PIE (“pie”)
  • SCATTER (“scatter”)
  • UNKNOWN (“unknown”)

parseChart()

Section titled “parseChart()”
function parseChart(chart: Chart): Chart;

Parameters:

  • chart Chart

Returns:

  • Chart

BarChart

Section titled “BarChart”
type BarChart = Chart2D & {
  type: "bar";
};

Type Declaration

Section titled “Type Declaration”

type

Section titled “type”
type: "bar";

BarData

Section titled “BarData”
type BarData = Pick<GeneratedChartElement, "group" | "label" | "value">;

BoxAndWhiskerChart

Section titled “BoxAndWhiskerChart”
type BoxAndWhiskerChart = Chart2D & {
  type: "box_and_whisker";
};

Type Declaration

Section titled “Type Declaration”

type

Section titled “type”
type: "box_and_whisker";

BoxAndWhiskerData

Section titled “BoxAndWhiskerData”
type BoxAndWhiskerData = Pick<GeneratedChartElement, "first_quartile" | "label" | "max" | "median" | "min" | "outliers">;

Chart

Section titled “Chart”
type Chart = GeneratedChart;

Chart2D

Section titled “Chart2D”
type Chart2D = Pick<GeneratedChart, "type" | "title" | "png" | "x_label" | "y_label" | "elements">;

ChartElement

Section titled “ChartElement”
type ChartElement = GeneratedChartElement;

CompositeChart

Section titled “CompositeChart”
type CompositeChart = Pick<GeneratedChart, "type" | "title" | "png" | "elements"> & {
  type: "composite_chart";
};

Type Declaration

Section titled “Type Declaration”

type

Section titled “type”
type: "composite_chart";

LineChart

Section titled “LineChart”
type LineChart = PointChart & {
  type: "line";
};

Type Declaration

Section titled “Type Declaration”

type

Section titled “type”
type: "line";

PieChart

Section titled “PieChart”
type PieChart = Pick<GeneratedChart, "type" | "title" | "png" | "elements"> & {
  type: "pie";
};

Type Declaration

Section titled “Type Declaration”

type

Section titled “type”
type: "pie";

PieData

Section titled “PieData”
type PieData = Pick<GeneratedChartElement, "angle" | "label" | "radius">;

PointChart

Section titled “PointChart”
type PointChart = Pick<GeneratedChart,
  | "type"
  | "title"
  | "png"
  | "x_label"
  | "y_label"
  | "x_ticks"
  | "y_ticks"
  | "x_tick_labels"
  | "y_tick_labels"
  | "x_scale"
  | "y_scale"
| "elements">;

PointData

Section titled “PointData”
type PointData = Pick<GeneratedChartElement, "label" | "points">;

ScatterChart

Section titled “ScatterChart”
type ScatterChart = PointChart & {
  type: "scatter";
};

Type Declaration

Section titled “Type Declaration”

type

Section titled “type”
type: "scatter";