rmapi-js 11.1.0 → 11.1.2

package/dist/index.d.ts

@@ -317,12 +317,15 @@ export interface RemarkableApi {
      * centers are in those pixels.
      *
      * The view always has the device's aspect ratio — you control its height and
-     * position, not its shape. `customZoomScale` is a fit-to-height zoom: at `1`
-     * the page height fills the screen, and the linear magnification is
-     * `customZoomScale` squared. `customZoomCenterX` offsets the center of the
-     * view horizontally from the page center, and `customZoomCenterY` is the
-     * absolute distance of the center down from the top of the page; the view's
-     * width follows from its height and the device aspect ratio.
+     * position, not its shape. `customZoomScale = screenHeight / viewHeight` in
+     * device pixels (`screenHeight` fixed per model, see {@link deviceScreens |
+     * `deviceScreens`}), normalized to 1:1 native pixels: at `1` the view is
+     * screen-tall, showing `screenHeight / customZoomPageHeight` of the page.
+     *
+     * `customZoomCenterX` offsets the center of the view horizontally from the
+     * page center, and `customZoomCenterY` is the absolute distance of the center
+     * down from the top of the page; the view's width follows from its height and
+     * the device aspect ratio.
      *
      * The fields are a single document-wide setting, but `customZoomCenterY` is
      * applied against each page's own rendered height. On a page rendered taller

package/dist/raw.d.ts

@@ -256,10 +256,10 @@ export interface CommonDocumentContent {
     /**
      * the scale for a customFit zoom
      *
-     * Calibrated on the page's fit-to-height: at 1 the rendered page height fills
-     * the screen and the linear magnification is customZoomScale squared. 1
-     * indicates no zoom; reMarkable generally allows 0.5 to 5, but values outside
-     * that bound are still supported.
+     * `customZoomScale = screenHeight / viewHeight` in device pixels, normalized to
+     * 1:1 native pixels: at 1 the view is screen-tall, showing `screenHeight /
+     * customZoomPageHeight` of the page. reMarkable generally allows 0.5 to 5, but
+     * values outside that bound are still supported.
      */
     customZoomScale?: number;
     /** the zoom mode; customFit applies the customZoom* fields, the rest auto-fit */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rmapi-js",
-  "version": "11.1.0",
+  "version": "11.1.2",
   "description": "JavaScript implementation of the reMarkable 1.5 api",
   "repository": {
     "type": "git",