From 85fc6cc49ce4b2728a76a455c47fcec2bce161a2 Mon Sep 17 00:00:00 2001 From: Evert Timberg Date: Thu, 19 Nov 2020 08:10:26 -0500 Subject: [PATCH] Rename uppercase types to camel case (#8074) * Rename uppercase types to camel case * Rename SCALES to TScale Reanme DSE to TDatasetElement Rename E to TElement --- types/core/index.d.ts | 40 ++++++++++++++--------------- types/interfaces.d.ts | 60 +++++++++++++++++++++---------------------- 2 files changed, 50 insertions(+), 50 deletions(-) diff --git a/types/core/index.d.ts b/types/core/index.d.ts index e71e73759..4691cf1ea 100644 --- a/types/core/index.d.ts +++ b/types/core/index.d.ts @@ -125,7 +125,7 @@ export class Animations { update(target: any, values: any): undefined | boolean; } -export interface ChartMeta { +export interface ChartMeta { type: string; controller: DatasetController; order: number; @@ -138,8 +138,8 @@ export interface ChartMeta, - LABEL = unknown + TType extends ChartType = ChartType, + TData extends unknown[] = DefaultDataPoint, + TLabel = unknown > { readonly platform: BasePlatform; readonly id: string; readonly canvas: HTMLCanvasElement; readonly ctx: CanvasRenderingContext2D; - readonly config: ChartConfiguration + readonly config: ChartConfiguration readonly width: number; readonly height: number; readonly aspectRatio: number; @@ -189,10 +189,10 @@ export declare class Chart< readonly scale: Scale | undefined; readonly attached: boolean; - data: ChartData; - options: ChartOptions; + data: ChartData; + options: ChartOptions; - constructor(item: ChartItem, config: ChartConfiguration); + constructor(item: ChartItem, config: ChartConfiguration); clear(): this; stop(): this; @@ -256,25 +256,25 @@ export declare enum UpdateModeEnum { export type UpdateMode = keyof typeof UpdateModeEnum; -export class DatasetController { +export class DatasetController { constructor(chart: Chart, datasetIndex: number); readonly chart: Chart; readonly index: number; - readonly _cachedMeta: ChartMeta; + readonly _cachedMeta: ChartMeta; enableOptionSharing: boolean; linkScales(): void; getAllParsedValues(scale: Scale): number[]; protected getLabelAndValue(index: number): { label: string; value: string }; - updateElements(elements: E[], start: number, count: number, mode: UpdateMode): void; + updateElements(elements: TElement[], start: number, count: number, mode: UpdateMode): void; update(mode: UpdateMode): void; updateIndex(datasetIndex: number): void; protected getMaxOverflow(): boolean | number; draw(): void; reset(): void; getDataset(): ChartDataset; - getMeta(): ChartMeta; + getMeta(): ChartMeta; getScaleForId(scaleID: string): Scale | undefined; configure(): void; initialize(): void; @@ -299,20 +299,20 @@ export class DatasetController, data: any[], start: number, count: number): any[]; - protected parseArrayData(meta: ChartMeta, data: any[], start: number, count: number): any[]; - protected parseObjectData(meta: ChartMeta, data: any[], start: number, count: number): any[]; + protected parsePrimitiveData(meta: ChartMeta, data: any[], start: number, count: number): any[]; + protected parseArrayData(meta: ChartMeta, data: any[], start: number, count: number): any[]; + protected parseObjectData(meta: ChartMeta, data: any[], start: number, count: number): any[]; protected getParsed(index: number): any; protected applyStack(scale: Scale, parsed: any[]): number; protected updateRangeFromParsed( diff --git a/types/interfaces.d.ts b/types/interfaces.d.ts index 81e33f05b..2ac3eea02 100644 --- a/types/interfaces.d.ts +++ b/types/interfaces.d.ts @@ -122,63 +122,63 @@ export interface ChartTypeRegistry { export type ChartType = keyof ChartTypeRegistry; -export type ScaleOptions = DeepPartial< - { [key in ScaleType]: { type: key } & ScaleTypeRegistry[key]['options'] }[SCALES] +export type ScaleOptions = DeepPartial< + { [key in ScaleType]: { type: key } & ScaleTypeRegistry[key]['options'] }[TScale] >; -export type DatasetChartOptions = { - [key in TYPE]: { +export type DatasetChartOptions = { + [key in TType]: { datasets: ChartTypeRegistry[key]['datasetOptions']; }; }; -export type ScaleChartOptions = { +export type ScaleChartOptions = { scales: { - [key: string]: ScaleOptions; + [key: string]: ScaleOptions; }; }; -export type ChartOptions = DeepPartial< +export type ChartOptions = DeepPartial< CoreChartOptions & PluginChartOptions & ElementChartOptions & - DatasetChartOptions & - ScaleChartOptions & - ChartTypeRegistry[TYPE]['chartOptions'] + DatasetChartOptions & + ScaleChartOptions & + ChartTypeRegistry[TType]['chartOptions'] >; -export type DefaultDataPoint = ChartType extends TYPE ? unknown[] : DistributiveArray< - ChartTypeRegistry[TYPE]['defaultDataPoint'] +export type DefaultDataPoint = ChartType extends TType ? unknown[] : DistributiveArray< + ChartTypeRegistry[TType]['defaultDataPoint'] >; -export interface ChartDatasetProperties { - type?: TYPE; - data: DATA; +export interface ChartDatasetProperties { + type?: TType; + data: TData; } export type ChartDataset< - TYPE extends ChartType = ChartType, - DATA extends unknown[] = DefaultDataPoint + TType extends ChartType = ChartType, + TData extends unknown[] = DefaultDataPoint > = DeepPartial< - { [key in ChartType]: { type: key } & ChartTypeRegistry[key]['datasetOptions'] }[TYPE] -> & ChartDatasetProperties; + { [key in ChartType]: { type: key } & ChartTypeRegistry[key]['datasetOptions'] }[TType] +> & ChartDatasetProperties; export interface ChartData< - TYPE extends ChartType = ChartType, - DATA extends unknown[] = DefaultDataPoint, - LABEL = unknown + TType extends ChartType = ChartType, + TData extends unknown[] = DefaultDataPoint, + TLabel = unknown > { - labels: LABEL[]; - datasets: ChartDataset[]; + labels: TLabel[]; + datasets: ChartDataset[]; } export interface ChartConfiguration< - TYPE extends ChartType = ChartType, - DATA extends unknown[] = DefaultDataPoint, - LABEL = unknown + TType extends ChartType = ChartType, + TData extends unknown[] = DefaultDataPoint, + TLabel = unknown > { - type: TYPE; - data: ChartData; - options?: ChartOptions; + type: TType; + data: ChartData; + options?: ChartOptions; plugins?: Plugin[]; } -- 2.47.2