Add subtitle to plots

[emilykl]

Closes #6856

Adds ability to add a subtitle to plots.

• Able to add subtitle using the following API:

    "layout": {
        "title": {
            "text": "A simple plot",
            "subtitle": {
                "text": "With a subtitle"
            }

• Ability to change the font options of the subtitle by passing font options to layout.title.subtitle.font
• Ability to edit the subtitle when editable: true

[archmoj]

• Subtitle should wrap automatically onto new lines when too long (maybe? Ideally yes but this is complicated)

I think word wrap is out of the scope of this PR. cc: #382

[archmoj]

@emilykl Do you think that the height of subtitle should push the margins?
In your example if I set subtitle.text: '1st<br>2nd<br>3rd<br>4th' the subtitle would go over the cartesian subplot area.

[archmoj]

This is quite minor.
But I noticed when config.editable is set to true and having an empty subtitle I get a black subtitle instead of gray on Click to enter Plot subtitle.

        "title": {
            "text": "A simple plot",
            "subtitle": {
                "text": ""
            }
        },

[archmoj]

Just addressed a baseline update in #7019.
Please pull master and merge it into this branch.
Thank you!

[emilykl]

@emilykl Do you think that the height of subtitle should push the margins? In your example if I set subtitle.text: '1st<br>2nd<br>3rd<br>4th' the subtitle would go over the cartesian subplot area.

@archmoj I would say "Yes, obviously", except that it looks like currently, even the height of the title doesn't push the margins -- if you add too many lines to the title, it will overlap the chart (see codepen).

So I think if we make the subtitle push the margins dynamically, we need to make that the behavior for the title as well.

I guess the other option would be to push the margin by a fixed amount if there is a subtitle present. I'm not sure whether that's necessary though; the current amount of space looks OK to me if the subtitle is one or two lines.

[emilykl]

This is quite minor. But I noticed when config.editable is set to true and having an empty subtitle I get a black subtitle instead of gray on Click to enter Plot subtitle.

good catch, thanks. Do you know where this styling is set in the code?

I think this is probably also related to the bug I noticed where the size of the text currently being edited is too large for the subtitle.

[archmoj]

For subtitles please add a French (or other languages that you know) translation to lib/locales e.g. here:

plotly.js/lib/locales/fr.js

Line 13 in caf32e5

'Click to enter Plot title': 'Ajouter un titre au graphique',

[emilykl]

Also a mock like 19 that has a tile.text: 'Click to enter Plot title' it does not render a subtitle unless one changes the title!

@archmoj Good catch. I've modified the logic so that the subtitle is rendered even if there is no title (or the title is just a placeholder). But the placement is a bit odd since the subtitle is positioned according to the height of the title, and the title height is 0. Would you suggest any changes here? I'm inclined to leave as-is since this is a pretty rare edge case and doing anything more complicated would be kind of tricky and involve a bunch of extra logic.

[archmoj]

Also a mock like 19 that has a tile.text: 'Click to enter Plot title' it does not render a subtitle unless one changes the title!

@archmoj Good catch. I've modified the logic so that the subtitle is rendered even if there is no title (or the title is just a placeholder). But the placement is a bit odd since the subtitle is positioned according to the height of the title, and the title height is 0. Would you suggest any changes here? I'm inclined to leave as-is since this is a pretty rare edge case and doing anything more complicated would be kind of tricky and involve a bunch of extra logic.

If an empty title (title: '') renders similar to a blank title (title: ' ') then yes this should be the correct behavior IMHO.

[archmoj]

Similarly on the worldcup mock the positioning of subtitle could be improved.

This one is fixed now.

[archmoj]

Although I kind of like the current positioning of subtitle which is compact;
I was wondering the correct value for this constant might be 1.3

plotly.js/src/constants/alignment.js

Line 34 in 8b1f5bd

LINE_SPACING: 1.3,

This is why:
If I call

Plotly.newPlot(gd, [{y: [1, 2]}], {title: {text: 'title', subtitle: {text: 'subtittle'}}});

the subtitle render closer compared to when I call

Plotly.newPlot(gd, [{y: [1, 2]}], {title: {text: 'title<br><sub>subtittle</sub>'}}); 

So perhaps you could try using (LINE_SPACING - 1) * title.font.size in your calculations?

[emilykl]

@archmoj Do you think the subtitle looks better with additional spacing?

I'd prefer not to change the spacing just to match the appearance of <sub>, since that spacing is arbitrary.

I prefer the more compact look.

[archmoj]

Mock 28 has a title stating with a <br>. When the subtitle is added the position of it is not under the title.

This renders OK now after the fixes.
Thanks!

[archmoj]

@emilykl Would you try taking into account the height of subtitle text in the automargin calculations?

[LiamConnors]

@emilykl Do any of the property values inherit from layout.title?
Also, layout.title.subtitle.font.size is 70% of layout.title.font.size unless set?

[emilykl]

@emilykl Would you try taking into account the height of subtitle text in the automargin calculations?

@archmoj Yes I am working on it, it's a bit tricky as the code for the automargin is pretty convoluted

[archmoj]

Thanks @emilykl for this great PR 🏆
💃

[hannahker]

Wow thanks @archmoj @emilykl I was literally just looking for this feature this morning! 🥳

[Priyanshi3005]

Thanks for this feature!