New bucket for tooltips, also added tests, and updated packages by v-aidaba · Pull Request #268 · microsoft/powerbi-visuals-streamgraph

v-aidaba · 2026-02-20T06:23:07Z

No description provided.

Copilot

Pull request overview

This PR adds a dedicated Tooltips data role/bucket for the StreamGraph visual and updates tooltip generation/binding so tooltips can be resolved per hovered stream point. It also bumps the visual version and updates dependencies, with new unit tests covering tooltip behavior.

Changes:

Added a new Tooltips data role + mapping support (and capability metadata for tooltip support).
Updated tooltip generation to support “explicit tooltips” (only Tooltip bucket fields when populated) and per-point tooltip resolution.
Added unit tests for tooltip fallback vs explicit tooltip bucket output, plus version/dependency updates.

Reviewed changes

Copilot reviewed 9 out of 10 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
`src/visual.ts`	Builds per-point tooltip info during conversion and binds pointer-based tooltip events.
`src/tooltipBuilder.ts`	Implements explicit-tooltip-column detection and tooltip item construction logic.
`capabilities.json`	Adds the `Tooltips` role, updates dataViewMappings to include it, and declares tooltip support.
`test/visualTest.ts`	Adds tests validating default tooltip fallback and explicit tooltip bucket behavior.
`stringResources/en-US/resources.resjson`	Adds `Visual_Tooltips` string for the new role label.
`src/dataInterfaces.ts`	Extends `StreamDataPoint` with optional `tooltipInfo`.
`pbiviz.json`	Bumps visual version/displayName to `3.3.0.0`.
`package.json` / `package-lock.json`	Dependency updates (including a `powerbi-visuals-api` version change).
`CHANGELOG.md`	Documents new tooltip bucket behavior + tests.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-26T08:32:20Z

@@ -1,3 +1,14 @@
+


There’s an extra leading blank line at the very top of the changelog entry, which makes the file start with an empty line. Removing it keeps the markdown formatting consistent and avoids odd rendering in some viewers.

Suggested change

Removed blank line

Copilot · 2026-02-26T08:32:21Z

+        // Tooltip binding extracted (same logic, cleaner update)
+        this.bindLayerTooltips(selection as any, this.data);


The tooltip handling was switched to use visualHost.tooltipService directly, but tooltipServiceWrapper is still created/stored and is now unused. Either remove the wrapper entirely (property + initialization + import) or keep using tooltipServiceWrapper.addTooltip(...) to avoid dead code and keep tooltip behavior consistent with the utils wrapper.

Suggested change

// Tooltip binding extracted (same logic, cleaner update)

this.bindLayerTooltips(selection as any, this.data);

// Tooltip binding: use the tooltipServiceWrapper to attach tooltips to the rendered layers

if (this.tooltipServiceWrapper) {

this.tooltipServiceWrapper.addTooltip(

selection as any,

(tooltipEvent: any) => this.getTooltipInfo(tooltipEvent.data, this.data),

(dataPoint: any) => dataPoint.identity,

true

);

}

Removed tooltipServiceWrapper since it is no longer used. In this case, it was rendering the tooltip in a stream-specific way and did not allow per-point tooltip handling, so I switched to using visualHost.tooltipService directly.

Copilot · 2026-02-26T08:32:21Z

+    private hideTooltip(): void {
+        this.visualHost.tooltipService.hide({ isTouchEvent: false, immediately: false });
+    }


hideTooltip() always calls tooltipService.hide with isTouchEvent: false. On touch interactions (where showOrMoveTooltip sets isTouchEvent based on event.pointerType), this can prevent the touch tooltip from being dismissed correctly. Consider passing through the pointer type (e.g., accept the triggering event in hideTooltip or track the last isTouchEvent value).

Updated the implementation to track the last isTouchEvent value, so hideTooltip() uses the correct interaction type as well.

Copilot · 2026-02-26T08:32:21Z

+                // Create tooltip info for this specific data point
+                const dataPointTooltipInfo: VisualTooltipDataItem[] = createTooltipInfo(
+                    dataView,
+                    { categories, values },
+                    localizationManager,
+                    valueIndex,
+                    dataPointValueIndex
+                );


Tooltip info is now being built for every data point during conversion (createTooltipInfo inside the inner values loop). For large datasets this is potentially expensive (formatting + role filtering per point). Consider computing tooltip items lazily on hover (or caching per column/index) so conversion remains O(n) without heavy per-point formatting.

Added caching for tooltip generation to avoid recomputing the same formatting work for each data point.

