Module: HorizontalCharts

For all details and documentation: www.horizontalcharts.org
Version:
  • 1.1.9
Author:
Copyright:
  • Andrea Giovanni Bianchessi 2022
License:
  • MIT
Source:

Classes

DataSample
HorizontalChart
TimeSeries

Type Definitions

DefaultChartOptions

Contains default chart options.
Type:
  • Object
Properties:
Name Type Attributes Default Description
overSampleFactor number <optional>
 3 Canvas scaling factor.
backgroundColor string <optional>
 "#00000000" Background color (RGB[A] string) of the chart.
padding number <optional>
 5 Space between timeseries.
formatTime function <optional>
 Timestamp formatting function.
axesWidth number <optional>
 2 The thickness of the X and Y axes.
axesColor string <optional>
 "#000000" The color of the X and Y axes.
grid Object <optional>
 Grid options.
Properties
Name Type Attributes Description
y Object <optional>
 Y grid axis options.
Properties
Name Type Attributes Default Description
enabled boolean <optional>
 false If true Y grid axis are shown.
color string <optional>
 "#000000" Y grid axis color.
x Object <optional>
 X grid axis options.
Properties
Name Type Attributes Default Description
enabled boolean <optional>
 false If true X grid axis are shown.
stepSize number <optional>
 20 X grid axis step size.
color string <optional>
 "#000000" X grid axis color.
tooltip Object <optional>
 Tooltip options.
Properties
Name Type Attributes Default Description
enabled boolean <optional>
 true If true tooltips are shown.
backgroundColor string <optional>
 "#FFFFFFDD" Tooltips backround color.
minBarLength number <optional>
 0 Minimum bar length.
xAxis Object <optional>
 X axis options.
Properties
Name Type Attributes Default Description
xUnitsPerPixel number <optional>
 10 X axis scaling factor.
max number <optional>
 105 On real time charts this is the maximum value on the X axis. On non real time charts it is ignored.
xLabel string <optional>
 "" X axis title.
fontSize number <optional>
 12 Font size of the X axis title.
fontFamily string <optional>
 "monospace" Font family of the X axis title.
fontColor string <optional>
 "#000000" Font color of the X axis title.
yLabels Object <optional>
 Y labels options.
Properties
Name Type Attributes Default Description
enabled boolean <optional>
 true If true Y labels are shown.
fontSize boolean <optional>
 12 Font size of the Y labels.
fontFamily string <optional>
 "monospace" Font family of the Y labels.
fontColor string <optional>
 "#000000" Font color of the Y labels.
Source:

DefaultTimeSeriesOptions

Contains default chart options.
Type:
  • Object
Properties:
Name Type Attributes Default Description
barHeight number <optional>
 22 The thickness of the bars.
showValues boolean <optional>
 true Enables the printing of data samples values inside bars.
labelText string <optional>
 "" A short text describing this TimeSeries.
replaceValue boolean <optional>
 false If data sample ts has an exact match in the series, this flag controls whether it is replaced, or not.
disabled boolean <optional>
 false This flag controls wheter this timeseries is displayed or not.
Source: