]> git.ipfire.org Git - thirdparty/Chart.js.git/commitdiff
add typing and docs for maxTicksLimit all scales (#10057)
authorJacco van den Berg <39033624+LeeLenaleee@users.noreply.github.com>
Tue, 11 Jan 2022 20:57:35 +0000 (21:57 +0100)
committerGitHub <noreply@github.com>
Tue, 11 Jan 2022 20:57:35 +0000 (15:57 -0500)
* add typing and docs for maxTicksLimit time scale

* change maxTicksLimit to base  instead of each scale seperatly since its done in the core.scale

docs/axes/cartesian/_common_ticks.md
docs/axes/cartesian/linear.md
types/index.esm.d.ts

index 9f2575477cb92198ce186d03a9c7472f33f99687..aeb3992a0e1fe0211fdcbbbdcba0e5fc5f6e1da8 100644 (file)
@@ -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.
index 2aaf9c53205adf2d60fe4ea9a55c3024e391f938..695e9b69f852934a695dd3be45ba899734e2ec02 100644 (file)
@@ -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)
 
index 96ad30bf8cd77e40d1b97dbdef875609a76cc393..0b049117cef7db0b516a7ffcc3f8998a7785c8af 100644 (file)
@@ -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;
   };
 }
 
@@ -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.
      */