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.

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

Jump to bottom

Enable scriptable element chart options #9012

Merged
merged 1 commit into from May 1, 2021
Merged

Enable scriptable element chart options #9012

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 12 additions & 11 deletions types/index.esm.d.ts
View file
Open in desktop
Expand Up @@ -604,7 +604,7 @@ export interface DatasetControllerChartComponent extends ChartComponent {
};
}

export interface Defaults extends CoreChartOptions<ChartType>, ElementChartOptions, PluginChartOptions<ChartType> {
export interface Defaults extends CoreChartOptions<ChartType>, ElementChartOptions<ChartType>, PluginChartOptions<ChartType> {

scale: ScaleOptionsByType;
scales: {
Expand Down Expand Up @@ -641,7 +641,7 @@ export interface Defaults extends CoreChartOptions<ChartType>, ElementChartOptio
export type Overrides = {
[key in ChartType]:
CoreChartOptions<key> &
ElementChartOptions &
ElementChartOptions<key> &
PluginChartOptions<key> &
DatasetChartOptions<ChartType> &
ScaleChartOptions<key> &
Expand Down Expand Up @@ -1887,16 +1887,17 @@ export const BarElement: ChartComponent & {
new (cfg: AnyObject): BarElement;
};

export interface ElementOptionsByType {
arc: ArcOptions & ArcHoverOptions;
bar: BarOptions & BarHoverOptions;
line: LineOptions & LineHoverOptions;
point: PointOptions & PointHoverOptions;
}
export interface ElementChartOptions {
elements: Partial<ElementOptionsByType>;
export interface ElementOptionsByType<TType extends ChartType> {
arc: ScriptableAndArrayOptions<ArcOptions & ArcHoverOptions, ScriptableContext<TType>>;
bar: ScriptableAndArrayOptions<BarOptions & BarHoverOptions, ScriptableContext<TType>>;
line: ScriptableAndArrayOptions<LineOptions & LineHoverOptions, ScriptableContext<TType>>;
point: ScriptableAndArrayOptions<PointOptions & PointHoverOptions, ScriptableContext<TType>>;
}

export type ElementChartOptions<TType extends ChartType = ChartType> = {
elements: ElementOptionsByType<TType>
};

export class BasePlatform {
/**
* Called at chart construction time, returns a context2d instance implementing
Expand Down Expand Up @@ -3321,7 +3322,7 @@ export type ScaleChartOptions<TType extends ChartType = ChartType> = {

export type ChartOptions<TType extends ChartType = ChartType> = DeepPartial<
CoreChartOptions<TType> &
ElementChartOptions &
ElementChartOptions<TType> &
PluginChartOptions<TType> &
DatasetChartOptions<TType> &
ScaleChartOptions<TType> &
Expand Down
49 changes: 49 additions & 0 deletions types/tests/elements/scriptable_element_options.ts
View file
Open in desktop
@@ -0,0 +1,49 @@
import { Chart } from '../../index.esm';

const chart = new Chart('id', {
type: 'line',
data: {
labels: [],
datasets: []
},
options: {
elements: {
line: {
borderWidth: () => 2,
},
point: {
pointStyle: (ctx) => 'star',
}
}
}
});

const chart2 = new Chart('id', {
type: 'bar',
data: {
labels: [],
datasets: []
},
options: {
elements: {
bar: {
borderWidth: (ctx) => 2,
}
}
}
});

const chart3 = new Chart('id', {
type: 'doughnut',
data: {
labels: [],
datasets: []
},
options: {
elements: {
arc: {
borderWidth: (ctx) => 3,
}
}
}
});