]> git.ipfire.org Git - thirdparty/Chart.js.git/commitdiff
Rename uppercase types to camel case (#8074)
authorEvert Timberg <evert.timberg+github@gmail.com>
Thu, 19 Nov 2020 13:10:26 +0000 (08:10 -0500)
committerGitHub <noreply@github.com>
Thu, 19 Nov 2020 13:10:26 +0000 (08:10 -0500)
* Rename uppercase types to camel case

* Rename SCALES to TScale
Reanme DSE to TDatasetElement
Rename E to TElement

types/core/index.d.ts
types/interfaces.d.ts

index e71e7375973d33732cd8c1ec1e6f586dabccbe7d..4691cf1eaebd3b172e5c0731f08833a996421973 100644 (file)
@@ -125,7 +125,7 @@ export class Animations {
        update(target: any, values: any): undefined | boolean;
 }
 
-export interface ChartMeta<E extends Element = Element, DSE extends Element = Element> {
+export interface ChartMeta<TElement extends Element = Element, TDatasetElement extends Element = Element> {
        type: string;
        controller: DatasetController;
        order: number;
@@ -138,8 +138,8 @@ export interface ChartMeta<E extends Element = Element, DSE extends Element = El
 
        indexAxis: 'x' | 'y';
 
-       data: E[];
-       dataset?: DSE;
+       data: TElement[];
+       dataset?: TDatasetElement;
 
        hidden: boolean;
 
@@ -170,15 +170,15 @@ export interface ActiveElement extends ActiveDataPoint {
 }
 
 export declare class Chart<
-       TYPE extends ChartType = ChartType,
-       DATA extends unknown[] = DefaultDataPoint<TYPE>,
-       LABEL = unknown
+       TType extends ChartType = ChartType,
+       TData extends unknown[] = DefaultDataPoint<TType>,
+       TLabel = unknown
        > {
        readonly platform: BasePlatform;
        readonly id: string;
        readonly canvas: HTMLCanvasElement;
        readonly ctx: CanvasRenderingContext2D;
-       readonly config: ChartConfiguration<TYPE, DATA, LABEL>
+       readonly config: ChartConfiguration<TType, TData, TLabel>
        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<TYPE, DATA, LABEL>;
-       options: ChartOptions<TYPE>;
+       data: ChartData<TType, TData, TLabel>;
+       options: ChartOptions<TType>;
 
-       constructor(item: ChartItem, config: ChartConfiguration<TYPE, DATA, LABEL>);
+       constructor(item: ChartItem, config: ChartConfiguration<TType, TData, TLabel>);
 
        clear(): this;
        stop(): this;
@@ -256,25 +256,25 @@ export declare enum UpdateModeEnum {
 
 export type UpdateMode = keyof typeof UpdateModeEnum;
 
-export class DatasetController<E extends Element = Element, DSE extends Element = Element> {
+export class DatasetController<TElement extends Element = Element, TDatasetElement extends Element = Element> {
        constructor(chart: Chart, datasetIndex: number);
 
        readonly chart: Chart;
        readonly index: number;
-       readonly _cachedMeta: ChartMeta<E, DSE>;
+       readonly _cachedMeta: ChartMeta<TElement, TDatasetElement>;
        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<E, DSE>;
+       getMeta(): ChartMeta<TElement, TDatasetElement>;
        getScaleForId(scaleID: string): Scale | undefined;
        configure(): void;
        initialize(): void;
@@ -299,20 +299,20 @@ export class DatasetController<E extends Element = Element, DSE extends Element
         * @protected
         */
 
-       protected updateElement(element: E | DSE, index: number | undefined, properties: any, mode: UpdateMode): void;
+       protected updateElement(element: TElement | TDatasetElement, index: number | undefined, properties: any, mode: UpdateMode): void;
        /**
         * Utility to animate the shared options, that are potentially affecting multiple elements.
         * @protected
         */
 
        protected updateSharedOptions(sharedOptions: any, mode: UpdateMode, newOptions: any): void;
-       removeHoverStyle(element: E, datasetIndex: number, index: number): void;
-       setHoverStyle(element: E, datasetIndex: number, index: number): void;
+       removeHoverStyle(element: TElement, datasetIndex: number, index: number): void;
+       setHoverStyle(element: TElement, datasetIndex: number, index: number): void;
 
        parse(start: number, count: number): void;
-       protected parsePrimitiveData(meta: ChartMeta<E, DSE>, data: any[], start: number, count: number): any[];
-       protected parseArrayData(meta: ChartMeta<E, DSE>, data: any[], start: number, count: number): any[];
-       protected parseObjectData(meta: ChartMeta<E, DSE>, data: any[], start: number, count: number): any[];
+       protected parsePrimitiveData(meta: ChartMeta<TElement, TDatasetElement>, data: any[], start: number, count: number): any[];
+       protected parseArrayData(meta: ChartMeta<TElement, TDatasetElement>, data: any[], start: number, count: number): any[];
+       protected parseObjectData(meta: ChartMeta<TElement, TDatasetElement>, data: any[], start: number, count: number): any[];
        protected getParsed(index: number): any;
        protected applyStack(scale: Scale, parsed: any[]): number;
        protected updateRangeFromParsed(
index 81e33f05b3017833b697b3a81941dd98217490a8..2ac3eea0232a1445dcb468f1aac8a497f35013e7 100644 (file)
@@ -122,63 +122,63 @@ export interface ChartTypeRegistry {
 
 export type ChartType = keyof ChartTypeRegistry;
 
-export type ScaleOptions<SCALES extends ScaleType = ScaleType> = DeepPartial<
-  { [key in ScaleType]: { type: key } & ScaleTypeRegistry[key]['options'] }[SCALES]
+export type ScaleOptions<TScale extends ScaleType = ScaleType> = DeepPartial<
+  { [key in ScaleType]: { type: key } & ScaleTypeRegistry[key]['options'] }[TScale]
 >;
 
-export type DatasetChartOptions<TYPE extends ChartType = ChartType> = {
-  [key in TYPE]: {
+export type DatasetChartOptions<TType extends ChartType = ChartType> = {
+  [key in TType]: {
     datasets: ChartTypeRegistry[key]['datasetOptions'];
   };
 };
 
-export type ScaleChartOptions<TYPE extends ChartType = ChartType> = {
+export type ScaleChartOptions<TType extends ChartType = ChartType> = {
   scales: {
-    [key: string]: ScaleOptions<ChartTypeRegistry[TYPE]['scales']>;
+    [key: string]: ScaleOptions<ChartTypeRegistry[TType]['scales']>;
   };
 };
 
-export type ChartOptions<TYPE extends ChartType = ChartType> = DeepPartial<
+export type ChartOptions<TType extends ChartType = ChartType> = DeepPartial<
   CoreChartOptions &
   PluginChartOptions &
   ElementChartOptions &
-  DatasetChartOptions<TYPE> &
-  ScaleChartOptions<TYPE> &
-  ChartTypeRegistry[TYPE]['chartOptions']
+  DatasetChartOptions<TType> &
+  ScaleChartOptions<TType> &
+  ChartTypeRegistry[TType]['chartOptions']
 >;
 
-export type DefaultDataPoint<TYPE extends ChartType> = ChartType extends TYPE ? unknown[] : DistributiveArray<
-  ChartTypeRegistry[TYPE]['defaultDataPoint']
+export type DefaultDataPoint<TType extends ChartType> = ChartType extends TType ? unknown[] : DistributiveArray<
+  ChartTypeRegistry[TType]['defaultDataPoint']
 >;
 
-export interface ChartDatasetProperties<TYPE extends ChartType, DATA extends unknown[]> {
-  type?: TYPE;
-  data: DATA;
+export interface ChartDatasetProperties<TType extends ChartType, TData extends unknown[]> {
+  type?: TType;
+  data: TData;
 }
 
 export type ChartDataset<
-  TYPE extends ChartType = ChartType,
-  DATA extends unknown[] = DefaultDataPoint<TYPE>
+  TType extends ChartType = ChartType,
+  TData extends unknown[] = DefaultDataPoint<TType>
 > = DeepPartial<
-  { [key in ChartType]: { type: key } & ChartTypeRegistry[key]['datasetOptions'] }[TYPE]
-> & ChartDatasetProperties<TYPE, DATA>;
+  { [key in ChartType]: { type: key } & ChartTypeRegistry[key]['datasetOptions'] }[TType]
+> & ChartDatasetProperties<TType, TData>;
 
 export interface ChartData<
-  TYPE extends ChartType = ChartType,
-  DATA extends unknown[] = DefaultDataPoint<TYPE>,
-  LABEL = unknown
+  TType extends ChartType = ChartType,
+  TData extends unknown[] = DefaultDataPoint<TType>,
+  TLabel = unknown
 > {
-  labels: LABEL[];
-  datasets: ChartDataset<TYPE, DATA>[];
+  labels: TLabel[];
+  datasets: ChartDataset<TType, TData>[];
 }
 
 export interface ChartConfiguration<
-  TYPE extends ChartType = ChartType,
-  DATA extends unknown[] = DefaultDataPoint<TYPE>,
-  LABEL = unknown
+  TType extends ChartType = ChartType,
+  TData extends unknown[] = DefaultDataPoint<TType>,
+  TLabel = unknown
 > {
-  type: TYPE;
-  data: ChartData<TYPE, DATA, LABEL>;
-  options?: ChartOptions<TYPE>;
+  type: TType;
+  data: ChartData<TType, TData, TLabel>;
+  options?: ChartOptions<TType>;
   plugins?: Plugin[];
 }