Skip to content

Fix subtitle does not properly clear/remove from the chart #7571

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
emilykl merged 3 commits into from
Oct 8, 2025
Merged

Fix subtitle does not properly clear/remove from the chart #7571

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
270613c
fix(layout-subtitle): fix `layout.title.subtitle` does not properly c…
cminn10 Oct 5, 2025
2ddb7fa
Add draftlog for #7571
cminn10 Oct 5, 2025
21562ef
test(layout-subtitle): add test case
cminn10 Oct 8, 2025
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
Prev Previous commit
test(layout-subtitle): add test case
  • Loading branch information
@cminn10
cminn10 committed Oct 8, 2025
commit 21562ef15f77d56a7c7cda34d0d8202ac5a12255
92 changes: 92 additions & 0 deletions test/jasmine/tests/titles_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1027,6 +1027,98 @@ describe('Title automargining', function() {
});
});

describe("Subtitle clearing via relayout", function () {
"use strict";

var data = [{ x: [1, 2, 3], y: [1, 2, 3] }];
var gd;

beforeEach(function () {
gd = createGraphDiv();
});

afterEach(destroyGraphDiv);

it("should properly clear subtitle when set to null", function (done) {
Plotly.newPlot(gd, data, {
title: {
text: "Main Title",
subtitle: { text: "Subtitle Text" },
},
})
.then(function () {
var subtitleSel = d3Select(".gtitle-subtitle");
expect(subtitleSel.empty()).toBe(
false,
"Subtitle should exist initially"
);
expect(subtitleSel.text()).toBe("Subtitle Text");

return Plotly.relayout(gd, { "title.subtitle.text": null });
})
.then(function () {
var subtitleSel = d3Select(".gtitle-subtitle");
expect(subtitleSel.empty()).toBe(
true,
"Subtitle should be removed when set to null"
);
})
.then(done, done.fail);
});

it("should properly clear subtitle when set to empty string", function (done) {
Plotly.newPlot(gd, data, {
title: {
text: "Main Title",
subtitle: { text: "Subtitle Text" },
},
})
.then(function () {
var subtitleSel = d3Select(".gtitle-subtitle");
expect(subtitleSel.empty()).toBe(
false,
"Subtitle should exist initially"
);

return Plotly.relayout(gd, { "title.subtitle.text": "" });
})
.then(function () {
var subtitleSel = d3Select(".gtitle-subtitle");
expect(subtitleSel.empty()).toBe(
true,
"Subtitle should be removed when set to empty string"
);
})
.then(done, done.fail);
});

it("should properly clear subtitle when set to whitespace", function (done) {
Plotly.newPlot(gd, data, {
title: {
text: "Main Title",
subtitle: { text: "Subtitle Text" },
},
})
.then(function () {
var subtitleSel = d3Select(".gtitle-subtitle");
expect(subtitleSel.empty()).toBe(
false,
"Subtitle should exist initially"
);

return Plotly.relayout(gd, { "title.subtitle.text": " " });
})
.then(function () {
var subtitleSel = d3Select(".gtitle-subtitle");
expect(subtitleSel.empty()).toBe(
true,
"Subtitle should be removed when set to whitespace"
);
})
.then(done, done.fail);
});
});

function expectTitle(expTitle) {
expectTitleFn(expTitle)();
}
Expand Down