Merge branch 'update-core' into 'master'

update core

See merge request chartwerk/gauge-pod!2

package.json

@@ -6,7 +6,8 @@
   "scripts": {
     "build": "webpack --config build/prod.webpack.conf.js && webpack --config build/dev.webpack.conf.js",
     "dev": "webpack --watch --config build/dev.webpack.conf.js",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "update-core": "yarn up @chartwerk/core && yarn up @chartwerk/core@latest"
   },
   "author": "CorpGlory",
   "license": "Apache-2.0",

src/index.ts

@@ -1,105 +1,40 @@
-import { GaugeTimeSerie, GaugeOptions, Stat, Stop, IconConfig, IconPosition, PointCoordinate } from './types';
-
-import { ChartwerkPod, VueChartwerkPodMixin, AxisFormat, CrosshairOrientation } from '@chartwerk/core';
+import { GaugeData, GaugeConfig, Stat, Stop, IconConfig, IconPosition, PointCoordinate } from './types';
+import { GaugeSeries } from './models/gauge_series';
+import { CORE_OPTIONS_DEFAULTS, GaugeOptions } from './models/gauge_options';
 
 import { findClosest } from './utils';
 
+import { ChartwerkPod, VueChartwerkPodMixin } from '@chartwerk/core';
+
 import * as d3 from 'd3';
 
 import * as _ from 'lodash';
 
+
 const SPACE_BETWEEN_CIRCLES = 2;
 const CIRCLES_ROUNDING = 0.25; //radians
-const BACKGROUND_COLOR = 'rgba(38, 38, 38, 0.1)';
-const DEFAULT_INNER_RADIUS = 52;
-const DEFAULT_OUTER_RADIUS = 72;
 const STOPS_CIRCLE_WIDTH = 8;
 const DEFAULT_VALUE_TEXT_FONT_SIZE = 16;
 const VALUE_TEXT_MARGIN = 10;
 const DEFAULT_ICON_SIZE = 20; //px
 
