Merge pull request #71 from sgratzl/sgratzl/hidden

fix: internal to hidden
sgratzl · Jul 13, 2023 · bec8063 · bec8063
2 parents d1f9d46 + b8d6edf
commit bec8063
Show file tree

Hide file tree

Showing 8 changed files with 702 additions and 693 deletions.
diff --git a/src/controllers/BarWithErrorBarsController.ts b/src/controllers/BarWithErrorBarsController.ts
@@ -33,14 +33,14 @@ import patchController from './patchController';
 
 export class BarWithErrorBarsController extends BarController {
   /**
-   * @internal
+   * @hidden
    */
   getMinMax(scale: Scale, canStack: boolean): { min: number; max: number } {
     return getMinMax(scale, (patchedScale) => super.getMinMax(patchedScale, canStack));
   }
 
   /**
-   * @internal
+   * @hidden
    */
   protected parsePrimitiveData(meta: ChartMeta, data: any[], start: number, count: number): Record<string, unknown>[] {
     const parsed = super.parsePrimitiveData(meta, data, start, count);
@@ -49,7 +49,7 @@ export class BarWithErrorBarsController extends BarController {
   }
 
   /**
-   * @internal
+   * @hidden
    */
   protected parseObjectData(meta: ChartMeta, data: any[], start: number, count: number): Record<string, unknown>[] {
     const parsed = super.parseObjectData(meta, data, start, count);
@@ -71,7 +71,7 @@ export class BarWithErrorBarsController extends BarController {
   }
 
   /**
-   * @internal
+   * @hidden
    */
   updateElement(
     element: Element,
@@ -95,7 +95,7 @@ export class BarWithErrorBarsController extends BarController {
   static readonly id = 'barWithErrorBars';
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly defaults: any = /* #__PURE__ */ merge({}, [
     BarController.defaults,
@@ -106,7 +106,7 @@ export class BarWithErrorBarsController extends BarController {
   ]);
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly overrides: any = /* #__PURE__ */ merge({}, [
     (BarController as any).overrides,
@@ -122,7 +122,7 @@ export class BarWithErrorBarsController extends BarController {
   ]);
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly defaultRoutes = BarController.defaultRoutes;
 }

diff --git a/src/controllers/LineWithErrorBarsController.ts b/src/controllers/LineWithErrorBarsController.ts
@@ -35,14 +35,14 @@ const NUMERIC_SCALE_TYPES = ['linear', 'logarithmic', 'time', 'timeseries'];
 
 export class LineWithErrorBarsController extends LineController {
   /**
-   * @internal
+   * @hidden
    */
   getMinMax(scale: Scale, canStack: boolean): { min: number; max: number } {
     return getMinMax(scale, (patchedScale) => super.getMinMax(patchedScale, canStack));
   }
 
   /**
-   * @internal
+   * @hidden
    */
   protected parsePrimitiveData(meta: ChartMeta, data: any[], start: number, count: number): Record<string, unknown>[] {
     const parsed = super.parsePrimitiveData(meta, data, start, count);
@@ -51,7 +51,7 @@ export class LineWithErrorBarsController extends LineController {
   }
 
   /**
-   * @internal
+   * @hidden
    */
   protected parseObjectData(meta: ChartMeta, data: any[], start: number, count: number): Record<string, unknown>[] {
     const parsed = super.parseObjectData(meta, data, start, count);
@@ -60,7 +60,7 @@ export class LineWithErrorBarsController extends LineController {
   }
 
   /**
-   * @internal
+   * @hidden
    */
   private parseErrorData(
     parsed: Record<string, unknown>[],
@@ -82,7 +82,7 @@ export class LineWithErrorBarsController extends LineController {
   }
 
   /**
-   * @internal
+   * @hidden
    */
   updateElement(
     element: Element,
@@ -98,7 +98,7 @@ export class LineWithErrorBarsController extends LineController {
   }
 
   /**
-   * @internal
+   * @hidden
    */
   protected updateElementScale(index: number, properties: Record<string, unknown>, mode: UpdateMode): void {
     // inject the other error bar related properties
@@ -124,7 +124,7 @@ export class LineWithErrorBarsController extends LineController {
   }
 
   /**
-   * @internal
+   * @hidden
    */
   updateElements(points: Element[], start: number, count: number, mode: UpdateMode) {
     const reset = mode === 'reset';
@@ -149,7 +149,7 @@ export class LineWithErrorBarsController extends LineController {
   static readonly id = 'lineWithErrorBars';
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly defaults: any = /* #__PURE__ */ merge({}, [
     LineController.defaults,
@@ -160,7 +160,7 @@ export class LineWithErrorBarsController extends LineController {
   ]);
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly overrides: any = /* #__PURE__ */ merge({}, [
     (LineController as any).overrides,
@@ -176,7 +176,7 @@ export class LineWithErrorBarsController extends LineController {
   ]);
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly defaultRoutes = LineController.defaultRoutes;
 }

diff --git a/src/controllers/PolarAreaWithErrorBarsController.ts b/src/controllers/PolarAreaWithErrorBarsController.ts
@@ -25,7 +25,7 @@ import patchController from './patchController';
 
 export class PolarAreaWithErrorBarsController extends PolarAreaController {
   /**
-   * @internal
+   * @hidden
    */
   getMinMaxImpl(scale: Scale) {
     // new version doesn't use scale.axis wrongly
@@ -50,14 +50,14 @@ export class PolarAreaWithErrorBarsController extends PolarAreaController {
   }
 
   /**
-   * @internal
+   * @hidden
    */
   getMinMax(scale: Scale): { min: number; max: number } {
     return getMinMax(scale, (patchedScale) => this.getMinMaxImpl(patchedScale));
   }
 
   /**
-   * @internal
+   * @hidden
    */
   countVisibleElements(): number {
     const meta = this._cachedMeta;
@@ -120,7 +120,7 @@ export class PolarAreaWithErrorBarsController extends PolarAreaController {
   }
 
   /**
-   * @internal
+   * @hidden
    */
   updateElement(
     element: Element,
@@ -141,7 +141,7 @@ export class PolarAreaWithErrorBarsController extends PolarAreaController {
   }
 
   /**
-   * @internal
+   * @hidden
    */
   updateElements(arcs: Element[], start: number, count: number, mode: UpdateMode): void {
     const scale = this.chart.scales.r as RadialLinearScale;
@@ -159,7 +159,7 @@ export class PolarAreaWithErrorBarsController extends PolarAreaController {
   static readonly id = 'polarAreaWithErrorBars';
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly defaults: any = /* #__PURE__ */ merge({}, [
     PolarAreaController.defaults,
@@ -170,7 +170,7 @@ export class PolarAreaWithErrorBarsController extends PolarAreaController {
   ]);
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly overrides: any = /* #__PURE__ */ merge({}, [
     (PolarAreaController as any).overrides,
@@ -186,7 +186,7 @@ export class PolarAreaWithErrorBarsController extends PolarAreaController {
   ]);
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly defaultRoutes = PolarAreaController.defaultRoutes;
 }

diff --git a/src/controllers/ScatterWithErrorBarsController.ts b/src/controllers/ScatterWithErrorBarsController.ts
@@ -26,7 +26,7 @@ import patchController from './patchController';
 
 export class ScatterWithErrorBarsController extends ScatterController {
   /**
-   * @internal
+   * @hidden
    */
   getMinMax(scale: Scale, canStack: boolean): { min: number; max: number } {
     return getMinMax(scale, (patchedScale) => super.getMinMax(patchedScale, canStack));
@@ -58,7 +58,7 @@ export class ScatterWithErrorBarsController extends ScatterController {
   }
 
   /**
-   * @internal
+   * @hidden
    */
   updateElement(
     element: Element,
@@ -92,7 +92,7 @@ export class ScatterWithErrorBarsController extends ScatterController {
   }
 
   /**
-   * @internal
+   * @hidden
    */
   updateElements(points: Element[], start: number, count: number, mode: UpdateMode) {
     const reset = mode === 'reset';
@@ -117,7 +117,7 @@ export class ScatterWithErrorBarsController extends ScatterController {
   static readonly id = 'scatterWithErrorBars';
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly defaults: any = /* #__PURE__ */ merge({}, [
     ScatterController.defaults,
@@ -128,7 +128,7 @@ export class ScatterWithErrorBarsController extends ScatterController {
   ]);
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly overrides: any = /* #__PURE__ */ merge({}, [
     (ScatterController as any).overrides,
@@ -144,7 +144,7 @@ export class ScatterWithErrorBarsController extends ScatterController {
   ]);
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly defaultRoutes = LineController.defaultRoutes;
 }

diff --git a/src/elements/ArcWithErrorBar.ts b/src/elements/ArcWithErrorBar.ts
@@ -10,7 +10,7 @@ import { renderErrorBarArc, errorBarDefaults, errorBarDescriptors, IErrorBarOpti
 
 export default class ArcWithErrorBar extends ArcElement {
   /**
-   * @internal
+   * @hidden
    */
   draw(ctx: CanvasRenderingContext2D): void {
     super.draw(ctx);
@@ -21,17 +21,17 @@ export default class ArcWithErrorBar extends ArcElement {
   static readonly id = 'arcWithErrorBar';
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly defaults: any = /* #__PURE__ */ { ...ArcElement.defaults, ...errorBarDefaults };
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly defaultRoutes = ArcElement.defaultRoutes;
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly descriptors = errorBarDescriptors;
 }

diff --git a/src/elements/BarWithErrorBar.ts b/src/elements/BarWithErrorBar.ts
@@ -10,7 +10,7 @@ import { renderErrorBar, errorBarDefaults, errorBarDescriptors, IErrorBarOptions
 
 export default class BarWithErrorBar extends BarElement {
   /**
-   * @internal
+   * @hidden
    */
   draw(ctx: CanvasRenderingContext2D): void {
     super.draw(ctx);
@@ -21,17 +21,17 @@ export default class BarWithErrorBar extends BarElement {
   static readonly id = 'barWithErrorBar';
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly defaults: any = /* #__PURE__ */ { ...BarElement.defaults, ...errorBarDefaults };
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly defaultRoutes = BarElement.defaultRoutes;
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly descriptors = errorBarDescriptors;
 }

diff --git a/src/elements/PointWithErrorBar.ts b/src/elements/PointWithErrorBar.ts
@@ -10,7 +10,7 @@ import { renderErrorBar, errorBarDefaults, errorBarDescriptors, IErrorBarOptions
 
 export default class PointWithErrorBar extends PointElement {
   /**
-   * @internal
+   * @hidden
    */
   // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
   draw(ctx: CanvasRenderingContext2D, area?: any): void {
@@ -22,17 +22,17 @@ export default class PointWithErrorBar extends PointElement {
   static readonly id = 'pointWithErrorBar';
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly defaults: any = /* #__PURE__ */ { ...PointElement.defaults, ...errorBarDefaults };
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly defaultRoutes = PointElement.defaultRoutes;
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly descriptors = errorBarDescriptors;
 }