Make class naming consistent

pbiviz.json

@@ -4,7 +4,7 @@
         "displayName":"SPC Charts",
         "guid":"PBISPC",
         "visualClassName":"Visual",
-        "version":"1.3.3.5",
+        "version":"1.3.3.6",
         "description":"A PowerBI custom visual for SPC charts",
         "supportUrl":"https://github.com/AUS-DOH-Safety-and-Quality/PowerBI-SPC",
         "gitHubUrl":"https://github.com/AUS-DOH-Safety-and-Quality/PowerBI-SPC"

src/Classes/controlLimits.ts → src/Classes/controlLimitsClass.ts

@@ -1,14 +1,13 @@
 import rep from "../Functions/rep";
-import plotKey from "./plotKey"
 import astronomical from "../Outlier Flagging/astronomical"
 import trend from "../Outlier Flagging/trend"
 import two_in_three from "../Outlier Flagging/two_in_three"
 import shift from "../Outlier Flagging/shift"
-import settingsObject from "./settingsObject";
+import settingsClass from "./settingsClass";
 import checkFlagDirection from "../Functions/checkFlagDirection"
 
 type controlLimitsArgs = {
-  keys: plotKey[];
+  keys: { x: number, id: number, label: string }[];
   values: number[];
   numerators?: number[];
   denominators?: number[];
@@ -21,9 +20,9 @@ type controlLimitsArgs = {
   count?: number[];
 }
 
-class controlLimits {
+class controlLimitsClass {
   [key: string] : any;
-  keys: plotKey[];
+  keys: { x: number, id: number, label: string }[];
   values: number[];
   numerators?: number[];
   denominators?: number[];
@@ -39,7 +38,7 @@ class controlLimits {
   two_in_three: string[];
   shift: string[];
 
-  flagOutliers(inputSettings: settingsObject) {
+  flagOutliers(inputSettings: settingsClass) {
     const process_flag_type: string = inputSettings.outliers.process_flag_type;
     const improvement_direction: string = inputSettings.outliers.improvement_direction;
     if (inputSettings.spc.chart_type !== "run") {
@@ -86,4 +85,4 @@ class controlLimits {
   }
 }
 
-export default controlLimits
+export default controlLimitsClass

src/Classes/dataObject.ts → src/Classes/dataClass.ts

@@ -3,15 +3,14 @@ import DataViewCategoryColumn = powerbi.DataViewCategoryColumn;
 import PrimitiveValue = powerbi.PrimitiveValue;
 import DataViewCategorical = powerbi.DataViewCategorical;
 import extractDataColumn from "../Functions/extractDataColumn"
-import settingsObject from "./settingsObject"
+import settingsClass from "./settingsClass"
 import checkValidInput from "../Functions/checkValidInput"
 import extractValues from "../Functions/extractValues"
-import plotKey from "./plotKey"
 import extractConditionalFormatting from "../Functions/extractConditionalFormatting"
 import { defaultSettingsType } from "./defaultSettings";
 
-class dataObject {
-  keys: plotKey[];
+class dataClass {
+  keys: { x: number, id: number, label: string }[];
   numerators: number[];
   denominators: number[];
   xbar_sds: number[];
@@ -21,15 +20,15 @@ class dataObject {
   categories: DataViewCategoryColumn;
   scatter_formatting: defaultSettingsType["scatter"][];
 
-  constructor(inputView: DataViewCategorical, inputSettings: settingsObject) {
+  constructor(inputView: DataViewCategorical, inputSettings: settingsClass) {
     const numerators: number[] = extractDataColumn<number[]>(inputView, "numerators");
     const denominators: number[] = extractDataColumn<number[]>(inputView, "denominators");
     const xbar_sds: number[] = extractDataColumn<number[]>(inputView, "xbar_sds");
     const keys: string[] =  extractDataColumn<string[]>(inputView, "key", inputSettings);
     const scatter_cond = extractConditionalFormatting<defaultSettingsType["scatter"]>(inputView, "scatter", inputSettings)
 
     const valid_ids: number[] = new Array<number>();
-    const valid_keys: plotKey[] = new Array<plotKey>();
+    const valid_keys: { x: number, id: number, label: string }[] = new Array<{ x: number, id: number, label: string }>();
 
     for (let i: number = 0; i < numerators.length; i++) {
       if (checkValidInput(numerators[i],
@@ -61,4 +60,4 @@ class dataObject {
   }
 }
 
-export default dataObject;
+export default dataClass;

src/Classes/plotProperties.ts → src/Classes/plotPropertiesClass.ts

@@ -2,10 +2,10 @@ import * as d3 from "d3";
 import powerbi from "powerbi-visuals-api";
 import VisualUpdateOptions = powerbi.extensibility.visual.VisualUpdateOptions;
 import truncate from "../Functions/truncate";
-import { plotData } from "./viewModel"
-import settingsObject from "./settingsObject";
-import dataObject from "./dataObject";
-import controlLimits from "./controlLimits";
+import { plotData } from "./viewModelClass"
+import settingsClass from "./settingsClass";
+import dataClass from "./dataClass";
+import controlLimitsClass from "./controlLimitsClass";
 import { pixelConverter } from "powerbi-visuals-utils-typeutils";
 
 type axisProperties = {
@@ -51,9 +51,9 @@ class plotPropertiesClass {
 
   update(args: { options: VisualUpdateOptions,
                       plotPoints: plotData[],
-                      calculatedLimits: controlLimits,
-                      inputData: dataObject,
-                      inputSettings: settingsObject }) {
+                      controlLimits: controlLimitsClass,
+                      inputData: dataClass,
+                      inputSettings: settingsClass }) {
 
     // Get the width and height of plotting space
     this.width = args.options.viewport.width;
@@ -69,18 +69,18 @@ class plotPropertiesClass {
     let yUpperLimit: number = args.inputSettings.y_axis.ylimit_u;
 
     // Only update data-/settings-dependent plot aesthetics if they have changed
-    if (args.inputData && args.calculatedLimits) {
-      xUpperLimit = xUpperLimit !== null ? xUpperLimit : d3.max(args.calculatedLimits.keys.map(d => d.x))
+    if (args.inputData && args.controlLimits) {
+      xUpperLimit = xUpperLimit !== null ? xUpperLimit : d3.max(args.controlLimits.keys.map(d => d.x))
 
       const limitMultiplier: number = args.inputSettings.y_axis.limit_multiplier;
       const chart_type: string = args.inputSettings.spc.chart_type;
-      const values: number[] = args.calculatedLimits.values;
-      const ul99: number[] = args.calculatedLimits.ul99;
-      const ll99: number[] = args.calculatedLimits.ll99;
+      const values: number[] = args.controlLimits.values;
+      const ul99: number[] = args.controlLimits.ul99;
+      const ll99: number[] = args.controlLimits.ll99;
       const maxValueOrLimit: number = d3.max(values.concat(ul99));
       const minValueOrLimit: number = d3.min(values.concat(ll99));
-      const maxTarget: number = d3.max(args.calculatedLimits.targets);
-      const minTarget: number = d3.min(args.calculatedLimits.targets);
+      const maxTarget: number = d3.max(args.controlLimits.targets);
+      const minTarget: number = d3.min(args.controlLimits.targets);
 
       const upperLimitRaw: number = maxTarget + (maxValueOrLimit - maxTarget) * limitMultiplier;
       const lowerLimitRaw: number = minTarget - (minTarget - minValueOrLimit) * limitMultiplier;

src/Classes/settingsObject.ts → src/Classes/settingsClass.ts

@@ -15,7 +15,7 @@ import { defaultSettingsType, defaultSettingsKey } from "./defaultSettings";
  *
  * These are defined in the settingsGroups.ts file
  */
-class settingsObject implements defaultSettingsType {
+class settingsClass implements defaultSettingsType {
   canvas: defaultSettingsType["canvas"];
   spc: defaultSettingsType["spc"];
   outliers: defaultSettingsType["outliers"];
@@ -84,4 +84,4 @@ class settingsObject implements defaultSettingsType {
     });
   }
 }
-export default settingsObject;
+export default settingsClass;

src/Classes/svgDotsClass.ts

@@ -1,15 +1,15 @@
 import * as d3 from "d3";
 import powerbi from "powerbi-visuals-api";
-import viewModelObject from "./viewModel";
-import { plotData } from "./viewModel";
+import viewModelClass from "./viewModelClass";
+import { plotData } from "./viewModelClass";
 import between from "../Functions/between";
 import ISelectionId = powerbi.visuals.ISelectionId;
 type SelectionBase = d3.Selection<SVGGElement, unknown, null, undefined>;
 
 class svgDotsClass {
   dotsGroup: SelectionBase;
 
-  draw(viewModel: viewModelObject): void {
+  draw(viewModel: viewModelClass): void {
     this.dotsGroup.selectAll(".dotsgroup").remove()
     if (!(viewModel.plotPoints)) {
       return;

src/Classes/svgIconClass.ts

@@ -1,7 +1,7 @@
 import * as d3 from "d3";
 import * as iconSVG from "../Icons"
-import viewModelObject from "./viewModel";
-import controlLimits from "./controlLimits";
+import viewModelClass from "./viewModelClass";
+import controlLimitsClass from "./controlLimitsClass";
 type SelectionBase = d3.Selection<SVGGElement, unknown, null, undefined>;
 
 class svgIconClass {
@@ -92,8 +92,8 @@ class svgIconClass {
     return icon_svg
   }
 
-  variationIconsToDraw(viewModel: viewModelObject): string[] {
-    const currLimits: controlLimits = viewModel.calculatedLimits;
+  variationIconsToDraw(viewModel: viewModelClass): string[] {
+    const currLimits: controlLimitsClass = viewModel.controlLimits;
     const imp_direction: string = viewModel.inputSettings.outliers.improvement_direction;
     const suffix_map: Record<string, string> = {
       "increase" : "High",
@@ -138,7 +138,7 @@ class svgIconClass {
     return iconsPresent;
   }
 
-  drawIcons(viewModel: viewModelObject): void {
+  drawIcons(viewModel: viewModelClass): void {
     d3.selectAll(".icongroup").remove()
     const draw_variation: boolean = viewModel.inputSettings.nhs_icons.show_variation_icons;
     if (!draw_variation) {

src/Classes/svgLinesClass.ts

@@ -1,7 +1,7 @@
 import * as d3 from "d3";
 import powerbi from "powerbi-visuals-api";
-import viewModelObject from "./viewModel";
-import { lineData } from "./viewModel";
+import viewModelClass from "./viewModelClass";
+import { lineData } from "./viewModelClass";
 import between from "../Functions/between";
 import getAesthetic from "../Functions/getAesthetic";
 import ISelectionId = powerbi.visuals.ISelectionId;
@@ -10,7 +10,7 @@ type SelectionBase = d3.Selection<SVGGElement, unknown, null, undefined>;
 class svgLinesClass {
   linesGroup: SelectionBase;
 
-  draw(viewModel: viewModelObject): void {
+  draw(viewModel: viewModelClass): void {
     this.linesGroup.selectAll(".linesgroup").remove()
     if (!(viewModel.groupedLines)) {
       return;

src/Classes/svgSelectionClass.ts

@@ -1,6 +1,6 @@
 import * as d3 from "d3";
 import svgObjectClass from "./svgObjectClass"
-import viewModel from "./viewModel"
+import viewModel from "./viewModelClass"
 
 type SelectionAny = d3.Selection<any, any, any, any>;