powerbi-visuals-api - npm Package Compare versions

Comparing version 2.5.0 to 2.6.0

CHANGELOG.md

 # Change Log - Power BI Cusrom Visuals API
 
+## 2.6.0
+* `subtotals` property specifies subtotal customizations applied in customizeQuery method
+
 ## 2.5.0
@@ -4,0 +7,0 @@ * [Analytics Pane Support](../how-to-guide/analytics-properties/)

index.d.ts

@@ -92,2 +92,3 @@ declare namespace powerbi {
 
+
 declare module powerbi.visuals.plugins {
@@ -110,3 +111,3 @@ /** This IVisualPlugin interface is only used by the CLI tools when compiling */
         apiVersion: string;
-        
+
         /** Human readable plugin name displayed to users */
@@ -118,2 +119,4 @@ displayName: string;
 
+
+
 declare module jsCommon {
@@ -126,2 +129,3 @@ export interface IStringResourceProvider {
 
+
 declare module powerbi {
@@ -171,3 +175,3 @@ /**
         all(promises: IPromise2<any, any>[]): IPromise<any[]>;
-        
+
         /**
@@ -177,3 +181,3 @@ * Combines multiple promises into a single promise that is resolved when all of the input promises are resolved.
          */
-        allSettled<T>(promises: IPromise2<any, any>[]): IPromise<IPromiseResult<T>[]>;        
+        allSettled<T>(promises: IPromise2<any, any>[]): IPromise<IPromiseResult<T>[]>;
 
@@ -265,3 +269,3 @@ /**
     }
-    
+
     export interface IPromiseResult<T> {
@@ -277,3 +281,3 @@ type: PromiseResultType;
     import SelectorsByColumn = data.SelectorsByColumn;
-    
+
     export interface CustomVisualOpaqueIdentity { }
@@ -288,3 +292,3 @@ export interface ISelectionIdBuilder {
     }
-    
+
     export interface ISelectionId {
@@ -300,2 +304,3 @@ equals(other: ISelectionId): boolean;
 
+
 declare module powerbi {
@@ -308,2 +313,3 @@ export const enum SortDirection {
 
+
 declare module powerbi {
@@ -314,2 +320,3 @@ export interface QueryTransformTypeDescriptor {
 
+
 declare module powerbi {
@@ -681,2 +688,3 @@ /** Represents views of a data set. */
 
+
 declare module powerbi {
@@ -712,2 +720,3 @@ /** Represents evaluated, named, custom objects in a DataView. */
 
+
 declare module powerbi.data {
@@ -731,2 +740,3 @@ /** Defines a match against all instances of given roles. */
 
+
 declare module powerbi.data {
@@ -738,2 +748,3 @@ import IStringResourceProvider = jsCommon.IStringResourceProvider;
 
+
 declare module powerbi.data {
@@ -781,2 +792,3 @@ //intentionally blank interfaces since this is not part of the public API
 
+
 declare module powerbi {
@@ -809,5 +821,6 @@ export interface DefaultValueDefinition {
     }
-    
+
 }
 
+
 declare module powerbi {
@@ -847,5 +860,6 @@ export interface Fill {
         nullable: boolean;
-    }  
+    }
 }
 
+
 declare module powerbi {
@@ -892,2 +906,3 @@ export interface FillRule extends FillRuleGeneric<string, number, string> {
 
+
 declare module powerbi {
@@ -899,2 +914,3 @@ export interface FilterTypeDescriptor {
 
+
 declare module powerbi {
@@ -912,2 +928,3 @@ export type GeoJson = GeoJsonDefinitionGeneric<string>;
 
+
 declare module powerbi {
@@ -926,2 +943,3 @@ export type ImageValue = ImageDefinitionGeneric<string>;
 
+
 declare module powerbi {
@@ -957,2 +975,3 @@ import ISQExpr = powerbi.data.ISQExpr;
 
+
 declare module powerbi {
@@ -971,3 +990,3 @@ import SemanticFilter = data.ISemanticFilter;
         DataBars;
-    
+
     /** Describes a structural type in the client type system. Leaf properties should use ValueType. */
@@ -990,2 +1009,3 @@ export interface StructuralTypeDescriptor {
 
+
 declare module powerbi {
@@ -1070,4 +1090,5 @@ /** Describes a data value type in the client type system. Can be used to get a concrete ValueType instance. */
 
+
 declare module powerbi {
-   
+
     export interface DataBars {
@@ -1087,2 +1108,3 @@ minValue?: number;
 
+
 declare module powerbi {
@@ -1094,3 +1116,3 @@ export interface IViewport {
 
-    export interface ScaledViewport extends IViewport{
+    export interface ScaledViewport extends IViewport {
         scale: number;
@@ -1100,5 +1122,6 @@ }
 
+
 declare module powerbi {
     import Selector = powerbi.data.Selector;
-    
+
     export interface VisualObjectInstance {
@@ -1164,3 +1187,3 @@ /** The name of the object (as defined in VisualCapabilities). */
     }
-    
+
     export interface EnumerateVisualObjectInstancesOptions {
@@ -1195,2 +1218,4 @@ objectName: string;
 
+
+
 declare module powerbi.extensibility {
@@ -1204,7 +1229,7 @@
         __transform__?: IVisualDataViewTransform;
-    }   
-    
+    }
+
     export interface IVisualDataViewTransform {
         <T>(dataview: DataView[]): T;
-    } 
+    }
 
@@ -1244,3 +1269,3 @@ // These are the base interfaces. These should remain empty
     }
-    
+
     interface ISelectionManager {
@@ -1276,3 +1301,3 @@ showContextMenu(selectionId: ISelectionId, position: IPoint): IPromise<{}>;
     }
-    
+
     /**
@@ -1328,3 +1353,3 @@ * Interface for expanded color palette.
     }
-    
+
     interface TooltipMoveOptions {
@@ -1354,2 +1379,3 @@ coordinates: number[];
 
+
 declare module powerbi.extensibility {
@@ -1364,3 +1390,3 @@ interface ITelemetryService {
 declare module powerbi.extensibility {
-    export function VisualPlugin (options: IVisualPluginOptions): ClassDecorator;
+    export function VisualPlugin(options: IVisualPluginOptions): ClassDecorator;
 }
@@ -1370,3 +1396,3 @@
     export interface ILocalizationManager {
-        getDisplayName(key: string): string; 
+        getDisplayName(key: string): string;
     }
@@ -1382,3 +1408,3 @@ }
 declare module powerbi.extensibility {
-    /**
+    /** 
      * Provides an access to local storage for read / write access 
@@ -1397,5 +1423,5 @@ */
          * Saves the data to local storage. This data can be later be retrieved using the 'key'.
-         * Returns a promise that resolves to the amount of free space available to caller after the save if there
-         * is any or rejects otherwise.
-         *
+         * Returns a promise that resolves to the amount of free space available to caller after the save if there 
+         * is any or rejects otherwise. 
+         * 
          * @param key - the name of the payload to store
@@ -1417,4 +1443,4 @@ * @param data - the payload string to store
 declare module powerbi.extensibility {
-    /**
-     * An interface for reporting rendering events
+    /** 
+     * An interface for reporting rendering events 
      */
@@ -1470,3 +1496,3 @@ export interface IVisualEventService {
         persistProperties: (changes: VisualObjectInstancesToPersist) => void;
-        applyJsonFilter: (filter: IFilter[]|IFilter, objectName: string, propertyName: string, action: FilterAction)=> void;
+        applyJsonFilter: (filter: IFilter[] | IFilter, objectName: string, propertyName: string, action: FilterAction) => void;
         tooltipService: ITooltipService;
@@ -1484,2 +1510,3 @@ telemetry: ITelemetryService;
         eventService: IVisualEventService;
+        switchFocusModeState: (on: boolean) => void;
     }
@@ -1494,3 +1521,4 @@
         operationKind?: VisualDataChangeOperationKind;
-        jsonFilters?: IFilter[]; 
+        jsonFilters?: IFilter[];
+        isInFocus?: boolean;
     }
@@ -1497,0 +1525,0 @@

package.json

 {
   "name": "powerbi-visuals-api",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "Power BI Custom Visuals API type definitions for typescript",
@@ -5,0 +5,0 @@ "types": "index",

schema.capabilities.json

@@ -53,2 +53,6 @@ {
             "description": "Indicates whether the visual supports a landing page"
+        },
+        "subtotals": {
+            "description": "Specifies the subtotal customizations applied in the customizeQuery method",
+            "$ref": "#/definitions/subtotals"
         }
@@ -922,3 +926,3 @@ },
                 },
-                "fillRule" : {
+                "fillRule": {
                     "type": "object",
@@ -1046,7 +1050,2 @@ "description": "A color gradient that will be dispalyed to the user as a minimum (,medium) and maximum color pickers",
                             ]
-                        },
-                        {
-                            "required":[
-                                "fontFamily"
-                            ]
                         }
@@ -1206,4 +1205,126 @@ ]
             ]
+        },
+        "subtotals": {
+            "type": "object",
+            "description": "Specifies the subtotal request customizations applied to the outgoing data query",
+            "properties": {
+                "matrix": {
+                    "description": "Defines the subtotal customizations of the outgoing data query of a matrix-dataview visual",
+                    "$ref": "#/definitions/subtotals.matrix"
+                }
+            },
+            "requires": [
+                "matrix"
+            ]
+        },
+        "subtotals.matrix": {
+            "type": "object",
+            "description": "Specifies the subtotal customizations of the outgoing data query of a matrix-dataview visual",
+            "properties": {
+                "rowSubtotals": {
+                    "type": "object",
+                    "description": "Indicates if the subtotal data should be requested for all fields in the rows field well",
+                    "properties": {
+                        "propertyIdentifier": {
+                            "type": "object",
+                            "properties": {
+                                "objectName": {
+                                    "type": "string"
+                                },
+                                "propertyName": {
+                                    "type": "string"
+                                }
+                            }
+                        },
+                        "defaultValue": {
+                            "type": "boolean"
+                        }
+                    }
+                },
+                "rowSubtotalsPerLevel": {
+                    "type": "object",
+                    "description": "Indicates if the subtotal data can be toggled for individual fields in the rows field well",
+                    "properties": {
+                        "propertyIdentifier": {
+                            "type": "object",
+                            "properties": {
+                                "objectName": {
+                                    "type": "string"
+                                },
+                                "propertyName": {
+                                    "type": "string"
+                                }
+                            }
+                        },
+                        "defaultValue": {
+                            "type": "boolean"
+                        }
+                    }
+                },
+                "columnSubtotals": {
+                    "type": "object",
+                    "description": "Indicates if the subtotal data should be requested for all fields in the columns field well",
+                    "properties": {
+                        "propertyIdentifier": {
+                            "type": "object",
+                            "properties": {
+                                "objectName": {
+                                    "type": "string"
+                                },
+                                "propertyName": {
+                                    "type": "string"
+                                }
+                            }
+                        },
+                        "defaultValue": {
+                            "type": "boolean"
+                        }
+                    }
+                },
+                "columnSubtotalsPerLevel": {
+                    "type": "object",
+                    "description": "Indicates if the subtotal data can be toggled for individual fields in the columns field well",
+                    "properties": {
+                        "propertyIdentifier": {
+                            "type": "object",
+                            "properties": {
+                                "objectName": {
+                                    "type": "string"
+                                },
+                                "propertyName": {
+                                    "type": "string"
+                                }
+                            }
+                        },
+                        "defaultValue": {
+                            "type": "boolean"
+                        }
+                    }
+                },
+                "levelSubtotalEnabled": {
+                    "type": "object",
+                    "description": "Unlike all other properites, this property is applied to individual rows/columns. The property indicates if the subtotals are requested for the row/column",
+                    "properties": {
+                        "propertyIdentifier": {
+                            "type": "object",
+                            "properties": {
+                                "objectName": {
+                                    "type": "string"
+                                },
+                                "propertyName": {
+                                    "type": "string"
+                                }
+                            }
+                        },
+                        "defaultValue": {
+                            "type": "boolean"
+                        }
+                    }
+                }
+            },
+            "requires": [
+                "matrix"
+            ]
         }
     }
 }

No alert changes

Improved metrics

Total package byte prevSize

118096

increased by4.9%

Lines of code

2772

increased by4.64%

No dependency changes