Copilot · 2026-02-26T08:32:21Z

 export function createTooltipInfo(
    dataView: DataView,
    dataViewCat: DataViewCategorical,
    localizationManager: ILocalizationManager,
-    seriesIndex?: number): VisualTooltipDataItem[] {
+    seriesIndex?: number,
+    categoryIndex?: number
+): VisualTooltipDataItem[] {


dataView is no longer used by createTooltipInfo/createTooltipData (it’s only forwarded), which triggers the repo’s @typescript-eslint/no-unused-vars rule for unused parameters. Either remove this parameter from both functions (and update call sites) or rename it to _dataView to explicitly mark it as intentionally unused.

Removed it , dataView is no longer used

Copilot · 2026-02-26T08:32:22Z

    "Visual_TitleText": "Title text",
+    "Visual_Tooltips": "Tooltips",
    "Visual_Tooltips_Highlighted": "Highlighted",


A new localization key Visual_Tooltips was added for en-US only. Other locales under stringResources/*/resources.resjson will be missing this key, which can cause the tooltip role label to fall back to the raw key or show blank in non-English locales. Please add the key to the other locale resource files (or implement a fallback strategy if that’s the project convention).

This key was added intentionally only for en-US. The other locale files are not required at this stage, since the remaining translations are handled later

Copilot · 2026-02-26T08:32:22Z

    "powerbi-models": "^2.0.1",
-    "powerbi-visuals-api": "5.11.0",
-    "powerbi-visuals-utils-chartutils": "^8.1.0",
+    "powerbi-visuals-api": "~5.7.0",


powerbi-visuals-api was changed from 5.11.0 to ~5.7.0, which is a downgrade (and also changes the pinning strategy). This can introduce API/type mismatches with powerbi-visuals-utils-* packages that depend on newer API versions and may result in multiple powerbi-visuals-api versions in the lockfile. Please confirm this downgrade is intentional; otherwise keep the API version aligned/up-to-date.

Suggested change

"powerbi-visuals-api": "~5.7.0",

"powerbi-visuals-api": "5.11.0",

Updated it and aligned the package version to the newer one

Demonkratiy · 2026-03-25T11:41:16Z

+            return hasExplicitTooltipFields ? [] : seriesData.tooltipInfo || [];
+        }
+
+        // Compute tooltip info lazily on first access


Am I right about following observation? In default mode (Tooltips bucket is empty), createTooltipInfo ignores categoryIndex - it builds the tooltip purely from the series column. Every data point of the same series produces identical output. However, the cache key is ${seriesIndex}-${pointIndex}, which creates N duplicate entries per series (one per hovered point).

For a dataset with 5 series × 365 points, the cache grows to 1825 entries instead of 5.

If I didn't missed something that could improve this:

// In default mode all points of the same series produce identical items, // so key by series only. In explicit mode each point can differ. const cacheKey = hasExplicitTooltipFields ? `${seriesIndex}-${pointIndex}` : `${seriesIndex}`;

Demonkratiy · 2026-03-25T12:05:58Z

+
+    private hasExplicitTooltipFields(dataView: DataView): boolean {
+        const categoricalData: DataViewCategorical | undefined = dataView?.categorical;
+        const hasTooltipsRole = (roles?: { [key: string]: boolean }): boolean => !!(roles && roles["Tooltips"]);


TooltipsRoleName is declared in tooltipBuilder.ts as a module-private const, so hasExplicitTooltipFields() in visual.ts independently hardcodes the same string "Tooltips". If the role name changes, one place will be missed silently.
Export TooltipsRoleName from tooltipBuilder.ts and:

// visual.ts - import { createTooltipInfo } from "./tooltipBuilder"; + import { createTooltipInfo, TooltipsRoleName } from "./tooltipBuilder"; // hasExplicitTooltipFields(): - const hasTooltipsRole = (roles?: ...) => !!(roles && roles["Tooltips"]); + const hasTooltipsRole = (roles?: ...) => !!(roles && roles[TooltipsRoleName]);

Demonkratiy · 2026-03-25T12:07:35Z

    "powerbi-visuals-utils-formattingutils": "^6.1.2",
    "powerbi-visuals-utils-interactivityutils": "^6.0.4",
    "powerbi-visuals-utils-svgutils": "^6.0.4",
    "powerbi-visuals-utils-tooltiputils": "^6.0.4",


so we don't plan to use powerbi-visuals-utils-tooltiputils anymore?

New bucket for tooltips, also added tests, and updated packages

47e5319

Demonkratiy requested a review from Copilot February 26, 2026 08:26

Copilot started reviewing on behalf of Demonkratiy February 26, 2026 08:27 View session

Copilot AI reviewed Feb 26, 2026

View reviewed changes

v-aidaba added 5 commits March 6, 2026 12:09

PR changes

0b8482f

changes to avoid build failures

70aae4b

upgrade powerbi-visuals-api

5630dff

downgrade eslint

41cb963

chnage node version

58094d9

Demonkratiy reviewed Mar 15, 2026

View reviewed changes

Comment thread src/visual.ts Outdated

Comment thread pbiviz.json Outdated

Comment thread pbiviz.json Outdated

Comment thread src/visual.ts Outdated

Pr changes fixed

bf64c7a

Demonkratiy reviewed Mar 25, 2026

View reviewed changes

PR chnages

5bbadc2

		// Tooltip binding extracted (same logic, cleaner update)
		this.bindLayerTooltips(selection as any, this.data);

-        // Tooltip binding extracted (same logic, cleaner update)
-        this.bindLayerTooltips(selection as any, this.data);
+        // Tooltip binding: use the tooltipServiceWrapper to attach tooltips to the rendered layers
+        if (this.tooltipServiceWrapper) {
+            this.tooltipServiceWrapper.addTooltip(
+                selection as any,
+                (tooltipEvent: any) => this.getTooltipInfo(tooltipEvent.data, this.data),
+                (dataPoint: any) => dataPoint.identity,
+                true
+            );
+        }

	"powerbi-visuals-api": "~5.7.0",
	"powerbi-visuals-api": "5.11.0",

Conversation

v-aidaba commented Feb 20, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants