powerbi-visuals-tools 4.0.4 → 4.0.6

package/templates/visuals/rvisual/src/visual.ts

@@ -26,22 +26,24 @@
 
 "use strict";
 import powerbi from "powerbi-visuals-api";
+import { FormattingSettingsService } from "powerbi-visuals-utils-formattingmodel";
+
 import VisualConstructorOptions = powerbi.extensibility.visual.VisualConstructorOptions;
 import VisualUpdateOptions = powerbi.extensibility.visual.VisualUpdateOptions;
 import IVisual = powerbi.extensibility.visual.IVisual;
-import EnumerateVisualObjectInstancesOptions = powerbi.EnumerateVisualObjectInstancesOptions;
-import VisualObjectInstance = powerbi.VisualObjectInstance;
 import DataView = powerbi.DataView;
 import IViewport = powerbi.IViewport;
-import VisualObjectInstanceEnumerationObject = powerbi.VisualObjectInstanceEnumerationObject;
 
-import { VisualSettings } from "./settings";
+import { VisualFormattingSettingsModel } from "./settings";
+
 export class Visual implements IVisual {
     private imageDiv: HTMLDivElement;
     private imageElement: HTMLImageElement;
-    private settings: VisualSettings;
+    private formattingSettings: VisualFormattingSettingsModel;
+    private formattingSettingsService: FormattingSettingsService;
 
     public constructor(options: VisualConstructorOptions) {
+        this.formattingSettingsService = new FormattingSettingsService();
         this.imageDiv = document.createElement("div");
         this.imageDiv.className = "rcv_autoScaleImageContainer";
         this.imageElement = document.createElement("img");
@@ -59,9 +61,9 @@ export class Visual implements IVisual {
             !options.dataViews[0]) {
             return;
         }
-        const dataView: DataView = options.dataViews[0];
 
-        this.settings = Visual.parseSettings(dataView);
+        const dataView: DataView = options.dataViews[0];
+        this.formattingSettings = this.formattingSettingsService.populateFormattingSettingsModel(VisualFormattingSettingsModel, options.dataViews);
 
         let imageUrl: string = null;
         if (dataView.scriptResult && dataView.scriptResult.payloadBase64) {
@@ -82,15 +84,11 @@ export class Visual implements IVisual {
         this.imageDiv.style.width = finalViewport.width + "px";
     }
 
-    private static parseSettings(dataView: DataView): VisualSettings {
-        return <VisualSettings>VisualSettings.parse(dataView);
-    }
     /**
-     * This function gets called for each of the objects defined in the capabilities files and allows you to select which of the
-     * objects and properties you want to expose to the users in the property pane.
+     * Returns properties pane formatting model content hierarchies, properties and latest formatting values, Then populate properties pane.
+     * This method is called once every time we open properties pane or when the user edit any format property. 
      */
-    public enumerateObjectInstances(options: EnumerateVisualObjectInstancesOptions):
-        VisualObjectInstance[] | VisualObjectInstanceEnumerationObject {
-        return VisualSettings.enumerateObjectInstances(this.settings || VisualSettings.getDefault(), options);
+    public getFormattingModel(): powerbi.visuals.FormattingModel {
+        return this.formattingSettingsService.buildFormattingModel(this.formattingSettings);
     }
 }

package/templates/visuals/slicer/capabilities.json

@@ -59,5 +59,6 @@
                 }
             }
         }
-    }
+    },
+    "privileges": []
 }

package/templates/visuals/slicer/package.json

