Skip to content

support textOverflow in tips with key/value pairs #2322

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 7 additions & 9 deletions src/marks/tip.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ export class Tip extends Mark {
frameAnchor,
format,
textAnchor = "start",
textOverflow,
textOverflow = "ellipsis",
textPadding = 8,
title,
pointerSize = 12,
Expand Down Expand Up @@ -90,7 +90,7 @@ export class Tip extends Mark {
const mark = this;
const {x, y, fx, fy} = scales;
const {ownerSVGElement: svg, document} = context;
const {anchor, monospace, lineHeight, lineWidth} = this;
const {anchor, monospace, lineHeight, lineWidth, textOverflow} = this;
const {textPadding: r, pointerSize: m, pathFilter} = this;
const {marginTop, marginLeft} = dimensions;

Expand Down Expand Up @@ -185,13 +185,11 @@ export class Tip extends Mark {
title = value.trim();
value = "";
} else {
if (label || (!value && !swatch)) value = " " + value;
const [k] = cut(value, w - widthof(label), widthof, ee);
if (k >= 0) {
// value is truncated
title = value.trim();
value = value.slice(0, k).trimEnd() + ellipsis;
}
const space = label || (!value && !swatch) ? " " : "";
const text = clipper({monospace, lineWidth: lineWidth - widthof(label + space) / 100, textOverflow})(value);
// value is truncated
if (text !== value) title = value.trim();
value = space + text;
}
const line = selection.append("tspan").attr("x", 0).attr("dy", `${lineHeight}em`).text("\u200b"); // zwsp for double-click
if (label) line.append("tspan").attr("font-weight", "bold").text(label);
Expand Down
31 changes: 31 additions & 0 deletions test/output/tipLongTextEllipsisEnd.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 31 additions & 0 deletions test/output/tipLongTextEllipsisMiddle.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 31 additions & 0 deletions test/output/tipLongTextEllipsisStart.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions test/plots/tip.ts
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,27 @@ export async function tipLongText() {
return Plot.tip([{x: "Long sentence that gets cropped after a certain length"}], {x: "x"}).plot();
}

export async function tipLongTextEllipsisEnd() {
return Plot.tip([{x: "Long sentence that gets clipped at the end after a certain length"}], {
x: "x",
textOverflow: "ellipsis" // "ellipsis-end"
}).plot();
}

export async function tipLongTextEllipsisMiddle() {
return Plot.tip([{x: "Long sentence that gets clipped in the middle after a certain length"}], {
x: "x",
textOverflow: "ellipsis-middle"
}).plot();
}

export async function tipLongTextEllipsisStart() {
return Plot.tip([{x: "Long sentence that gets clipped at the start after a certain length"}], {
x: "x",
textOverflow: "ellipsis-start"
}).plot();
}

export async function tipNewLines() {
return Plot.plot({
height: 40,
Expand Down