Skip to content

update #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mattchaley wants to merge 2 commits into
base: master
Choose a base branch
from
Open

update #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d29569
update
mattchaley Jun 8, 2020
d14e403
Update README.md
mattchaley Jun 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ Plugin with an abstract class providing basics for timeseries visualization.

## Plugin renders:
- SVG container with:
- Axes with ticks and labels
- Grid, scales using specified time interval
- Legend which can hide metrics
- Axes, with ticks and labels.
- Grid, which scales using specified time interval.
- Legend, which can hide metrics.

## Options:

All options are optional
All options are elevctive:

- `margin` — chart container positioning;
```js
Expand All @@ -22,14 +22,14 @@ margin={
}
```

- `colors`: array of metrics colors, should be equal or greater than series length;
- `colors`: array of metrics colors (should be equal or greater than series length);
```js
['red', 'blue', 'green']
```

- `timeInterval`: interval in minutes (max value = 60) affecting grid and x-axis ticks
- `timeInterval`: interval in minutes (max value = 60) affecting grid and x-axis ticks.

- `tickFormat`: config to control the axes ticks format
- `tickFormat`: config to control the axes ticks format.
```js
{
xAxis: string; // x-axis time format (see [d3-time-format](https://github.com/d3/d3-time-format#locale_format) }
Expand All @@ -44,7 +44,7 @@ for example:
}
```

- `labelFormat`: labels for axes
- `labelFormat`: labels for axes.
```
{
xAxis: string;
Expand All @@ -60,7 +60,7 @@ for example:
```

- `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 name to find it's bound.
`$__metric_name` macro can be used here. It will be replaced with each metric's name to find it's bound.
```
{
upper: string;
Expand Down