Fixed #5927 - Now remembers page rotation on reload #5949

mbbaig · 2015-04-19T22:22:05Z

Fix for #5927

timvandermeij · 2015-04-19T22:49:02Z

/botio-linux preview

pdfjsbot · 2015-04-19T22:49:02Z

From: Bot.io (Linux)

Received

Command cmd_preview from @timvandermeij received. Current queue size: 0

Live output at: http://107.21.233.14:8877/4b6e97818553124/output.txt

pdfjsbot · 2015-04-19T22:49:49Z

From: Bot.io (Linux)

Success

Full output at http://107.21.233.14:8877/4b6e97818553124/output.txt

Total script time: 0.78 mins

Published

Snuffleupagus · 2015-04-19T22:50:45Z

web/viewer.js

@@ -1786,7 +1789,8 @@ window.addEventListener('updateviewarea', function () {
      'page': location.pageNumber,
      'zoom': location.scale,
      'scrollLeft': location.left,
-      'scrollTop': location.top
+      'scrollTop': location.top,
+      'pageRotation': PDFViewerApplication.pdfViewer.pagesRotation


I think you should add rotation: this._pagesRotation at pdf_viewer.js#L572 instead, and change this line to 'rotation': location.rotation.

Snuffleupagus · 2015-04-19T22:52:05Z

When testing this locally, and in the preview, the following is printed in the console:

"pdfViewSetScale: '0' is an unknown zoom value." viewer.js:4483:1

Snuffleupagus · 2015-04-19T22:55:35Z

web/viewer.js

@@ -902,6 +902,9 @@ var PDFViewerApplication = {
          var left = store.get('scrollLeft', '0');
          var top = store.get('scrollTop', '0');

+          self.pageRotation = store.get('pageRotation', '0');
+          self.pdfViewer.pagesRotation = self.pageRotation;


Unfortunately this won't work, since it breaks the thumbnails (and it's probably related to the console error). I believe that you need to use PDFViewerApplication.rotatePages instead, see viewer.js#L1326.

Edit: To avoid unnecessary operations, you should probably do e.g.

var rotation = store.get('rotation', '0'); if (rotation !== self.pageRotation) { self.rotatePages(rotation); }

Edit2: Also, just calling PDFViewerApplication.rotatePages here would cause unnecessary rendering/scrolling, so we might want to modify that function slightly to be able to avoid that.

Snuffleupagus · 2015-04-19T23:10:56Z

A more general question: I'm well aware that rotation isn't specified in the "Open parameters", but do we want to expose it as a hash parameter?

mbbaig · 2015-04-20T00:07:13Z

I made all of the changes mentioned.

I changed the PDFViewerApplication.rotatePages function to the following:

rotatePages: function pdfViewRotatePages(delta) {
    this.pageRotation = (this.pageRotation + 360 + delta) % 360;
    this.pdfViewer.pagesRotation = this.pageRotation;
    this.pdfThumbnailViewer.pagesRotation = this.pageRotation;

    this.forceRendering();
  }

As for the error. It occurs because this._currentScaleValue is set to '0'. Here is the location pdf_viewer.js#L201

I can't see where that is being set to '0'.

mbbaig · 2015-04-20T00:14:12Z

@Snuffleupagus I think exposing the rotation as a parameter couldn't hurt. It would also make the code consistent here viewer.js#905. We could simply add rotation into storedHash

Snuffleupagus · 2015-04-20T08:19:16Z

web/pdf_viewer.js

@@ -197,7 +197,6 @@ var PDFViewer = (function pdfViewer() {
        var page = this.pages[i];
        page.update(page.scale, rotation);
      }
-


This change is unrelated to the patch, please revert it.

Snuffleupagus · 2015-04-20T08:27:57Z

I changed the PDFViewerApplication.rotatePages function to the following:

I'm sorry, but changing it in this way will first of all break other functionality, and second of all not actually achieve the desired goal! What you should do is e.g. something like this:

rotatePages: function pdfViewRotatePages(delta, noRendering) {
  var pageNumber = this.page;
  this.pageRotation = (this.pageRotation + 360 + delta) % 360;
  this.pdfViewer.pagesRotation = this.pageRotation;
  this.pdfThumbnailViewer.pagesRotation = this.pageRotation;

  if (!noRendering) {
    this.forceRendering();

    this.pdfViewer.scrollPageIntoView(pageNumber);
  }
},

Then you can call self.rotatePage(rotation, true) when you've read the parameter from storage.

As for the error. It occurs because this._currentScaleValue is set to '0'. Here is the location pdf_viewer.js#L201
I can't see where that is being set to '0'.

You are probably trying to change the rotation before the document/viewer has been properly initialized.

mbbaig · 2015-04-20T17:02:34Z

@Snuffleupagus updated to code to your specifications moved to code to after init so no more error.

Snuffleupagus · 2015-04-20T18:06:21Z

moved to code to after init so no more error.

Unfortunately I don't think that is going to work correctly either, since I still believe that you need to set the rotation before setInitialView/setHash is called for the position to actually be correct. More investigation/debugging seems necessary here, unfortunately.

mbbaig · 2015-04-24T02:45:06Z

web/viewer.js

@@ -901,6 +902,12 @@ var PDFViewerApplication = {
                     store.get('zoom', self.pdfViewer.currentScale);
          var left = store.get('scrollLeft', '0');
          var top = store.get('scrollTop', '0');
+          rotation = store.get('rotation', '0');
+
+          self.setScale(DEFAULT_SCALE, true);


I am now setting the scale and moved the code back to its original spot. There is no error. Can this be considered a viable solution?

Can this be considered a viable solution?

In my opinion, no. This patch tries to add a minor feature, hence I don't think that unconditionally triggering an unnecessary rendering operation during every document load is a particularly good thing to do.

Given that the error isn't really a breaking error, but just a console message, I'd remove this line and try something else instead: Try changing https://github.com/mozilla/pdf.js/blob/master/web/pdf_viewer.js#L201 to

if (this._currentScale !== UNKNOWN_SCALE) this._setScale(this._currentScaleValue, true); }

If this seem to work: please make sure that you test the patch thoroughly, to ensure first of all that it does not regress other functionality, and second of all that the rotation works as intended!

mbbaig · 2015-04-24T16:27:50Z

updated and tested. seems to work fine with no errors

timvandermeij · 2015-05-13T21:27:46Z

web/viewer.js

+          var rotation = store.get('rotation', '0') | 0;
+
+          if (rotation !== self.pageRotation) {
+            self.rotatePages(rotation,true);


Nit: add a space after the ,, i.e., self.rotatePages(rotation, true);

Optimized code for rotation bug

xlc · 2015-06-09T04:19:23Z

@Snuffleupagus Can you have a look and maybe merge this?

brendandahl · 2016-01-12T01:07:03Z

web/pdf_viewer.js

@@ -198,7 +198,9 @@ var PDFViewer = (function pdfViewer() {
        page.update(page.scale, rotation);
      }

-      this._setScale(this._currentScaleValue, true);
+      if (this._currentScale !== UNKNOWN_SCALE) {


Why is this change needed?

brendandahl · 2016-01-12T01:29:21Z

Needs a rebase and comments addressed.

timvandermeij · 2016-02-12T20:41:37Z

Closing in favor of #6980.

timvandermeij added the viewer label Apr 19, 2015

Snuffleupagus reviewed Apr 19, 2015
View reviewed changes

Snuffleupagus reviewed Apr 20, 2015
View reviewed changes

Snuffleupagus added the 4-work-in-progress label Apr 20, 2015

mbbaig reviewed Apr 24, 2015
View reviewed changes

timvandermeij reviewed May 13, 2015
View reviewed changes

Now remembers page rotation on reload

69d09ef

Optimized code for rotation bug

timvandermeij removed the 4-work-in-progress label Jun 9, 2015

brendandahl reviewed Jan 12, 2016
View reviewed changes

brendandahl self-assigned this Jan 12, 2016

timvandermeij mentioned this pull request Jan 29, 2016

Somehow store whether the contents/thumbnail sidebar is open #6935

Closed

yurydelendik mentioned this pull request Feb 12, 2016

Fix #5927 [again] using solution from #5949 #6978

Closed

thepulkitagarwal mentioned this pull request Feb 12, 2016

Fix #5927: Page Rotation is saved for reload #6980

Closed

timvandermeij closed this Feb 12, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixed #5927 - Now remembers page rotation on reload #5949

Fixed #5927 - Now remembers page rotation on reload #5949

mbbaig commented Apr 19, 2015

timvandermeij commented Apr 19, 2015

pdfjsbot commented Apr 19, 2015

pdfjsbot commented Apr 19, 2015

Snuffleupagus Apr 19, 2015

Snuffleupagus commented Apr 19, 2015

Snuffleupagus Apr 19, 2015

Snuffleupagus commented Apr 19, 2015

mbbaig commented Apr 20, 2015

mbbaig commented Apr 20, 2015

Snuffleupagus Apr 20, 2015

Snuffleupagus commented Apr 20, 2015

mbbaig commented Apr 20, 2015

Snuffleupagus commented Apr 20, 2015

mbbaig Apr 24, 2015

Snuffleupagus Apr 24, 2015

mbbaig commented Apr 24, 2015

timvandermeij May 13, 2015

xlc commented Jun 9, 2015

brendandahl Jan 12, 2016

brendandahl commented Jan 12, 2016

timvandermeij commented Feb 12, 2016

Fixed #5927 - Now remembers page rotation on reload #5949

Fixed #5927 - Now remembers page rotation on reload #5949

Conversation

mbbaig commented Apr 19, 2015

timvandermeij commented Apr 19, 2015

pdfjsbot commented Apr 19, 2015

From: Bot.io (Linux)

Received

pdfjsbot commented Apr 19, 2015

From: Bot.io (Linux)

Success

Published

Snuffleupagus Apr 19, 2015

Choose a reason for hiding this comment

Snuffleupagus commented Apr 19, 2015

Snuffleupagus Apr 19, 2015

Choose a reason for hiding this comment

Snuffleupagus commented Apr 19, 2015

mbbaig commented Apr 20, 2015

mbbaig commented Apr 20, 2015

Snuffleupagus Apr 20, 2015

Choose a reason for hiding this comment

Snuffleupagus commented Apr 20, 2015

mbbaig commented Apr 20, 2015

Snuffleupagus commented Apr 20, 2015

mbbaig Apr 24, 2015

Choose a reason for hiding this comment

Snuffleupagus Apr 24, 2015

Choose a reason for hiding this comment

mbbaig commented Apr 24, 2015

timvandermeij May 13, 2015

Choose a reason for hiding this comment

xlc commented Jun 9, 2015

brendandahl Jan 12, 2016

Choose a reason for hiding this comment

brendandahl commented Jan 12, 2016

timvandermeij commented Feb 12, 2016