Initial pass with hard-coded automargin params

hannahker · hannahker · commit 68c6165a137f · 2023-01-06T15:05:55.000-08:00
diff --git a/src/components/titles/index.js b/src/components/titles/index.js
@@ -77,6 +77,20 @@ function draw(gd, titleClass, options) {
     else if(prop.indexOf('colorbar' !== -1)) editAttr = 'colorbarTitleText';
     var editable = gd._context.edits[editAttr];
 
+    if(editAttr === 'titleText' && title.automargin === true) {
+        // TODO: Could there ever be more than one title?
+        var titleID = 'title.automargin';
+        Plots.allowAutoMargin(gd, titleID);
+        // TODO: Remove hard-coding
+        Plots.autoMargin(gd, titleID, {
+            x: 0.5,
+            y: 1,
+            l: 0,
+            r: 0,
+            t: 50,
+            b: 0});
+    }
+
     if(txt === '') opacity = 0;
     // look for placeholder text while stripping out numbers from eg X2, Y3
     // this is just for backward compatibility with the old version that had
diff --git a/src/plot_api/plot_api.js b/src/plot_api/plot_api.js
@@ -277,6 +277,7 @@ function _doPlot(gd, data, layout, config) {
 
         subroutines.drawMarginPushers(gd);
         Axes.allowAutoMargin(gd);
+        Plots.allowAutoMargin(gd, 'title.automargin');
 
         // TODO can this be moved elsewhere?
         if(fullLayout._has('pie')) {
diff --git a/src/plots/layout_attributes.js b/src/plots/layout_attributes.js
@@ -125,6 +125,15 @@ module.exports = {
                 'Padding is muted if the respective anchor value is *middle*/*center*.'
             ].join(' ')
         }),
+        automargin: {
+            valType: 'boolean',
+            dflt: false,
+            role: 'info',
+            editType: 'plot',
+            description: [
+                'Determines whether the title can automatically push the figure margins.'
+            ].join(' ')
+        },
         editType: 'layoutstyle'
     },
     uniformtext: {
diff --git a/src/plots/plots.js b/src/plots/plots.js
@@ -1489,6 +1489,7 @@ plots.supplyLayoutGlobalDefaults = function(layoutIn, layoutOut, formatObj) {
     coerce('title.pad.r');
     coerce('title.pad.b');
     coerce('title.pad.l');
+    coerce('title.automargin');
 
     var uniformtextMode = coerce('uniformtext.mode');
     if(uniformtextMode) {
diff --git a/test/image/mocks/zz-automargin-title.json b/test/image/mocks/zz-automargin-title.json
@@ -0,0 +1,31 @@
+{
+    "data": [
+        {
+            "showlegend": false,
+            "type": "scatter",
+            "x": [
+            1,
+            2,
+            3
+            ],
+            "y": [
+            4,
+            5,
+            6
+            ]
+        }],
+    "layout": {
+        "margin": {"t":0, "b": 0, "l": 0, "r": 0},
+        "yaxis": {
+        "automargin": true,
+        "title": {"text": "Y-axis"}
+        },
+        "xaxis": {"automargin": true,
+        "title": {"text": "X-axis"}
+        },
+        "title": {
+            "automargin": true, 
+            "text": "Some text"
+        }
+  }
+}
diff --git a/test/plot-schema.json b/test/plot-schema.json
@@ -9425,6 +9425,13 @@
     }
    },
    "title": {
+    "automargin": {
+     "description": "Determines whether the title can automatically push the figure margins.",
+     "dflt": false,
+     "editType": "plot",
+     "role": "info",
+     "valType": "boolean"
+    },
     "editType": "layoutstyle",
     "font": {
      "color": {
