Document new time options #4592
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
benmccann
force-pushed
the
docs
branch
2 times, most recently
from
8def8c5
to
8567242
Compare
simonbrunel
requested changes
Aug 3, 2017
docs/axes/cartesian/time.md
Outdated
| | `unit` | `String` | `false` | If defined, will force the unit to be a certain type. See [Time Units](#time-units) section below for details. | ||
| | `stepSize` | `Number` | `1` | The number of units between grid lines. | ||
| | `minUnit` | `String` | `'millisecond'` | The minimum display format to be used for a time unit. | ||
| | `scales.distribution` | `String` | `linear` | How data is plotted. Valid options are `linear` and `series`. [more...](#scale-distribution) |
There was a problem hiding this comment.
It's confusing to prefix root options with scale., it looks like scale.*, ticks.* and time.* are all at the same level.
There was a problem hiding this comment.
I would remove Valid options are linear and series. to keep the table shorter: it's detailed in the more link.
docs/axes/cartesian/time.md
Outdated
| | `stepSize` | `Number` | `1` | The number of units between grid lines. | ||
| | `minUnit` | `String` | `'millisecond'` | The minimum display format to be used for a time unit. | ||
| | `scales.distribution` | `String` | `linear` | How data is plotted. Valid options are `linear` and `series`. [more...](#scale-distribution) | ||
| | `scale.bounds` | `String` | `data` | Determines the scale bounds. Valid options are `data` and `ticks`. [more...](#scale-bounds) |
There was a problem hiding this comment.
I would remove Valid options are data and ticks., it's detailed in the more link.
docs/axes/cartesian/time.md
Outdated
| | `minUnit` | `String` | `'millisecond'` | The minimum display format to be used for a time unit. | ||
| | `scales.distribution` | `String` | `linear` | How data is plotted. Valid options are `linear` and `series`. [more...](#scale-distribution) | ||
| | `scale.bounds` | `String` | `data` | Determines the scale bounds. Valid options are `data` and `ticks`. [more...](#scale-bounds) | ||
| | `ticks.source` | `String` | `auto` | How ticks are generated. Valid options are `auto`, `data, and `labels`. [more...](#ticks-source) |
docs/axes/cartesian/time.md
Outdated
|
|
||
| This property controls the data distribution along the scale: | ||
|
|
||
| * 'linear': data are spread according to their time (distances can vary) |
There was a problem hiding this comment.
I would format values as code:
`'linear'`
docs/axes/cartesian/time.md
Outdated
|
|
||
| This property controls the scale boundary strategy (bypassed by min/max time options) | ||
|
|
||
| * `data`: make sure data are fully visible, labels outside are removed |
There was a problem hiding this comment.
Values are strings:
`'data'`
benmccann
force-pushed
the
docs
branch
2 times, most recently
from
0bdb8f1
to
90d2c5b
Compare
simonbrunel
approved these changes
Aug 3, 2017
This was referenced Aug 5, 2017
|
@etimberg could you give this one a look? thanks! |
etimberg
approved these changes
Aug 8, 2017
yofreke
pushed a commit
to yofreke/Chart.js
that referenced
this pull request
Dec 30, 2017
exwm
pushed a commit
to exwm/Chart.js
that referenced
this pull request
Apr 30, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR includes the updates introduced in #4595