Skip to content

Update type map names #8356

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
etimberg merged 5 commits into from
Feb 1, 2021
Merged

Update type map names #8356

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e516f68
Rename ElementOptions to ElementOptionsByType
etimberg Jan 30, 2021
17e4f49
Rename CommonOptions to CommonElementOptions
etimberg Jan 30, 2021
d2385b6
Rename PluginOptions to PluginOptionsByType
etimberg Jan 30, 2021
3aa92c2
Rename ScaleOptions to ScaleOptionsByType
etimberg Jan 30, 2021
001bc97
Use Partial where appropriate
etimberg Feb 1, 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
40 changes: 21 additions & 19 deletions types/index.esm.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -594,24 +594,23 @@ export interface DatasetControllerChartComponent extends ChartComponent {
}

export type AnyObject = Record<string, unknown>;
export interface Defaults extends CoreChartOptions, ElementChartOptions {
export interface Defaults extends CoreChartOptions, ElementChartOptions, PluginChartOptions {
controllers: {
[key in ChartType]: DeepPartial<
CoreChartOptions &
ElementChartOptions &
PluginChartOptions &
DatasetChartOptions<key>[key] &
ScaleChartOptions<key> &
ChartTypeRegistry[key]['chartOptions']
>;
};

scale: ScaleOptions;
scale: ScaleOptionsByType;
scales: {
[key in ScaleType]: ScaleOptions<key>;
[key in ScaleType]: ScaleOptionsByType<key>;
Comment thread
etimberg marked this conversation as resolved.
};

plugins: PluginOptions;

set(values: AnyObject): AnyObject;
set(scope: string, values: AnyObject): AnyObject;
get(scope: string): AnyObject;
Expand Down Expand Up @@ -1339,12 +1338,12 @@ export interface CoreChartOptions extends ParsingOptions {
* @see Defaults.color
*/
color: Color;
/**
/**
* base background color
* @see Defaults.backgroundColor
*/
backgroundColor: Color;
/**
/**
* base border color
* @see Defaults.borderColor
*/
Expand Down Expand Up @@ -1411,8 +1410,6 @@ export interface CoreChartOptions extends ParsingOptions {
layout: {
padding: Scriptable<number | ChartArea, ScriptableContext>;
};

plugins: PluginOptions;
}

export type EasingFunction =
Expand Down Expand Up @@ -1558,7 +1555,7 @@ export interface VisualElement {
getRange?(axis: 'x' | 'y'): number;
}

export interface CommonOptions {
export interface CommonElementOptions {
borderWidth: number;
borderColor: Color;
backgroundColor: Color;
Expand Down Expand Up @@ -1586,7 +1583,7 @@ export interface ArcProps {
circumference: number;
}

export interface ArcOptions extends CommonOptions {
export interface ArcOptions extends CommonElementOptions {
/**
* Arc stroke alignment.
*/
Expand All @@ -1612,7 +1609,7 @@ export const ArcElement: ChartComponent & {

export interface LineProps {}

export interface LineOptions extends CommonOptions {
export interface LineOptions extends CommonElementOptions {
/**
* Line cap style. See MDN.
* @default 'butt'
Expand Down Expand Up @@ -1699,7 +1696,7 @@ export type PointStyle =
| HTMLImageElement
| HTMLCanvasElement;

export interface PointOptions extends CommonOptions {
export interface PointOptions extends CommonElementOptions {
/**
* Point radius
* @default 3
Expand Down Expand Up @@ -1800,7 +1797,7 @@ export interface BarProps {
height: number;
}

export interface BarOptions extends CommonOptions {
export interface BarOptions extends CommonElementOptions {
/**
* The base value for the bar in data units along the value axis.
*/
Expand Down Expand Up @@ -1840,14 +1837,14 @@ export const BarElement: ChartComponent & {
new (cfg: any): BarElement;
};

export interface ElementOptions {
export interface ElementOptionsByType {
arc: ArcOptions & ArcHoverOptions;
bar: BarOptions & BarHoverOptions;
line: LineOptions & LineHoverOptions;
point: PointOptions & PointHoverOptions;
}
export interface ElementChartOptions {
elements: ElementOptions;
elements: Partial<ElementOptionsByType>;
}

export class BasePlatform {
Expand Down Expand Up @@ -2479,12 +2476,16 @@ export interface TooltipItem {
element: Element;
}

export interface PluginOptions {
export interface PluginOptionsByType {
filler: FillerOptions;
legend: LegendOptions;
title: TitleOptions;
tooltip: TooltipOptions;
}
export interface PluginChartOptions {
Comment thread
etimberg marked this conversation as resolved.
plugins: Partial<PluginOptionsByType>;
}

export interface GridLineOptions {
/**
* @default true
Expand Down Expand Up @@ -3122,7 +3123,7 @@ export interface ChartTypeRegistry {

export type ChartType = keyof ChartTypeRegistry;

export type ScaleOptions<TScale extends ScaleType = ScaleType> = DeepPartial<
export type ScaleOptionsByType<TScale extends ScaleType = ScaleType> = DeepPartial<
{ [key in ScaleType]: { type: key } & ScaleTypeRegistry[key]['options'] }[TScale]
>;

Expand All @@ -3134,13 +3135,14 @@ export type DatasetChartOptions<TType extends ChartType = ChartType> = {

export type ScaleChartOptions<TType extends ChartType = ChartType> = {
scales: {
[key: string]: ScaleOptions<ChartTypeRegistry[TType]['scales']>;
[key: string]: ScaleOptionsByType<ChartTypeRegistry[TType]['scales']>;
};
};

export type ChartOptions<TType extends ChartType = ChartType> = DeepPartial<
CoreChartOptions &
ElementChartOptions &
PluginChartOptions &
DatasetChartOptions<TType> &
ScaleChartOptions<TType> &
ChartTypeRegistry[TType]['chartOptions']
Expand Down