Skip to content

Commit

Permalink
add typing and docs for maxTicksLimit all scales (#10057)
Browse files Browse the repository at this point in the history
* add typing and docs for maxTicksLimit time scale

* change maxTicksLimit to base  instead of each scale seperatly since its done in the core.scale
  • Loading branch information
LeeLenaleee committed Jan 11, 2022
1 parent cb1fd3f commit 4d918f5
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
1 change: 1 addition & 0 deletions docs/axes/cartesian/_common_ticks.md
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
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
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

0 comments on commit 4d918f5

Please sign in to comment.