add typing and docs for maxTicksLimit time scale

chartjs · Jan 7, 2022 · 9a34c0d · 9a34c0d
1 parent cb1fd3f
commit 9a34c0d
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/docs/axes/cartesian/time.md b/docs/axes/cartesian/time.md
@@ -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)

diff --git a/types/index.esm.d.ts b/types/index.esm.d.ts
@@ -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;
   };
 };