Remove interactivity utils (#127)

* Remove behavior classes * Remove interactivity utils from legend * Remove interactivity utils from packages * Remove interactivity utils from labels * Fix legend tests * Increment version * Increase version to 7.0.0 * Add interface for selectable dataPoint * Fix eslint * Update docs * Remove interactive legend class * Update docs * Update changelog * Update changelog * Update docs * Use beta version --------- Co-authored-by: Iuliia Kulagina <[email protected]>
microsoft · Jul 19, 2024 · a658e5a · a658e5a
1 parent 2f4b09e
commit a658e5a
Show file tree

Hide file tree

Showing 19 changed files with 31 additions and 1,067 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 7.0.0
+* Removed interactivityutils and related code
+* Removed interactiveLegend class
+* Changed createLegend function signature -> createLegend(HTMLElement, boolean, LegendPosition)
+
 ## 6.0.4
 * Updated powerbi-visuals-api to 5.9.0 and other utils
 

diff --git a/docs/api/legend.md b/docs/api/legend.md
@@ -12,8 +12,6 @@ This helper function simplifies PowerBI Custom Visual legends creation.
 
 ```typescript
 function createLegend(legendParentElement: HTMLElement,          // top visual element, container in which legend will be created
-        interactive: boolean,                               // indicates that legend should be interactive
-        interactivityService: IInteractivityService,        // reference to IInteractivityService interface which need to create legend click events
         isScrollable: boolean = false,                      // indicates that legend could be scrollable or not
         legendPosition: LegendPosition = LegendPosition.Top // Position of the legend inside of legendParentElement container
         ): ILegend;
@@ -31,13 +29,8 @@ function createLegend(legendParentElement: HTMLElement,          // top visual e
 
             //... some other init calls
 
-            if (this.behavior) {
-                this.interactivityService = createInteractivityService(hostServices);
-            }
             this.legend = createLegend(
                 element,
-                options.interactivity && options.interactivity.isInteractiveLegend,
-                this.interactivityService,
                 true);
         }
 ```

diff --git a/docs/dev/development-workflow.md b/docs/dev/development-workflow.md
@@ -48,13 +48,13 @@ npm run build
 This command compiles less code to CSS and TypeScript code to JavaScript. The result of the compilation is available in the ```lib``` directory.
 
 ## How to lint the source code
-We use [TSLint](https://github.com/palantir/tslint) as a linter for TypeScript code. To check source code you should run the following command:
+We use [eslint](https://github.com/eslint/eslint) as a linter for TypeScript code. To check source code you should run the following command:
 
 ```bash
 npm run lint
 ```
 
-This command checks style of TypeScript code and provides a list of problems. Please address all of problems reported by TSLint before sending a pull request to the [repository](https://github.com/Microsoft/powerbi-visuals-utils-chartutils).
+This command checks style of TypeScript code and provides a list of problems. Please address all of problems reported by eslint before sending a pull request to the [repository](https://github.com/Microsoft/powerbi-visuals-utils-chartutils).
 
 ## How to run unit tests locally
 We use [Jasmine](https://github.com/jasmine/jasmine) and [Karma](https://github.com/karma-runner/karma) to run unit tests. Please note, Karma requires Google Chrome to run unit tests.

diff --git a/docs/usage/installation-guide.md b/docs/usage/installation-guide.md
@@ -25,7 +25,6 @@ This command installs the package and adds a package as a dependency to your ```
 The package contains ```d.ts``` declarations file, it's necessary for TypeScript compiler and it helps to develop your visuals fast and confident. You should add the following files to the ```files``` property of ```tsconfig.json```:
 * ```typings/index.d.ts```
 * ```node_modules/powerbi-visuals-utils-formattingutils/lib/index.d.ts```
-* ```node_modules/powerbi-visuals-utils-interactivityutils/lib/index.d.ts```
 * ```node_modules/powerbi-visuals-utils-svgutils/lib/index.d.ts```
 * ```node_modules/powerbi-visuals-utils-typeutils/lib/index.d.ts```
 * ```node_modules/powerbi-visuals-utils-chartutils/lib/index.d.ts```
@@ -37,7 +36,6 @@ As a result you will have the following file structure:
   "files": [
     "typings/index.d.ts",
     "node_modules/powerbi-visuals-utils-formattingutils/lib/index.d.ts",
-    "node_modules/powerbi-visuals-utils-interactivityutils/lib/index.d.ts",
     "node_modules/powerbi-visuals-utils-svgutils/lib/index.d.ts",
     "node_modules/powerbi-visuals-utils-typeutils/lib/index.d.ts",
     "node_modules/powerbi-visuals-utils-chartutils/lib/index.d.ts"
@@ -53,7 +51,6 @@ To use the package with your custom visuals you should add the following files t
 * ```node_modules/powerbi-visuals-utils-typeutils/lib/index.js```
 * ```node_modules/powerbi-visuals-utils-svgutils/lib/index.js```
 * ```node_modules/powerbi-visuals-utils-formattingutils/lib/index.js```
-* ```node_modules/powerbi-visuals-utils-interactivityutils/lib/index.js```
 * ```node_modules/powerbi-visuals-utils-chartutils/lib/index.js```
 
 As a result you will have the following file structure:
@@ -70,7 +67,6 @@ As a result you will have the following file structure:
     "node_modules/powerbi-visuals-utils-typeutils/lib/index.js",
     "node_modules/powerbi-visuals-utils-svgutils/lib/index.js",
     "node_modules/powerbi-visuals-utils-formattingutils/lib/index.js",
-    "node_modules/powerbi-visuals-utils-interactivityutils/lib/index.js",
     "node_modules/powerbi-visuals-utils-chartutils/lib/index.js"
   ],
   "style": ...,
@@ -81,12 +77,10 @@ As a result you will have the following file structure:
 ## Including CSS artifacts to the custom visual
 To use the package with your custom visuals you should import the following CSS files to your ```.less``` file:
 
-* ```node_modules/powerbi-visuals-utils-interactivityutils/lib/index.css```
 * ```node_modules/powerbi-visuals-utils-chartutils/lib/index.css```
 
 As a result you will have the following file structure:
 ```less
-@import (less) "node_modules/powerbi-visuals-utils-interactivityutils/lib/index.css";
 @import (less) "node_modules/powerbi-visuals-utils-chartutils/lib/index.css";
 ```
 

diff --git a/docs/usage/usage-guide.md b/docs/usage/usage-guide.md
@@ -6,3 +6,4 @@ This package contains the following classes, interfaces and methods:
 * [Axis Helper](../api/axis-helper.md) - provide all necessary methods to maintain chart axes
 * [DataLabelManager](../api/data-label-manager.md) - helps to create and maintain labels
 * [DataLabelUtils](../api/data-label-utils.md) - label manager utils
+* [Legend](../api/legend.md) - helps to create and mantain legend
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "powerbi-visuals-utils-chartutils",
-  "version": "6.0.4",
+  "version": "7.0.0-beta.1",
   "description": "ChartUtils",
   "main": "lib/index.js",
   "module": "lib/index.js",
@@ -72,7 +72,6 @@
     "d3-selection": "^3.0.0",
     "d3-transition": "^3.0.1",
     "powerbi-visuals-utils-formattingutils": "^6.1.1",
-    "powerbi-visuals-utils-interactivityutils": "^6.0.4",
     "powerbi-visuals-utils-svgutils": "^6.0.4",
     "powerbi-visuals-utils-typeutils": "^6.0.3"
   },

diff --git a/src/dataLabel/dataLabelUtils.ts b/src/dataLabel/dataLabelUtils.ts
@@ -49,10 +49,6 @@ import * as svg from "powerbi-visuals-utils-svgutils";
 import ClassAndSelector = svg.CssConstants.ClassAndSelector;
 import createClassAndSelector = svg.CssConstants.createClassAndSelector;
 
-// powerbi.extensibility.utils.interactivity
-import { interactivitySelectionService } from "powerbi-visuals-utils-interactivityutils";
-import SelectionDataPoint = interactivitySelectionService.SelectableDataPoint;
-
 import * as dataLabelInterfaces from "./dataLabelInterfaces";
 import LabelFormattedTextOptions = dataLabelInterfaces.LabelFormattedTextOptions;
 import LabelEnabledDataPoint = dataLabelInterfaces.LabelEnabledDataPoint;
@@ -216,7 +212,7 @@ export function drawDefaultLabelsForDataPointChart(data: any[], context: Selecti
             .transition("")
             .duration(animationDuration)
             // .style(layout.style as any)
-            .style("opacity", (hasSelection ? (d: SelectionDataPoint) => getFillOpacity(d.selected, false, hasSelection, false) : 1) as any)
+            .style("opacity", (hasSelection ? d => getFillOpacity(d.selected, false, hasSelection, false) : 1) as any)
             .attr(
                 "x", (d: LabelEnabledDataPoint) => d.labelX
             )
@@ -260,7 +256,7 @@ function selectLabels(filteredData: LabelEnabledDataPoint[], context: Selection<
     const getIdentifier = hasKey ?
         (d: any) => d.key
         : hasDataPointIdentity ?
-            (d: SelectionDataPoint) => (d.identity as ISelectionId).getKey()
+            d => (d.identity as ISelectionId).getKey()
             : undefined;
 
     const labels: Selection<any, any, any, any> = isDonut ?

diff --git a/src/index.ts b/src/index.ts
@@ -9,10 +9,7 @@ import DataLabelManager from "./dataLabel/dataLabelManager";
 import * as dataLabelUtils from "./dataLabel/dataLabelUtils";
 import * as locationConverter from "./dataLabel/locationConverter";
 
-import * as interactiveLegend from "./legend/interactiveLegend";
 import * as legend from "./legend/legend";
-import * as legendBehavior from "./legend/behavior/legendBehavior";
-import OpacityLegendBehavior from "./legend/behavior/opacityLegendBehavior";
 import * as legendData from "./legend/legendData";
 import * as legendInterfaces from "./legend/legendInterfaces";
 import * as legendPosition from "./legend/legendPosition";
@@ -30,11 +27,8 @@ export {
     DataLabelManager,
     dataLabelUtils,
     locationConverter,
-    interactiveLegend,
     label,
     legend,
-    legendBehavior,
-    OpacityLegendBehavior,
     legendData,
     legendInterfaces,
     legendPosition,

diff --git a/src/label/labelLayout.ts b/src/label/labelLayout.ts
@@ -32,17 +32,15 @@ import {
     IRect,
 } from "powerbi-visuals-utils-svgutils";
 
-import {
-    interactivitySelectionService
-} from "powerbi-visuals-utils-interactivityutils";
-
 import { FontProperties, inherit } from "./fontProperties";
 import * as LabelUtils from "./labelUtils";
 import * as Units from "./units";
 
 import * as DataLabelRectPositioner from "./dataLabelRectPositioner";
 import * as DataLabelPointPositioner from "./dataLabelPointPositioner";
 
+import { ISelectableDataPoint } from "../legend/legendInterfaces";
+
 export enum LabelOrientation {
     Vertical = 0,
     Horizontal = 1,
@@ -324,7 +322,7 @@ export interface LabelDataPointGroup<TLabelDataPoint> {
     labelOrientation?: LabelOrientation;
 }
 
-export interface Label extends interactivitySelectionService.SelectableDataPoint {
+export interface Label extends ISelectableDataPoint {
     /** Text to be displayed in the label */
     text: string;
 
@@ -363,7 +361,7 @@ export interface Label extends interactivitySelectionService.SelectableDataPoint
     backgroundTransparency?: number;
 }
 
-export interface LabelOld extends interactivitySelectionService.SelectableDataPoint {
+export interface LabelOld extends ISelectableDataPoint{
     /** Text to be displayed in the label */
     text: string;
 

diff --git a/src/legend/behavior/legendBehavior.ts b/src/legend/behavior/legendBehavior.ts