Skip to content

add typing and docs for maxTicksLimit all scales #10057

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

Merged
merged 2 commits into from
Jan 11, 2022
Merged

add typing and docs for maxTicksLimit all scales #10057

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9a34c0d
add typing and docs for maxTicksLimit time scale
LeeLenaleee Jan 7, 2022
9cdb640
change maxTicksLimit to base instead of each scale seperatly since i…
LeeLenaleee Jan 8, 2022
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
1 change: 1 addition & 0 deletions docs/axes/cartesian/time.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Namespace: `options.scales[scaleId]`
| `adapters.date` | `object` | `{}` | Options for adapter for external date library if that adapter needs or supports options
| `bounds` | `string` | `'data'` | Determines the scale bounds. [more...](./index.md#scale-bounds)
| `ticks.source` | `string` | `'auto'` | How ticks are generated. [more...](#ticks-source)
| `ticks.maxTicksLimit` | `number` | `11` | Maximum number of ticks and gridlines to show.
| `time.displayFormats` | `object` | | Sets how different time units are displayed. [more...](#display-formats)
| `time.isoWeekday` | `boolean`\|`number` | `false` | If `boolean` and true and the unit is set to 'week', then the first day of the week will be Monday. Otherwise, it will be Sunday. If `number`, the index of the first day of the week (0 - Sunday, 6 - Saturday)
| `time.parser` | `string`\|`function` | | Custom parser for dates. [more...](#parser)
Expand Down
6 changes: 6 additions & 0 deletions types/index.esm.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3249,6 +3249,12 @@ export type TimeScaleOptions = CartesianScaleOptions & {
* @default 'auto'
*/
source: 'labels' | 'auto' | 'data';

/**
* Maximum number of ticks and gridlines to show.
* @default 11
*/
maxTicksLimit: number;
};
};

Expand Down