Skip to content
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.

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

Added 'hidden: boolean' in index.esm.d.ts to ControllerDatasetOptions type #8478

Merged
merged 1 commit into from
Feb 21, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/docs/general/data-structures.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 5 additions & 0 deletions types/index.esm.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down