Skip to content

Missing tooltip data #2753

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
texodus merged 4 commits into from
Oct 29, 2024
Merged

Missing tooltip data #2753

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
751d5ae
Fix missing/invalid tooltip data
wakek Sep 16, 2024
5f71ef3
Run prettier on changed file
wakek Sep 16, 2024
9d843a1
Update tooltip fix to cover more complex scenarios
wakek Oct 21, 2024
99c6dcc
Add tests for tooltip fix
wakek Oct 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 34 additions & 1 deletion packages/perspective-viewer-d3fc/src/ts/tooltip/selectionData.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,10 @@ export function getDataValues(data, settings) {
}
return settings.mainValues.map((main) => ({
name: main.name,
value: toValue(main.type, data.row[main.name]),
value: toValue(
main.type,
data.row[getDataRowKey(data.key, main, settings.realValues)]
),
}));
}
return [
Expand All @@ -86,3 +89,33 @@ export function getDataValues(data, settings) {
},
];
}

function getDataRowKey(key, main, realValues) {
if (!key) {
return main.name;
}

if (key.includes("|")) {
const splitKey = key.split("|");
const keyIncludesValidValueName =
splitKey[splitKey.length - 1] === main.name;

if (keyIncludesValidValueName) {
return key;
}

const keyIncludesInvalidValueName = realValues.includes(
splitKey[splitKey.length - 1]
);

const validKeyPrefix = keyIncludesInvalidValueName
? splitKey.slice(0, splitKey.length - 1).join("|")
: key;

return `${validKeyPrefix}|${main.name}`;
}

const keyIsRealValue = realValues.includes(key);

return keyIsRealValue ? main.name : `${key}|${main.name}`;
}
133 changes: 133 additions & 0 deletions packages/perspective-viewer-d3fc/test/js/splitby.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
// ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
// ┃ ██████ ██████ ██████ █ █ █ █ █ █▄ ▀███ █ ┃
// ┃ ▄▄▄▄▄█ █▄▄▄▄▄ ▄▄▄▄▄█ ▀▀▀▀▀█▀▀▀▀▀ █ ▀▀▀▀▀█ ████████▌▐███ ███▄ ▀█ █ ▀▀▀▀▀ ┃
// ┃ █▀▀▀▀▀ █▀▀▀▀▀ █▀██▀▀ ▄▄▄▄▄ █ ▄▄▄▄▄█ ▄▄▄▄▄█ ████████▌▐███ █████▄ █ ▄▄▄▄▄ ┃
// ┃ █ ██████ █ ▀█▄ █ ██████ █ ███▌▐███ ███████▄ █ ┃
// ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┫
// ┃ Copyright (c) 2017, the Perspective Authors. ┃
// ┃ ╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌ ┃
// ┃ This file is part of the Perspective library, distributed under the terms ┃
// ┃ of the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). ┃
// ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛

import { expect, test } from "@finos/perspective-test";

test.describe("Tooltip data values with various 'Split By' configurations", () => {
test("Show valid tooltip data with no 'Split By' configuration", async ({
page,
}) => {
await page.goto("/tools/perspective-test/src/html/basic-test.html");
await page.evaluate(async () => {
while (!window["__TEST_PERSPECTIVE_READY__"]) {
await new Promise((x) => setTimeout(x, 10));
}
});

await page.evaluate(async () => {
await document.querySelector("perspective-viewer")!.restore({
plugin: "X/Y Line",
settings: true,
columns: ["Row ID", "Postal Code", null],
group_by: [],
split_by: [],
});
});

await page.hover(
"#container > d3fc-group > d3fc-svg.svg-plot-area.plot-area > svg > g:nth-child(2) > g > g:nth-child(1) > g > path",
{
force: true,
}
);
await page.waitForSelector("#tooltip-values > li:nth-child(1)");

let tooltip_row_id_value = await page.evaluate(async () => {
return document
.querySelector("perspective-viewer-d3fc-xyline")
?.shadowRoot?.querySelector(
"#tooltip-values > li:nth-child(2) > b"
)?.textContent;
});

expect(tooltip_row_id_value).toBeTruthy();
expect(tooltip_row_id_value).toMatch(/^(?!NaN$|-$).+$/);
});
test("Show valid tooltip data with one 'Split By' configuration", async ({
page,
}) => {
await page.goto("/tools/perspective-test/src/html/basic-test.html");
await page.evaluate(async () => {
while (!window["__TEST_PERSPECTIVE_READY__"]) {
await new Promise((x) => setTimeout(x, 10));
}
});

await page.evaluate(async () => {
await document.querySelector("perspective-viewer")!.restore({
plugin: "X/Y Line",
settings: true,
columns: ["Row ID", "Postal Code", null],
group_by: [],
split_by: ["Sub-Category"],
});
});

await page.hover(
"#container > d3fc-group > d3fc-svg.svg-plot-area.plot-area > svg > g:nth-child(2) > g > g:nth-child(1) > g > path",
{
force: true,
}
);
await page.waitForSelector("#tooltip-values > li:nth-child(2)");

let tooltip_row_id_value = await page.evaluate(async () => {
return document
.querySelector("perspective-viewer-d3fc-xyline")
?.shadowRoot?.querySelector(
"#tooltip-values > li:nth-child(2) > b"
)?.textContent;
});

expect(tooltip_row_id_value).toBeTruthy();
expect(tooltip_row_id_value).toMatch(/^(?!NaN$|-$).+$/);
});
test("Show valid tooltip data with multiple 'Split By' configuration", async ({
page,
}) => {
await page.goto("/tools/perspective-test/src/html/basic-test.html");
await page.evaluate(async () => {
while (!window["__TEST_PERSPECTIVE_READY__"]) {
await new Promise((x) => setTimeout(x, 10));
}
});

await page.evaluate(async () => {
await document.querySelector("perspective-viewer")!.restore({
plugin: "X/Y Line",
settings: true,
columns: ["Row ID", "Postal Code", null],
group_by: [],
split_by: ["Sub-Category", "Segment"],
});
});

await page.hover(
"#container > d3fc-group > d3fc-svg.svg-plot-area.plot-area > svg > g:nth-child(2) > g > g:nth-child(1) > g > path",
{
force: true,
}
);
await page.waitForSelector("#tooltip-values > li:nth-child(3)");

let tooltip_row_id_value = await page.evaluate(async () => {
return document
.querySelector("perspective-viewer-d3fc-xyline")
?.shadowRoot?.querySelector(
"#tooltip-values > li:nth-child(2) > b"
)?.textContent;
});

expect(tooltip_row_id_value).toBeTruthy();
expect(tooltip_row_id_value).toMatch(/^(?!NaN$|-$).+$/);
});
});