Skip to content

Update types for indexAxis #8389

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Feb 5, 2021
Merged

Update types for indexAxis #8389

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5333fff
Add indexAxis to CoreChartOptions
kurkle Feb 5, 2021
44428b4
Update types for indexAxis
kurkle Feb 5, 2021
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
16 changes: 11 additions & 5 deletions types/index.esm.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,11 @@ export interface ParsingOptions {
}

export interface ControllerDatasetOptions extends ParsingOptions {
/**
* The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.
* @default 'x'
*/
indexAxis: 'x' | 'y';
/**
* How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: clip: {left: 5, top: false, right: -2, bottom: 0}
*/
Expand All @@ -86,11 +91,6 @@ export interface BarControllerDatasetOptions
extends ControllerDatasetOptions,
ScriptableAndArrayOptions<BarOptions, ScriptableContext>,
ScriptableAndArrayOptions<CommonHoverOptions, ScriptableContext> {
/**
* The base axis of the dataset. 'x' for vertical bars and 'y' for horizontal bars.
* @default 'x'
*/
indexAxis: 'x' | 'y';
/**
* The ID of the x axis to plot this dataset on.
*/
Expand Down Expand Up @@ -1341,6 +1341,12 @@ export interface CoreChartOptions extends ParsingOptions {
animation: Scriptable<AnimationOptions | false, ScriptableContext>;
};

/**
* The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.
* @default 'x'
*/
indexAxis: 'x' | 'y';

/**
* base color
* @see Defaults.color
Expand Down