Sign Up

ChartType

Enum Members:

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

parseChart()

function parseChart(chart: Chart): Chart;

Parameters:

  • chart Chart

Returns:

  • Chart

BarChart

type BarChart = Chart2D & {
  type: "bar";
};

Type Declaration

type

type: "bar";

BarData

type BarData = Pick<GeneratedChartElement, "group" | "label" | "value">;

BoxAndWhiskerChart

type BoxAndWhiskerChart = Chart2D & {
  type: "box_and_whisker";
};

Type Declaration

type

type: "box_and_whisker";

BoxAndWhiskerData

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

Chart

type Chart = GeneratedChart;

Chart2D

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

ChartElement

type ChartElement = GeneratedChartElement;

CompositeChart

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

Type Declaration

type

type: "composite_chart";

LineChart

type LineChart = PointChart & {
  type: "line";
};

Type Declaration

type

type: "line";

PieChart

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

Type Declaration

type

type: "pie";

PieData

type PieData = Pick<GeneratedChartElement, "angle" | "label" | "radius">;

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

type PointData = Pick<GeneratedChartElement, "label" | "points">;

ScatterChart

type ScatterChart = PointChart & {
  type: "scatter";
};

Type Declaration

type

type: "scatter";