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 all commits
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/_common_ticks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ Namespace: `options.scales[scaleId].ticks`
| `minRotation` | `number` | `0` | Minimum rotation for tick labels. *Note: Only applicable to horizontal scales.*
| `mirror` | `boolean` | `false` | Flips tick labels around axis, displaying the labels inside the chart instead of outside. *Note: Only applicable to vertical scales.*
| `padding` | `number` | `0` | Padding between the tick label and the axis. When set on a vertical axis, this applies in the horizontal (X) direction. When set on a horizontal axis, this applies in the vertical (Y) direction.
| `maxTicksLimit` | `number` | `11` | Maximum number of ticks and gridlines to show.
1 change: 0 additions & 1 deletion docs/axes/cartesian/linear.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ Namespace: `options.scales[scaleId].ticks`
| ---- | ---- | ------- | ------- | -----------
| `count` | `number` | Yes | `undefined` | The number of ticks to generate. If specified, this overrides the automatic generation.
| `format` | `object` | Yes | | The [`Intl.NumberFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat) options used by the default label formatter
| `maxTicksLimit` | `number` | Yes | `11` | Maximum number of ticks and gridlines to show.
| `precision` | `number` | Yes | | if defined and `stepSize` is not specified, the step size will be rounded to this many decimal places.
| `stepSize` | `number` | Yes | | User-defined fixed step size for the scale. [more...](#step-size)

Expand Down
10 changes: 5 additions & 5 deletions types/index.esm.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3078,6 +3078,11 @@ export interface CartesianScaleOptions extends CoreScaleOptions {
* @default 0
*/
padding: number;
/**
* Maximum number of ticks and gridlines to show.
* @default 11
*/
maxTicksLimit: number;
};
}

Expand Down Expand Up @@ -3120,11 +3125,6 @@ export type LinearScaleOptions = CartesianScaleOptions & {
*/
format: Intl.NumberFormatOptions;

/**
* Maximum number of ticks and gridlines to show.
* @default 11
*/
maxTicksLimit: number;
/**
* if defined and stepSize is not specified, the step size will be rounded to this many decimal places.
*/
Expand Down