common
Classes
Type Definitions
BoxArray
Type:
TooltipPosition
Type:
Properties:
| Name | Type | Description |
|---|---|---|
0 |
"left" | "center" | "right" | "leftright" | Horizontal placement hints |
1 |
"above" | "top" | "middle" | "bottom" | "below" | Vertical placement hints |
Example
"left below"AxisOptions
Type:
Properties:
| Name | Type | Default | Description | |
|---|---|---|---|---|
disabled |
boolean | <optional> | ||
position |
"left" | "right" | "top" | "bottom" | <optional> |
("left"|"bottom")
|
Where to place the axis |
align |
"inside" | "outside" | <optional> |
"outside"
|
Alignment axis labels and ticks |
ticks |
number | <optional> | Number of labeled ticks to draw. | |
showFirst |
boolean | <optional> | Show the first (visual-low) label of the axis | |
hideLast |
boolean | <optional> | Hide the last (visual-high) label of the axis | |
tickLength |
number | <optional> |
5
|
Size of the tick marks |
format |
function | <optional> | Custom callback function for label values | |
padding |
string | <optional> | Custom axis label padding | |
rotate |
number | <optional> | Degrees of rotation. Negative values on an xAxis will invert the alignment. |
TooltipOptions
Type:
Properties:
| Name | Type | Default | Description | |
|---|---|---|---|---|
disabled |
boolean | <optional> | ||
padding |
BoxArray | <optional> | Padding offsets for tooltip box | |
linger |
number | <optional> |
800
|
Milliseconds to linger before hiding |
position |
TooltipPosition | <optional> |
"leftright"
|
Relative positioning of tooltip with respect to the pointer |
format |
function | <optional> | Custom callback function for tooltip value | |
formatKey |
function | <optional> | Custom callback function for tooltip key |
DataEntry
Type:
DataValue
Type:
DataTuple
Type:
Properties:
| Name | Type | Description |
|---|---|---|
0 |
number | position/size |
1 |
number | value |
CoordTuple
Type:
Properties:
| Name | Type | Description |
|---|---|---|
0 |
number | X coordinate |
1 |
number | Y coordinate |
CoordRange
Type:
Properties:
| Name | Type | Description |
|---|---|---|
0 |
number | start value |
1 |
number | end value |
ChartOptions
Type:
Properties:
| Name | Type | Description | |
|---|---|---|---|
el |
Element | <optional> | DOM Element to insert chart into |
parent |
Chart | <optional> | Make this chart a child chart that shares one svg element |
data |
ChartData | <optional> | Initial data to use for chart rendering |
xMin |
number | <optional> | Minimum X data value |
xMax |
number | <optional> | Maximum X data value |
yMin |
number | <optional> | Minimum Y data value |
yMax |
number | <optional> | Maximum Y data value |
title |
string | <optional> | Visually displayed title of chart |
color |
external:CSS_Color | <optional> | The CSS color basis for this chart's data |
padding |
BoxArray | <optional> | Plot padding in DPI adjusted coordinates. |
width |
number | <optional> | Fixed width of plot |
height |
number | <optional> | Fixed height of plot |
tooltip |
TooltipOptions | <optional> | Tooltip options |
xAxis |
AxisOptions | <optional> | X axis options |
yAxis |
AxisOptions | <optional> | Y axis options |
disableAnimation |
boolean | <optional> | Disable all animation/transitions |
darkMode |
boolean | <optional> | Force use of darkmode |
Events
tooltip
Type:
zoom
Type:
Properties:
| Name | Type | Description | |
|---|---|---|---|
type |
"data" | "visual" | ||
xRange |
CoordRange | <optional> | |
yRange |
CoordRange | <optional> | |
translate |
CoordTuple | <optional> | |
scale |
number | <optional> | |
internal |
boolean | Was the event triggered internally by pointer events | |
chart |
Chart |