@@ -8,11 +8,11 @@
   },
   "dependencies": {
     "d3": "5.10.0",
-    "powerbi-visuals-utils-dataviewutils": "^2.2.1"
+    "powerbi-visuals-utils-formattingmodel": "5.0.0"
   },
   "devDependencies": {
     "@types/d3": "5.7.2",
-    "powerbi-visuals-api": "~3.8.0",
+    "powerbi-visuals-api": "5.1.0",
     "tslint": "^5.18.0",
     "tslint-microsoft-contrib": "^6.2.0",
     "typescript": "3.6.3"

package/templates/visuals/slicer/pbiviz.json

@@ -1,4 +1,4 @@
 {
-    "apiVersion": "3.8.0",
+    "apiVersion": "5.1.0",
     "externalJS": null
 }

package/templates/visuals/slicer/src/settings.ts

@@ -26,7 +26,33 @@
 
 "use strict";
 
-import { dataViewObjectsParser } from "powerbi-visuals-utils-dataviewutils";
-import DataViewObjectsParser = dataViewObjectsParser.DataViewObjectsParser;
+import { formattingSettings } from "powerbi-visuals-utils-formattingmodel";
 
-<%= visualSettingsClasses %>
+import FormattingSettingsCard = formattingSettings.Card;
+import FormattingSettingsSlice = formattingSettings.Slice;
+import FormattingSettingsModel = formattingSettings.Model;
+
+
+/**
+ * General Formatting Card
+ */
+class generalCardSettings extends FormattingSettingsCard {
+    filter: FormattingSettingsSlice = undefined;
+    setFilter: FormattingSettingsSlice = undefined;
+    setFilterEnabled: FormattingSettingsSlice = undefined;
+
+    name: string = "general";
+    displayName: string = "General";
+    slices: Array<FormattingSettingsSlice> = [this.filter, this.setFilter, this.setFilterEnabled];
+}
+
+/**
+* Visual settings model class
+*
+*/
+export class VisualFormattingSettingsModel extends FormattingSettingsModel {
+    // Create formatting settings model formatting cards
+    generalCard = new generalCardSettings();
+
+    cards = [this.generalCard];
+}

package/templates/visuals/slicer/src/visual.ts

@@ -25,25 +25,26 @@
 */
 "use strict";
 
-import "./../style/visual.less";
 import powerbi from "powerbi-visuals-api";
+import { FormattingSettingsService } from "powerbi-visuals-utils-formattingmodel";
+import "./../style/visual.less";
+
 import VisualConstructorOptions = powerbi.extensibility.visual.VisualConstructorOptions;
 import VisualUpdateOptions = powerbi.extensibility.visual.VisualUpdateOptions;
 import IVisual = powerbi.extensibility.visual.IVisual;
-import EnumerateVisualObjectInstancesOptions = powerbi.EnumerateVisualObjectInstancesOptions;
-import VisualObjectInstance = powerbi.VisualObjectInstance;
-import DataView = powerbi.DataView;
-import VisualObjectInstanceEnumerationObject = powerbi.VisualObjectInstanceEnumerationObject;
 
-import { VisualSettings } from "./settings";
+import { VisualFormattingSettingsModel } from "./settings";
+
 export class Visual implements IVisual {
     private target: HTMLElement;
     private updateCount: number;
-    private settings: VisualSettings;
     private textNode: Text;
+    private formattingSettings: VisualFormattingSettingsModel;
+    private formattingSettingsService: FormattingSettingsService;
 
     constructor(options: VisualConstructorOptions) {
         console.log("Visual constructor", options);
+        this.formattingSettingsService = new FormattingSettingsService();
         this.target = options.element;
         this.updateCount = 0;
         if (document) {
@@ -58,22 +59,18 @@ export class Visual implements IVisual {
     }
 
     public update(options: VisualUpdateOptions) {
-        this.settings = Visual.parseSettings(options && options.dataViews && options.dataViews[0]);
+        this.formattingSettings = this.formattingSettingsService.populateFormattingSettingsModel(VisualFormattingSettingsModel, options.dataViews);
         console.log("Visual update", options);
         if (this.textNode) {
             this.textNode.textContent = (this.updateCount++).toString();
         }
     }
 
-    private static parseSettings(dataView: DataView): VisualSettings {
-        return <VisualSettings>VisualSettings.parse(dataView);
-    }
-    /** 
-     * This function gets called for each of the objects defined in the capabilities files and allows you to select which of the 
-     * objects and properties you want to expose to the users in the property pane.
+    /**
+     * Returns properties pane formatting model content hierarchies, properties and latest formatting values, Then populate properties pane.
+     * This method is called once every time we open properties pane or when the user edit any format property. 
      */
-    public enumerateObjectInstances(options: EnumerateVisualObjectInstancesOptions):
-        VisualObjectInstance[] | VisualObjectInstanceEnumerationObject {
-        return VisualSettings.enumerateObjectInstances(this.settings || VisualSettings.getDefault(), options);
+    public getFormattingModel(): powerbi.visuals.FormattingModel {
+        return this.formattingSettingsService.buildFormattingModel(this.formattingSettings);
     }
 }

package/templates/visuals/table/capabilities.json

@@ -33,5 +33,6 @@
                 }
             }
         }
-    ]
+    ],
+    "privileges": []
 }

