Merge pull request #254 from plotly/dash-preview-landscape

dash-preview: swap browser window's width and height if landscape

Author: antoinerg

src/component/plotly-dash-preview/parse.js

@@ -65,6 +65,11 @@ function parse (body, req, opts, sendToRenderer) {
     )
   }
 
+  // Change browser size orientation if landscape
+  if (result.pdfOptions.landscape) {
+    result.browserSize = { width: result.browserSize.height, height: result.browserSize.width }
+  }
+
   // BrowserWindow only accepts integer values:
   result.browserSize['width'] = Math.ceil(result.browserSize['width'])
   result.browserSize['height'] = Math.ceil(result.browserSize['height'])

test/unit/plotly-dash-preview_test.js

@@ -46,7 +46,7 @@ tap.test('parse:', t => {
       })
     })
 
-    function assertEqualSize (browserSize, pageSize) {
+    function assertEqualSize (browserSize, pageSize, landscape) {
       // Browser size is always integer pixels
       var bW = browserSize.width
       var bH = browserSize.height
@@ -64,36 +64,55 @@ tap.test('parse:', t => {
       // Round
       pW = Math.ceil(pW)
       pH = Math.ceil(pH)
-      t.equal(bW, pW, 'browser and page should have the same width')
-      t.equal(bH, pH, 'browser and page should have the same height')
+      t.equal(bW, landscape ? pH : pW, 'browser and page should have the same width')
+      t.equal(bH, landscape ? pW : pH, 'browser and page should have the same height')
     }
 
     // Browser size and page size should be the same assuming a DPI of 96
     // to make sure plotly.js figures are appropriately sized right away for print
     [
+      // [pageSize defined at top-level?, pageSize, landscape?]
       [true, { height: 1000, width: 1000 }],
       [true, 'Letter'],
       [false, { height: 1000, width: 1000 }],
-      [false, 'Letter']
+      [false, 'Letter'],
+      [true, { height: 1000, width: 1000 }, true],
+      [true, 'Letter', true],
+      [false, { height: 1000, width: 1000 }, true],
+      [false, 'Letter', true]
     ].forEach(arg => {
       var toplevel = arg[0]
       var pageSize = arg[1]
+      var landscape = arg[2]
       t.test(`should size window and page properly when ${toplevel ? '' : 'pdf_options.'}pageSize is given`, t => {
         var body = mock()
         if (toplevel) {
           body.pageSize = pageSize
+          body.pdf_options = {}
         } else {
           body.pdf_options = { pageSize: pageSize }
         }
+        if (landscape) body.pdf_options.landscape = landscape
         fn(body, {}, {}, (errorCode, result) => {
           t.equal(errorCode, null)
           t.same(result.pdfOptions.pageSize, pageSize)
-          assertEqualSize(result.browserSize, result.pdfOptions.pageSize)
+          assertEqualSize(result.browserSize, result.pdfOptions.pageSize, landscape)
           t.end()
         })
       })
     })
 
+    t.test('pdf_options.pageSize overrides top-level pageSize', t => {
+      var body = mock()
+      body.pageSize = { height: 1000, width: 1000 }
+      body.pdf_options = { pageSize: { height: 2000, width: 2000 } }
+      fn(body, {}, {}, (errorCode, result) => {
+        t.equal(errorCode, null)
+        t.same(result.browserSize, { height: 8, width: 8 })
+        t.end()
+      })
+    })
+
     t.test('should passthrough pdf_options', t => {
       var body = mock()
       body.pdf_options = { pageSize: 'Letter', marginsType: 1, crazyOptions: true }