@micrio/client 7.0.12 → 7.0.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/micrio.min.d.ts CHANGED
@@ -1340,7 +1340,7 @@ declare module '@micrio/client' {
1340
1340
  }
1341
1341
 
1342
1342
  /** Names of all icons available in the Micrio UI icon library. */
1343
- export type IconName = ('zoomIn' | 'zoomOut' | 'fullscreenEnter' | 'fullscreenLeave' | 'close' | 'next' | 'down' | 'prev' | 'up' | 'play' | 'pause' | 'subtitles' | 'subtitlesOff' | 'muted' | 'unmuted' | 'playFilled' | 'a11y' | 'menu' | 'audio' | 'video' | 'share' | 'error' | 'chevronDown' | 'link' | 'linkExt' | 'ellipsisVertical' | 'image' | 'layerGroup');
1343
+ export type IconName = ('zoomIn' | 'zoomOut' | 'fullscreenEnter' | 'fullscreenLeave' | 'close' | 'next' | 'down' | 'prev' | 'up' | 'rotateLeft' | 'rotateRight' | 'play' | 'pause' | 'subtitles' | 'subtitlesOff' | 'muted' | 'unmuted' | 'playFilled' | 'a11y' | 'menu' | 'audio' | 'video' | 'share' | 'error' | 'chevronDown' | 'link' | 'linkExt' | 'ellipsisVertical' | 'image' | 'layerGroup');
1344
1344
 
1345
1345
  /**
1346
1346
  * # Store API in Micrio
@@ -1981,6 +1981,13 @@ declare module '@micrio/client' {
1981
1981
  _getViewMatrix(): Mat4;
1982
1982
  _setFreeCamMode(on: boolean): void;
1983
1983
  _rotate(deltaTheta: number, deltaPhi: number, clampPhi?: boolean): void;
1984
+ /**
1985
+ * Rotates the view by a 90° step (`π/2`) around the vertical axis to either
1986
+ * side: `+1` turns clockwise (right), `-1` counter-clockwise (left). The
1987
+ * current target azimuth is snapped to the nearest 90° grid point first, so
1988
+ * the view always rests on a 90° increment even after a free-drag orbit.
1989
+ */
1990
+ _rotateViewStep(direction: 1 | -1): void;
1984
1991
  _getPickRay(screenX: number, screenY: number): {
1985
1992
  origin: Vec3;
1986
1993
  direction: Vec3;
@@ -2268,6 +2275,8 @@ declare module '@micrio/client' {
2268
2275
  * transparent: they no longer block the pages behind them and you can see
2269
2276
  * through to the underlying spread. */
2270
2277
  _seeThroughMargins?: boolean;
2278
+ /** When false, the 90° rotate-view feature is disabled and its UI is hidden. Defaults to true. */
2279
+ _allowRotation?: boolean;
2271
2280
  _startPageIdx?: number;
2272
2281
  /** Base URL for the IIIF image server (hi-res streaming). */
2273
2282
  _iiifBaseUrl?: string;
@@ -2279,6 +2288,13 @@ declare module '@micrio/client' {
2279
2288
  constructor(options: BookViewerOptions);
2280
2289
  goto(pageIdx: number): Promise<void>;
2281
2290
  zoom(delta: number): void;
2291
+ /**
2292
+ * Rotates the view by a 90° increment around the vertical axis: `1` turns
2293
+ * the book to the right (clockwise), `-1` to the left (counter-clockwise).
2294
+ */
2295
+ rotateView(direction: 1 | -1): void;
2296
+ /** Whether the 90° rotate-view feature is enabled. */
2297
+ _allowRotation(): boolean;
2282
2298
  /**
2283
2299
  * Returns whether the camera is zoomed in beyond the fit view. This is the
2284
2300
  * complement of "the whole spread fits the viewport": when every currently