Skip to main content

Figure

Base class: Object

Figure builder that collects data, configuration and options.

Constructors​

Figure() -> Figure​

Creates an empty Figure.

Figure(const Figure figure) -> Figure​

Copies a Figure.

Parameters​

  • figure: The figure to copy

Members​

NameDescription
barAdds a bar series from point data. Auto sampling uses sum when x values are ordered.
data_zoomSets the dataZoom option map.
datasetSets the dataset option.
gridEnsures grid exists with default options.
heatmapAdds a heatmap series from point data. Heatmap series are not auto-sampled.
legendEnsures legend exists with default options.
lineAdds a line series defined by options only. Auto sampling uses minmax above 50000 points.
optionSets a single top-level option.
optionsMerges a map of top-level options.
samplingSets figure-level sampling mode. Auto uses minmax for line series and sum for ordered bar series; scatter and heatmap are not auto-sampled.
saveWrites the figure as a .figure file.
scatterAdds a scatter series defined by options only. Scatter series are not auto-sampled.
titleSets the figure title.
tooltipEnsures tooltip exists with default options.
visual_mapSets the visualMap option map.
x_axisSets the xAxis option map.
y_axisEnsures yAxis exists with default options.