]> git.ipfire.org Git - thirdparty/Chart.js.git/commitdiff
Added 'hidden: boolean' to ControllerDatasetOptions type and documented the field...
authorKashif Shamaz <kashifshamaz21@users.noreply.github.com>
Sun, 21 Feb 2021 16:17:01 +0000 (21:47 +0530)
committerGitHub <noreply@github.com>
Sun, 21 Feb 2021 16:17:01 +0000 (18:17 +0200)
docs/docs/general/data-structures.md
types/index.esm.d.ts

index 17913bcbf0cfaee8c16a33e6b4546a82ea4ba859..8bc65bf18017951031e1ff8027483edde1929be1 100644 (file)
@@ -71,6 +71,7 @@ In this mode, property name is used for `index` scale and value for `value` scal
 | `order` | `number` | The drawing order of dataset. Also affects order for stacking, tooltip and legend.
 | `stack` | `string` | The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack).
 | `parsing` | `boolean`\|`object` | How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.
+| `hidden`  | `boolean` | Configure the visibility of the dataset. Using `hidden: true` will hide the dataset from being rendered in the Chart.
 
 ### parsing
 
index 5a4802179c304f80736eb61fe1063c5f4edcc521..64449af8f935be41163cbf06602783394fd2e8ac 100644 (file)
@@ -87,6 +87,11 @@ export interface ControllerDatasetOptions extends ParsingOptions {
         * The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack).
         */
        stack: string;
+       /**
+     * Configures the visibility state of the dataset. Set it to true, to hide the dataset from the chart.
+        * @default false
+        */
+       hidden: boolean;
 }
 
 export interface BarControllerDatasetOptions