package/templates/visuals/table/package.json

@@ -8,10 +8,10 @@
   },
   "dependencies": {
     "d3": "5.10.0",
-    "powerbi-visuals-utils-dataviewutils": "^2.2.1"
+    "powerbi-visuals-utils-formattingmodel": "5.0.0"
   },
   "devDependencies": {
-    "powerbi-visuals-api": "~3.8.0",
+    "powerbi-visuals-api": "5.1.0",
     "@types/d3": "5.7.2",
     "tslint": "^5.18.0",
     "tslint-microsoft-contrib": "^6.2.0",

package/templates/visuals/table/pbiviz.json

@@ -1,4 +1,4 @@
 {
-    "apiVersion": "3.8.0",
+    "apiVersion": "5.1.0",
     "externalJS": null
 }

package/templates/visuals/table/src/settings.ts

@@ -25,7 +25,27 @@
  */
 "use strict";
 
-import { dataViewObjectsParser } from "powerbi-visuals-utils-dataviewutils";
-import DataViewObjectsParser = dataViewObjectsParser.DataViewObjectsParser;
+import { formattingSettings } from "powerbi-visuals-utils-formattingmodel";
 
-<%= visualSettingsClasses %>
+import FormattingSettingsModel = formattingSettings.Model;
+// import FormattingSettingsCard = formattingSettings.Card;
+// import FormattingSettingsSlice = formattingSettings.Slice;
+
+// TODO: fill all visual settings here
+// class DataPointCardSettings extends FormattingSettingsCard {
+//     fill = new formattingSettings.ColorPicker({
+//         name: "fill", // Property name from capabilities.json
+//         displayName: "Fill",
+//         value: { value: "#000000" }
+//     });
+
+//     name: string = "dataPoint"; // Object name from capabilities.json
+//     displayName: string = "Data colors";
+//     slices: Array<FormattingSettingsSlice> = [this.fill];
+// }
+
+export class VisualFormattingSettingsModel extends FormattingSettingsModel {
+    // TODO: fill all visual settings here
+    // public dataPointCardSettings: FormattingSettingsCard = new DataPointCardSettings();
+    // cards = [this.dataPointCardSettings];
+}

package/templates/visuals/table/src/visual.ts

@@ -26,24 +26,23 @@
 
 "use strict";
 
-import "./../style/visual.less";
-import { select } from "d3-selection";
 import { transpose } from "d3-array";
 import { formatPrefix } from "d3-format";
+import { select } from "d3-selection";
+import "./../style/visual.less";
 
 import powerbi from "powerbi-visuals-api";
+import { FormattingSettingsService } from "powerbi-visuals-utils-formattingmodel";
+
 import VisualConstructorOptions = powerbi.extensibility.visual.VisualConstructorOptions;
 import VisualUpdateOptions = powerbi.extensibility.visual.VisualUpdateOptions;
 import IVisual = powerbi.extensibility.visual.IVisual;
-import EnumerateVisualObjectInstancesOptions = powerbi.EnumerateVisualObjectInstancesOptions;
-import VisualObjectInstance = powerbi.VisualObjectInstance;
 import DataView = powerbi.DataView;
 import IViewport = powerbi.IViewport;
-import VisualObjectInstanceEnumerationObject = powerbi.VisualObjectInstanceEnumerationObject;
 
-import { VisualSettings } from "./settings";
-import { VisualViewModel, CategoryViewModel } from "./visualViewModel";
+import { VisualFormattingSettingsModel } from "./settings";
 import { visualTransform } from "./visualTransform";
+import { CategoryViewModel, VisualViewModel } from "./visualViewModel";
 
 "use strict";
 export class Visual implements IVisual {
@@ -51,9 +50,12 @@ export class Visual implements IVisual {
     private table: d3.Selection<any, any, any, any>;
     private tHead: d3.Selection<any, any, any, any>;
     private tBody: d3.Selection<any, any, any, any>;
-    private settings: VisualSettings;
+    private formattingSettings: VisualFormattingSettingsModel;
+    private formattingSettingsService: FormattingSettingsService;
 
     constructor(options: VisualConstructorOptions) {
+        this.formattingSettingsService = new FormattingSettingsService();
+
         let target: d3.Selection<any, any, any, any> = this.target = select(options.element).append("div")
             .classed("powerbi-demo-wrapper", true);
 
@@ -72,7 +74,8 @@ export class Visual implements IVisual {
         if (!viewModel) {
             return;
         }
-        this.settings = Visual.parseSettings(options.dataViews[0]);
+
+        this.formattingSettings = this.formattingSettingsService.populateFormattingSettingsModel(VisualFormattingSettingsModel, options.dataViews);
         this.updateContainerViewports(options.viewport);
 
         let transposedSeries: any[][] = transpose(viewModel.values.map((d: any) => d.values.map((d: any) => d)));
@@ -107,12 +110,11 @@ export class Visual implements IVisual {
         return formatPrefix("d", this.round(d, 2))(d);
     }
 
-    private static parseSettings(dataView: DataView): VisualSettings {
-        return <VisualSettings>VisualSettings.parse(dataView);
-    }
-
-    public enumerateObjectInstances(options: EnumerateVisualObjectInstancesOptions):
-        VisualObjectInstance[] | VisualObjectInstanceEnumerationObject {
-        return VisualSettings.enumerateObjectInstances(this.settings || VisualSettings.getDefault(), options);
+    /**
+     * Returns properties pane formatting model content hierarchies, properties and latest formatting values, Then populate properties pane.
+     * This method is called once every time we open properties pane or when the user edit any format property. 
+     */
+    public getFormattingModel(): powerbi.visuals.FormattingModel {
+        return this.formattingSettingsService.buildFormattingModel(this.formattingSettings);
     }
 }

package/.eslintrc.json

@@ -1,313 +0,0 @@
-{
-    "env": {
-        "es6": true,
-        "node": true
-    },
-    "extends": "eslint:recommended",
-    "parserOptions": {
-        "ecmaVersion": 2018,
-        "sourceType": "module"
-    },
-    "rules": {
-        "accessor-pairs": "error",
-        "array-bracket-newline": "error",
-        "array-bracket-spacing": [
-            "error",
-            "never"
-        ],
-        "array-callback-return": "off",
-        "array-element-newline": "off",
-        "arrow-body-style": "off",
-        "arrow-parens": "off",
-        "no-console": "off",
-        "arrow-spacing": [
-            "error",
-            {
-                "after": true,
-                "before": true
-            }
-        ],
-        "block-scoped-var": "error",
-        "block-spacing": "error",
-        "brace-style": "off",
-        "callback-return": "off",
-        "camelcase": "error",
-        "capitalized-comments": "off",
-        "class-methods-use-this": "off",
-        "comma-dangle": "error",
-        "comma-spacing": [
-            "error",
-            {
-                "after": true,
-                "before": false
-            }
-        ],
-        "comma-style": [
-            "error",
-            "last"
-        ],
-        "complexity": "off",
-        "computed-property-spacing": [
-            "error",
-            "never"
-        ],
-        "consistent-return": "off",
-        "consistent-this": "error",
-        "curly": "error",
-        "default-case": "error",
-        "dot-location": [
-            "error",
-            "property"
-        ],
-        "dot-notation": [
-            "error",
-            {
-                "allowKeywords": true
-            }
-        ],
-        "eol-last": "error",
-        "eqeqeq": "off",
-        "func-call-spacing": "error",
-        "func-name-matching": "error",
-        "func-names": [
-            "error",
-            "never"
-        ],
-        "func-style": [
-            "error",
-            "declaration",
-            {
-                "allowArrowFunctions": true
-            }
-        ],
-        "function-paren-newline": "off",
-        "generator-star-spacing": "error",
-        "global-require": "off",
-        "guard-for-in": "off",
-        "handle-callback-err": "error",
-        "id-blacklist": "error",
-        "id-length": "off",
-        "id-match": "error",
-        "implicit-arrow-linebreak": [
-            "off",
-            "beside"
-        ],
-        "indent": "off",
-        "indent-legacy": "off",
-        "init-declarations": "off",
-        "jsx-quotes": "error",
-        "key-spacing": "error",
-        "keyword-spacing": [
-            "error",
-            {
-                "after": true,
-                "before": true
-            }
-        ],
-        "line-comment-position": "off",
-        "linebreak-style": [
-            "error",
-            "unix"
-        ],
-        "lines-around-comment": "off",
-        "lines-around-directive": "error",
-        "lines-between-class-members": "error",
-        "max-classes-per-file": "error",
-        "max-depth": "off",
-        "max-len": "off",
-        "max-lines": "off",
-        "max-lines-per-function": "off",
-        "max-nested-callbacks": "error",
-        "max-params": "off",
-        "max-statements": "off",
-        "max-statements-per-line": "off",
-        "multiline-comment-style": [
-            "off",
-            "starred-block"
-        ],
-        "new-cap": "error",
-        "new-parens": "error",
-        "newline-after-var": "off",
-        "newline-before-return": "off",
-        "newline-per-chained-call": "off",
-        "no-alert": "error",
-        "no-array-constructor": "error",
-        "no-await-in-loop": "off",
-        "no-bitwise": "error",
-        "no-buffer-constructor": "error",
-        "no-caller": "error",
-        "no-catch-shadow": "error",
-        "no-confusing-arrow": "off",
-        "no-continue": "error",
-        "no-div-regex": "error",
-        "no-duplicate-imports": "error",
-        "no-else-return": "error",
-        "no-empty-function": "error",
-        "no-eq-null": "error",
-        "no-eval": "error",
-        "no-extend-native": "error",
-        "no-extra-bind": "error",
-        "no-extra-label": "error",
-        "no-extra-parens": "off",
-        "no-floating-decimal": "error",
-        "no-implicit-coercion": "error",
-        "no-implicit-globals": "error",
-        "no-implied-eval": "error",
-        "no-inline-comments": "off",
-        "no-invalid-this": "off",
-        "no-iterator": "error",
-        "no-label-var": "error",
-        "no-labels": "error",
-        "no-lone-blocks": "error",
-        "no-lonely-if": "error",
-        "no-loop-func": "error",
-        "no-magic-numbers": "off",
-        "no-mixed-operators": "error",
-        "no-mixed-requires": "error",
-        "no-multi-assign": "error",
-        "no-multi-spaces": "off",
-        "no-multi-str": "error",
-        "no-multiple-empty-lines": "error",
-        "no-native-reassign": "error",
-        "no-negated-condition": "off",
-        "no-negated-in-lhs": "error",
-        "no-nested-ternary": "off",
-        "no-new": "error",
-        "no-new-func": "error",
-        "no-new-object": "error",
-        "no-new-require": "error",
-        "no-new-wrappers": "error",
-        "no-octal-escape": "error",
-        "no-param-reassign": "off",
-        "no-case-declarations": "off",
-        "no-path-concat": "error",
-        "no-plusplus": [
-            "off",
-            {
-                "allowForLoopAfterthoughts": true
-            }
-        ],
-        "no-process-env": "error",
-        "no-process-exit": "off",
-        "no-proto": "error",
-        "no-prototype-builtins": "off",
-        "no-restricted-globals": "error",
-        "no-restricted-imports": "error",
-        "no-restricted-modules": "error",
-        "no-restricted-properties": "error",
-        "no-restricted-syntax": "error",
-        "no-return-assign": "error",
-        "no-return-await": "error",
-        "no-script-url": "error",
-        "no-self-compare": "error",
-        "no-sequences": "error",
-        "no-shadow": "off",
-        "no-shadow-restricted-names": "error",
-        "no-spaced-func": "error",
-        "no-sync": "off",
-        "no-tabs": "error",
-        "no-template-curly-in-string": "error",
-        "no-ternary": "off",
-        "no-throw-literal": "error",
-        "no-trailing-spaces": "off",
-        "no-undef-init": "error",
-        "no-undefined": "error",
-        "no-undef": "off",
-        "no-underscore-dangle": "off",
-        "no-unmodified-loop-condition": "error",
-        "no-unneeded-ternary": [
-            "error",
-            {
-                "defaultAssignment": true
-            }
-        ],
-        "no-unused-expressions": "off",
-        "no-use-before-define": "off",
-        "no-useless-call": "error",
-        "no-useless-computed-key": "error",
-        "no-useless-concat": "error",
-        "no-useless-constructor": "error",
-        "no-useless-rename": "error",
-        "no-useless-return": "error",
-        "no-var": "error",
-        "no-void": "error",
-        "no-warning-comments": "off",
-        "no-whitespace-before-property": "error",
-        "no-with": "error",
-        "nonblock-statement-body-position": "error",
-        "object-curly-newline": "error",
-        "object-curly-spacing": [
-            "error",
-            "always"
-        ],
-        "object-property-newline": "error",
-        "object-shorthand": "off",
-        "one-var": "off",
-        "one-var-declaration-per-line": [
-            "error",
-            "initializations"
-        ],
-        "operator-assignment": "error",
-        "operator-linebreak": "error",
-        "padded-blocks": "off",
-        "padding-line-between-statements": "error",
-        "prefer-arrow-callback": "off",
-        "prefer-const": "off",
-        "prefer-destructuring": "off",
-        "prefer-numeric-literals": "error",
-        "prefer-object-spread": "error",
-        "prefer-promise-reject-errors": "off",
-        "prefer-reflect": "off",
-        "prefer-rest-params": "off",
-        "prefer-spread": "error",
-        "prefer-template": "off",
-        "quote-props": "off",
-        "quotes": "off",
-        "radix": "error",
-        "require-await": "warn",
-        "require-jsdoc": "off",
-        "rest-spread-spacing": "error",
-        "semi": "error",
-        "semi-spacing": [
-            "error",
-            {
-                "after": true,
-                "before": false
-            }
-        ],
-        "semi-style": "off",
-        "sort-imports": "error",
-        "sort-keys": "off",
-        "sort-vars": "off",
-        "space-before-blocks": "error",
-        "space-before-function-paren": "off",
-        "space-in-parens": [
-            "error",
-            "never"
-        ],
-        "space-infix-ops": "error",
-        "space-unary-ops": "error",
-        "spaced-comment": "off",
-        "strict": "off",
-        "switch-colon-spacing": "error",
-        "symbol-description": "error",
-        "template-curly-spacing": [
-            "error",
-            "never"
-        ],
-        "template-tag-spacing": "error",
-        "unicode-bom": [
-            "error",
-            "never"
-        ],
-        "valid-jsdoc": "off",
-        "vars-on-top": "error",
-        "wrap-iife": "error",
-        "wrap-regex": "off",
-        "yield-star-spacing": "error",
-        "yoda": [
-            "error",
-            "never"
-        ]
-    }
-}

package/.gitattributes

@@ -1,4 +0,0 @@
-*       text=auto
-*       eol=lf
-*.jpg   -text
-*.png   -text