-const DEFAULT_GAUGE_OPTIONS: GaugeOptions = {
-  renderLegend: false,
-  grid: {
-    x: {
-      enabled: false
-    },
-    y: {
-      enabled: false
-    }
-  },
-  zoomEvents: {
-    mouse: {
-      zoom: {
-        isActive: false,
-      },
-      pan: {
-        isActive: false
-      },
-    },
-    scroll: {
-      zoom: {
-        isActive: false
-      },
-      pan: {
-        isActive: false,
-      }
-    },
-  },
-  axis: {
-    x: { isActive: false, format: AxisFormat.NUMERIC },
-    y: { isActive: false, format: AxisFormat.NUMERIC },
-    y1: { isActive: false, format: AxisFormat.NUMERIC },
-  },
-  margin: {
-    top: 0, bottom: 0,
-    left: 0, right: 0
-  },
-  stops: [
-    {
-      color: 'green',
-      value: 10
-    },
-    {
-      color: 'yellow',
-      value: 20
-    }
-  ],
-  crosshair: {
-    orientation: CrosshairOrientation.VERTICAL,
-    color: 'red'
-  },
-  defaultColor: 'red',
-  stat: Stat.CURRENT,
-  innerRadius: DEFAULT_INNER_RADIUS,
-  outerRadius: DEFAULT_OUTER_RADIUS,
-  icons: [],
-  valueFontSize: null,
-  valueArcBackgroundColor: BACKGROUND_COLOR,
-  reversed: false,
-  enableExtremumLabels: false,
-  enableThresholdLabels: false,
-  enableThresholdDrag: false,
-};
+export class ChartwerkGaugePod extends ChartwerkPod<GaugeData, GaugeConfig> {
+  series: GaugeSeries;
+  options: GaugeOptions;
 
-export class ChartwerkGaugePod extends ChartwerkPod<GaugeTimeSerie, GaugeOptions> {
   _draggableLines: any[] = [];
   _draggedThresholdValues: number[] = []; // threshold values after dragging
   _thresholdArc: any | null = null;
   _thresholdTextLabels: any[] = [];
 
-  constructor(el: HTMLElement, _series: GaugeTimeSerie[] = [], _options: GaugeOptions = {}) {
-    super(
-      el, _series,
-      _.defaults(_options, DEFAULT_GAUGE_OPTIONS)
-    );
+  constructor(el: HTMLElement, _series: GaugeData[] = [], _options: GaugeConfig = {}) {
+    // TODO: something better than assign?
+    super(el, _series, _.assign(_options, CORE_OPTIONS_DEFAULTS));
+    this.series = new GaugeSeries(_series);
+    this.options = new GaugeOptions(_options);
   }
 
   renderMetrics(): void {
-    if(this.series.length === 0 || this.series[0].datapoints.length === 0) {
-      this.renderNoDataPointsMessage();
-      return;
-    }
     this._renderOverlayBackground();
     this._renderValueArc();
     this._renderThresholdArc();
@@ -109,13 +44,11 @@ export class ChartwerkGaugePod extends ChartwerkPod<GaugeTimeSerie, GaugeOptions
     this._renderLabels();
   }
 
-  protected updateOptions(newOptions: GaugeOptions): void {
+  protected updateOptions(newOptions: GaugeConfig): void {
     if(newOptions === undefined) {
       return;
     }
-    let options = _.cloneDeep(newOptions);
-    _.defaultsDeep(options, DEFAULT_GAUGE_OPTIONS);
-    this.options = options;
+    this.options = new GaugeOptions(newOptions);
   }
 
   get _gaugeTransform(): string {
@@ -140,7 +73,7 @@ export class ChartwerkGaugePod extends ChartwerkPod<GaugeTimeSerie, GaugeOptions
   }
 
   private _renderIcons(): void {
-    if(this.options.icons === undefined || this.options.icons.length === 0) {
+    if(this.options.icons.length === 0) {
       return;
     }
     this.options.icons.map(icon => {
@@ -334,9 +267,7 @@ export class ChartwerkGaugePod extends ChartwerkPod<GaugeTimeSerie, GaugeOptions
     this.updateThresholdArcByNewValues(this._draggedThresholdValues);
     this.updateThresholdLabel(value, idx);
     this.onGaugeMouseMove();
-    if(this.options.dragCallback) {
-      this.options.dragCallback({ value, idx });
-    }
+    this.options.callbackDrag({ value, idx });
   }
 
   updateThresholdArcByNewValues(stops: number[]): void {
@@ -367,9 +298,7 @@ export class ChartwerkGaugePod extends ChartwerkPod<GaugeTimeSerie, GaugeOptions
 
   onDragEnd(idx: number): void {
     this.onGaugeMouseOut();
-    if(this.options.dragEndCallback) {
-      this.options.dragEndCallback({ idx });
-    }
+    this.options.callbackDragEnd({ idx });
   }
 
   getAngleFromCoordinates(x: number, y: number): number {
@@ -533,10 +462,6 @@ export class ChartwerkGaugePod extends ChartwerkPod<GaugeTimeSerie, GaugeOptions
   }
 
   private get _valueText(): string {
-    if(this.options.valueFormatter === undefined) {
-      console.log('valueFormatter function is not specified, rendering raw value');
-      return this.aggregatedValue.toString();
-    }
     return this.options.valueFormatter(this.aggregatedValue);
   }
 
@@ -604,7 +529,7 @@ export class ChartwerkGaugePod extends ChartwerkPod<GaugeTimeSerie, GaugeOptions
   private get aggregatedValue(): number {
     switch(this._stat) {
       case Stat.CURRENT:
-        return _.last(this.series[0].datapoints)[1];
+        return _.last(this.series.visibleSeries[0].datapoints)[1];
       // TODO: support other stats
       default:
         throw new Error(`Unsupported stat: ${this._stat}`);
@@ -656,7 +581,7 @@ export const VueChartwerkGaugePodObject = {
   mixins: [VueChartwerkPodMixin],
   methods: {
     render() {
-      if(this.pod === undefined) { 
+      if(this.pod === undefined) {
         this.pod = new ChartwerkGaugePod(document.getElementById(this.id), this.series, this.options);
         this.pod.render();
       } else {
@@ -666,4 +591,4 @@ export const VueChartwerkGaugePodObject = {
   }
 };
 
-export { GaugeOptions, GaugeTimeSerie, Stat };
+export { GaugeConfig, GaugeData, Stat };

src/models/gauge_options.ts

@@ -0,0 +1,169 @@
+import { GaugeConfig, IconConfig, Stat, Stop } from '../types';
+
+import { AxisFormat, CoreOptions } from '@chartwerk/core';
+
+import lodashIsNil from 'lodash/isNil';
+
+
+const BACKGROUND_COLOR = 'rgba(38, 38, 38, 0.1)';
+const DEFAULT_INNER_RADIUS = 52;
+const DEFAULT_OUTER_RADIUS = 72;
+
+export const CORE_OPTIONS_DEFAULTS = {
+  renderLegend: false,
+  // TODO: find a method in lodash (defaultsDeep?)
+  grid: {
+    x: {
+      enabled: false
+    },
+    y: {
+      enabled: false
+    }
+  },
+  zoomEvents: {
+    mouse: {
+      zoom: {
+        isActive: false,
+      },
+      pan: {
+        isActive: false
+      },
+    },
+    scroll: {
+      zoom: {
+        isActive: false
+      },
+      pan: {
+        isActive: false,
+      }
+    },
+  },
+  axis: {
+    x: { isActive: false, format: AxisFormat.NUMERIC },
+    y: { isActive: false, format: AxisFormat.NUMERIC },
+    y1: { isActive: false, format: AxisFormat.NUMERIC },
+  },
+  margin: {
+    top: 0, bottom: 0,
+    left: 0, right: 0
+  },
+}
+
+const GAUGE_OPTIONS_DEFAULTS: GaugeConfig = {
+  innerRadius: DEFAULT_INNER_RADIUS,
+  outerRadius: DEFAULT_OUTER_RADIUS,
+  stops: [
+    {
+      color: 'green',
+      value: 10
+    },
+    {
+      color: 'yellow',
+      value: 20
+    }
+  ],
+  defaultColor: 'red',
+  stat: Stat.CURRENT,
+  icons: [],
+  valueArcBackgroundColor: BACKGROUND_COLOR,
+  reversed: false,
+  enableExtremumLabels: false,
+  enableThresholdLabels: false,
+  enableThresholdDrag: false,
+
+  minValue: undefined,
+  maxValue: undefined,
+  valueFontSize: undefined, // undefined === auto
+  valueFormatter: undefined,
+  dragCallback: undefined,
+  dragEndCallback: undefined,
+};
+
+export class GaugeOptions extends CoreOptions<GaugeConfig> {
+
+  constructor(options: GaugeConfig) {
+    super(options);
+  }
+
+  protected get defaults(): GaugeConfig {
+    return { ...this._coreDefaults, ...GAUGE_OPTIONS_DEFAULTS };
+  }
+
+  get icons(): IconConfig[] {
+    return this._options.icons;
+  }
+
+  get minValue(): number | undefined {
+    return this._options.minValue;
+  }
+
+  get maxValue(): number | undefined {
+    return this._options.maxValue;
+  }
+
+  get enableThresholdDrag(): boolean {
+    return this._options.enableThresholdDrag;
+  }
+
+  get enableThresholdLabels(): boolean {
+    return this._options.enableThresholdLabels;
+  }
+
+  get enableExtremumLabels(): boolean {
+    return this._options.enableExtremumLabels;
+  }
+
+  get reversed(): boolean {
+    return this._options.reversed;
+  }
+
+  get defaultColor(): string {
+    return this._options.defaultColor;
+  }
+
+  get stops(): Stop[] {
+    return this._options.stops;
+  }
+
+  get valueFontSize(): number | undefined {
+    return this._options.valueFontSize;
+  }
+
+  get stat(): Stat {
+    return this._options.stat;
+  }
+
+  get valueArcBackgroundColor(): string {
+    return this._options.valueArcBackgroundColor;
+  }
+
+  get innerRadius(): number {
+    return this._options.innerRadius;
+  }
+
+  get outerRadius(): number {
+    return this._options.outerRadius;
+  }
+
+  valueFormatter(value?: number | null): string {
+    if(this._options.valueFormatter) {
+      return this._options.valueFormatter(value);
+    }
+    if(lodashIsNil(value)) {
+      return 'not defined';
+    }
+    return value.toString();
+  }
+
+  callbackDrag(event: any): void {
+    if(this._options.dragCallback) {
+      this._options.dragCallback(event);
+    }
+  }
+
+  callbackDragEnd(event: any): void {
+    if(this._options.dragEndCallback) {
+      this._options.dragEndCallback(event);
+    }
+  }
+}

src/models/gauge_series.ts

@@ -0,0 +1,17 @@
+import { GaugeData } from '../types';
+
+import { CoreSeries } from '@chartwerk/core';
+
+
+const GAUGE_DATA_DEFAULTS = { };
+
+export class GaugeSeries extends CoreSeries<GaugeData> {
+
+  constructor(series: GaugeData[]) {
+    super(series);
+  }
+
+  protected get defaults(): GaugeData {
+    return { ...this._coreDefaults, ...GAUGE_DATA_DEFAULTS };
+  }
+}

src/types.ts

@@ -1,4 +1,5 @@
-import { TimeSerie, Options } from '@chartwerk/core';
+import { Serie, Options } from '@chartwerk/core';
+
 
 export enum Stat {
   CURRENT = 'current',
@@ -16,9 +17,7 @@ export type PointCoordinate = {
   x: number, y: number
 }
 
-export type ValueFormatter = (value: number) => string;
-
-export type GaugeTimeSerie = TimeSerie;
+export type ValueFormatter = (value?: number | null) => string;
 
 export type IconConfig = {
   src: string,
@@ -34,7 +33,6 @@ export enum IconPosition {
 export type GaugeOptionsParams = {
   innerRadius: number;
   outerRadius: number;
-  // TODO: minValue
   maxValue: number;
   minValue: number;
   stops: { color: string , value: number }[];
@@ -48,7 +46,12 @@ export type GaugeOptionsParams = {
   enableThresholdLabels: boolean; // render threshold values as a text under the gauge
   enableExtremumLabels: boolean; // render min/max values as a text above the gauge
   enableThresholdDrag: boolean; // drag threshold arcs to change stops values
-  dragCallback: (event: any) =>  void;
-  dragEndCallback: (event: any) => void;
+  dragCallback: DragCallback;
+  dragEndCallback: DragEndCallback;
 }
-export type GaugeOptions = Options & Partial<GaugeOptionsParams>;
+
+export type GaugeData = Serie;
+export type GaugeConfig = Options & Partial<GaugeOptionsParams>;
+
+export type DragCallback = (event: any) => void;
+export type DragEndCallback = (event: any) => void;

yarn.lock

@@ -6,12 +6,12 @@ __metadata:
   cacheKey: 8
 
 "@chartwerk/core@npm:latest":
-  version: 0.5.4
-  resolution: "@chartwerk/core@npm:0.5.4"
+  version: 0.6.3
+  resolution: "@chartwerk/core@npm:0.6.3"
   dependencies:
     d3: ^5.7.2
     lodash: ^4.14.149
-  checksum: 0d686409377d6880f0012db3d9c1e1910cf3660885ac13196dabe93f57eca53984cf52dcf781b2876373fe9efc7b9d0209117cbcd811c50892b1de4f38a4a37f
+  checksum: bb804b1a2339fc19857e5caa07d16ed78fb1b0739878d3f7488e9f8661667ed78ada3a63afd15206bd4210746b50916b253e98f077451cc8d899728ecf08ba50
   languageName: node
   linkType: hard