Merge pull request #189 from sgratzl/release/v4.2.4

Release v4.2.4
sgratzl · Jul 13, 2023 · 7bb0bef · 7bb0bef
2 parents a6fbc35 + f2edb2d
commit 7bb0bef
Show file tree

Hide file tree

Showing 9 changed files with 728 additions and 719 deletions.
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "chartjs-chart-geo",
   "description": "Chart.js module for charting maps",
-  "version": "4.2.3",
+  "version": "4.2.4",
   "author": {
     "name": "Samuel Gratzl",
     "email": "[email protected]",

diff --git a/src/controllers/BubbleMapController.ts b/src/controllers/BubbleMapController.ts
@@ -107,7 +107,7 @@ export class BubbleMapController extends GeoController<'bubbleMap', MyPointEleme
   static readonly id = 'bubbleMap';
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly defaults: any = /* #__PURE__ */ merge({}, [
     geoDefaults,
@@ -120,7 +120,7 @@ export class BubbleMapController extends GeoController<'bubbleMap', MyPointEleme
   ]);
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly overrides: any = /* #__PURE__ */ merge({}, [
     geoOverrides,

diff --git a/src/controllers/ChoroplethController.ts b/src/controllers/ChoroplethController.ts
@@ -94,7 +94,7 @@ export class ChoroplethController extends GeoController<'choropleth', GeoFeature
   static readonly id = 'choropleth';
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly defaults: any = /* #__PURE__ */ merge({}, [
     geoDefaults,
@@ -105,7 +105,7 @@ export class ChoroplethController extends GeoController<'choropleth', GeoFeature
   ]);
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly overrides: any = /* #__PURE__ */ merge({}, [
     geoOverrides,

diff --git a/src/elements/GeoFeature.ts b/src/elements/GeoFeature.ts
@@ -65,7 +65,7 @@ export interface IGeoFeatureProps {
 
 export class GeoFeature extends Element<IGeoFeatureProps, IGeoFeatureOptions> implements VisualElement {
   /**
-   * @internal
+   * @hidden
    */
   cache?:
     | {
@@ -84,27 +84,27 @@ export class GeoFeature extends Element<IGeoFeatureProps, IGeoFeatureOptions> im
     | undefined = undefined;
 
   /**
-   * @internal
+   * @hidden
    */
   projectionScale!: ProjectionScale;
 
   /**
-   * @internal
+   * @hidden
    */
   feature!: Feature;
 
   /**
-   * @internal
+   * @hidden
    */
   center?: { longitude: number; latitude: number };
 
   /**
-   * @internal
+   * @hidden
    */
   pixelRatio?: number;
 
   /**
-   * @internal
+   * @hidden
    */
   inRange(mouseX: number, mouseY: number): boolean {
     const bb = this.getBounds();
@@ -123,21 +123,21 @@ export class GeoFeature extends Element<IGeoFeatureProps, IGeoFeatureOptions> im
   }
 
   /**
-   * @internal
+   * @hidden
    */
   inXRange(mouseX: number): boolean {
     return this.inRange(mouseX, Number.NaN);
   }
 
   /**
-   * @internal
+   * @hidden
    */
   inYRange(mouseY: number): boolean {
     return this.inRange(Number.NaN, mouseY);
   }
 
   /**
-   * @internal
+   * @hidden
    */
   getCenterPoint(): { x: number; y: number } {
     if (this.cache && this.cache.center) {
@@ -162,7 +162,7 @@ export class GeoFeature extends Element<IGeoFeatureProps, IGeoFeatureOptions> im
   }
 
   /**
-   * @internal
+   * @hidden
    */
   getBounds(): { x: number; y: number; x2: number; y2: number; width: number; height: number } {
     if (this.cache && this.cache.bounds) {
@@ -182,7 +182,7 @@ export class GeoFeature extends Element<IGeoFeatureProps, IGeoFeatureOptions> im
   }
 
   /**
-   * @internal
+   * @hidden
    */
   _drawInCache(doc: Document): void {
     const bounds = this.getBounds();
@@ -217,15 +217,15 @@ export class GeoFeature extends Element<IGeoFeatureProps, IGeoFeatureOptions> im
   }
 
   /**
-   * @internal
+   * @hidden
    */
   _optionsToKey(): string {
     const { options } = this;
     return `${options.backgroundColor};${options.borderColor};${options.borderWidth};${this.pixelRatio}`;
   }
 
   /**
-   * @internal
+   * @hidden
    */
   _drawImpl(ctx: CanvasRenderingContext2D): void {
     const { feature } = this;
@@ -244,7 +244,7 @@ export class GeoFeature extends Element<IGeoFeatureProps, IGeoFeatureOptions> im
   }
 
   /**
-   * @internal
+   * @hidden
    */
   draw(ctx: CanvasRenderingContext2D): void {
     const { feature } = this;
@@ -275,7 +275,7 @@ export class GeoFeature extends Element<IGeoFeatureProps, IGeoFeatureOptions> im
   static id = 'geoFeature';
 
   /**
-   * @internal
+   * @hidden
    */
   static defaults = /* #__PURE__ */ {
     ...BarElement.defaults,
@@ -287,7 +287,7 @@ export class GeoFeature extends Element<IGeoFeatureProps, IGeoFeatureOptions> im
   };
 
   /**
-   * @internal
+   * @hidden
    */
   static defaultRoutes = /* #__PURE__ */ {
     outlineBorderColor: 'borderColor',

diff --git a/src/scales/ColorScale.ts b/src/scales/ColorScale.ts
@@ -179,7 +179,7 @@ const colorScaleDefaults = {
 
 export class ColorScale extends LegendScale<IColorScaleOptions & LinearScaleOptions> {
   /**
-   * @internal
+   * @hidden
    */
   get interpolate(): (v: number) => string {
     const o = this.options as IColorScaleOptions & LinearScaleOptions;
@@ -193,7 +193,7 @@ export class ColorScale extends LegendScale<IColorScaleOptions & LinearScaleOpti
   }
 
   /**
-   * @internal
+   * @hidden
    */
   getColorForValue(value: number): string {
     const v = this._getNormalizedValue(value);
@@ -204,7 +204,7 @@ export class ColorScale extends LegendScale<IColorScaleOptions & LinearScaleOpti
   }
 
   /**
-   * @internal
+   * @hidden
    */
   getColor(normalized: number): string {
     let v = normalized;
@@ -215,7 +215,7 @@ export class ColorScale extends LegendScale<IColorScaleOptions & LinearScaleOpti
   }
 
   /**
-   * @internal
+   * @hidden
    */
   _drawIndicator(): void {
     const { indicatorWidth: indicatorSize } = this.options.legend;
@@ -261,12 +261,12 @@ export class ColorScale extends LegendScale<IColorScaleOptions & LinearScaleOpti
   static readonly id = 'color';
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly defaults: any = /* #__PURE__ */ merge({}, [LinearScale.defaults, baseDefaults, colorScaleDefaults]);
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly descriptors = /* #__PURE__ */ {
     _scriptable: (name: string): boolean => name !== 'interpolate',
@@ -278,7 +278,7 @@ export class ColorLogarithmicScale extends LogarithmicLegendScale<IColorScaleOpt
   private interpolate = (v: number) => `rgb(${v},${v},${v})`;
 
   /**
-   * @internal
+   * @hidden
    */
   init(options: IColorScaleOptions & LinearScaleOptions): void {
     super.init(options);
@@ -290,14 +290,14 @@ export class ColorLogarithmicScale extends LogarithmicLegendScale<IColorScaleOpt
   }
 
   /**
-   * @internal
+   * @hidden
    */
   getColorForValue(value: number): string {
     return ColorScale.prototype.getColorForValue.call(this, value);
   }
 
   /**
-   * @internal
+   * @hidden
    */
   getColor(normalized: number): string {
     let v = normalized;
@@ -314,7 +314,7 @@ export class ColorLogarithmicScale extends LogarithmicLegendScale<IColorScaleOpt
   static readonly id = 'colorLogarithmic';
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly defaults: any = /* #__PURE__ */ merge({}, [
     LogarithmicScale.defaults,
@@ -323,7 +323,7 @@ export class ColorLogarithmicScale extends LogarithmicLegendScale<IColorScaleOpt
   ]);
 
   /**
-   * @internal
+   * @hidden
    */
   static readonly descriptors = /* #__PURE__ */ {
     _scriptable: (name: string): boolean => name !== 'interpolate',

diff --git a/src/scales/LegendScale.ts b/src/scales/LegendScale.ts
@@ -147,12 +147,12 @@ function computeLegendPosition(
 
 export class LegendScale<O extends ILegendScaleOptions & LinearScaleOptions> extends LinearScale<O> {
   /**
-   * @internal
+   * @hidden
    */
   legendSize: { w: number; h: number } = { w: 0, h: 0 };
 
   /**
-   * @internal
+   * @hidden
    */
   init(options: O): void {
     // eslint-disable-next-line no-param-reassign
@@ -162,7 +162,7 @@ export class LegendScale<O extends ILegendScaleOptions & LinearScaleOptions> ext
   }
 
   /**
-   * @internal
+   * @hidden
    */
   // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
   parse(raw: any, index: number): number {
@@ -173,7 +173,7 @@ export class LegendScale<O extends ILegendScaleOptions & LinearScaleOptions> ext
   }
 
   /**
-   * @internal
+   * @hidden
    */
   isHorizontal(): boolean {
     return this.options.legend.align === 'top' || this.options.legend.align === 'bottom';
@@ -187,7 +187,7 @@ export class LegendScale<O extends ILegendScaleOptions & LinearScaleOptions> ext
   }
 
   /**
-   * @internal
+   * @hidden
    */
   update(maxWidth: number, maxHeight: number, margins: ChartArea): void {
     const ch = Math.min(maxHeight, this.bottom == null ? Number.POSITIVE_INFINITY : this.bottom);
@@ -214,15 +214,15 @@ export class LegendScale<O extends ILegendScaleOptions & LinearScaleOptions> ext
   }
 
   /**
-   * @internal
+   * @hidden
    */
   // eslint-disable-next-line class-methods-use-this
   _computeLabelArea(): void {
     return undefined;
   }
 
   /**
-   * @internal
+   * @hidden
    */
   draw(chartArea: ChartArea): void {
     if (!(this as any)._isVisible()) {
@@ -258,7 +258,7 @@ export class LegendScale<O extends ILegendScaleOptions & LinearScaleOptions> ext
   }
 
   /**
-   * @internal
+   * @hidden
    */
   // eslint-disable-next-line class-methods-use-this
   protected _drawIndicator(): void {
@@ -270,27 +270,27 @@ export class LogarithmicLegendScale<
   O extends ILegendScaleOptions & LogarithmicScaleOptions
 > extends LogarithmicScale<O> {
   /**
-   * @internal
+   * @hidden
    */
   legendSize: { w: number; h: number } = { w: 0, h: 0 };
 
   /**
-   * @internal
+   * @hidden
    */
   init(options: O): void {
     LegendScale.prototype.init.call(this, options);
   }
 
   /**
-   * @internal
+   * @hidden
    */
   // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
   parse(raw: any, index: number): number {
     return LegendScale.prototype.parse.call(this, raw, index);
   }
 
   /**
-   * @internal
+   * @hidden
    */
   isHorizontal(): boolean {
     return this.options.legend.align === 'top' || this.options.legend.align === 'bottom';
@@ -304,22 +304,22 @@ export class LogarithmicLegendScale<
   }
 
   /**
-   * @internal
+   * @hidden
    */
   update(maxWidth: number, maxHeight: number, margins: ChartArea): void {
     return LegendScale.prototype.update.call(this, maxWidth, maxHeight, margins);
   }
 
   /**
-   * @internal
+   * @hidden
    */
   // eslint-disable-next-line class-methods-use-this
   _computeLabelArea(): void {
     return undefined;
   }
 
   /**
-   * @internal
+   * @hidden
    */
   draw(chartArea: ChartArea): void {
     return LegendScale.prototype.draw.call(this, chartArea);