You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
vargburz
f722ca7e58
|
3 years ago | |
---|---|---|
build | 3 years ago | |
src | 3 years ago | |
.gitignore | 3 years ago | |
CHANGELOG.md | 3 years ago | |
LICENSE | 3 years ago | |
README.md | 3 years ago | |
css.d.ts | 3 years ago | |
demo.html | 3 years ago | |
package.json | 3 years ago | |
tsconfig.json | 3 years ago | |
yarn.lock | 3 years ago |
README.md
Chartwerk Core
Repo contains the core code of chartwerk project: abstrac classes and rendreing of grid together with crosshair! :) See ChartwerkPod to see what is parent for all chartwerk pods and get involved into development.
Plugin renders:
- SVG container with:
- Axes, with ticks and labels.
- Grid, which scales using specified time interval.
- Legend, which can hide metrics.
Options:
Options are not mandatory:
margin
— chart container positioning;
margin={
top: number,
right: number,
bottom: number,
left: number
}
colors
: array of metrics colors (should be equal or greater than series length);
['red', 'blue', 'green']
-
timeInterval
: interval in minutes (max value = 60) affecting grid and x-axis ticks. -
tickFormat
: config to control the axes ticks format.
{
xAxis: string; // x-axis time format (see [d3-time-format](https://github.com/d3/d3-time-format#locale_format) }
xTickOrientation: TickOrientation; // horizontal, diagonal or vertical orientation
}
for example:
{
xAxis: '%Y-%m-%d %H:%M',
xTickOrientation: TickOrientation.DIAGONAL
}
labelFormat
: labels for axes.
{
xAxis: string;
yAxis: string;
}
for example:
{
xAxis: 'Time';
yAxis: 'Value';
}
bounds
: specify which metrics should be rendered as confidence. (TODO: move to@chartwerk/line-chart
)$__metric_name
macro can be used here. It will be replaced with each metric's name to find it's bound.
{
upper: string;
lower: string;
}
for example: metric names: 'serie', 'serie upper_bound', 'serie lower_bound'
bounds={
upper: '$__metric_name upper_bound';
lower: '$__metric_name lower_bound';
}
'serie upper_bound', 'serie lower_bound' metrics will be rendered as serie
metric confidence;
timeRange
: time range in timestamps
{
from: number;
to: number;
}
for example:
{
from: 1582770000000;
to: 1582810000000;
}
eventsCallbacks
: event callbacks
{
zoomIn: (range: [number, number]) => void,
zoomOut: (center: number) => void,
mouseMove: (evt: any) => void,
mouseOut: () => void,
onLegendClick: (idx: number) => void
}