@atlas-viewer/atlas 2.3.6 → 3.0.0

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/dist/index.d.cts CHANGED
@@ -7,7 +7,7 @@ import { RectReadOnly } from 'react-use-measure';
7
7
  import * as react_jsx_runtime from 'react/jsx-runtime';
8
8
  import { CanvasNormalized, ManifestNormalized } from '@iiif/presentation-3-normalized';
9
9
 
10
- declare const supportedEventAttributes: readonly ["onMouseDown", "onMouseEnter", "onMouseLeave", "onMouseMove", "onMouseOut", "onMouseOver", "onMouseUp", "onTouchCancel", "onTouchEnd", "onTouchMove", "onTouchStart", "onPointerDown", "onPointerMove", "onPointerUp", "onPointerCancel", "onPointerEnter", "onPointerLeave", "onPointerOver", "onPointerOut", "onScroll", "onWheel", "onClick", "onDragStart", "onDragEnd", "onDragEnter", "onDragExit", "onDrag", "onDragOver"];
10
+ declare const supportedEventAttributes: readonly ["onMouseDown", "onMouseEnter", "onMouseLeave", "onMouseMove", "onMouseOut", "onMouseOver", "onMouseUp", "onTouchCancel", "onTouchEnd", "onTouchMove", "onTouchStart", "onPointerDown", "onPointerMove", "onPointerUp", "onPointerCancel", "onPointerEnter", "onPointerLeave", "onPointerOver", "onPointerOut", "onScroll", "onWheel", "onClick", "onDragStart", "onDragEnd", "onDragEnter", "onDragExit", "onDrag", "onDragOver", "onContextMenu"];
11
11
  declare function createDefaultEventMap(): SupportedEventMap;
12
12
  declare const supportedEventMap: {
13
13
  mousedown: keyof SupportedEvents;
@@ -38,6 +38,7 @@ declare const supportedEventMap: {
38
38
  dragexit: keyof SupportedEvents;
39
39
  drag: keyof SupportedEvents;
40
40
  dragover: keyof SupportedEvents;
41
+ contextmenu: keyof SupportedEvents;
41
42
  };
42
43
  type SupportedEvents = {
43
44
  onMouseDown(e: any): void;
@@ -68,8 +69,9 @@ type SupportedEvents = {
68
69
  onDragExit(e: any): void;
69
70
  onDrag(e: any): void;
70
71
  onDragOver(e: any): void;
72
+ onContextMenu(e: any): void;
71
73
  };
72
- type SupportedEventNames = 'mousedown' | 'mouseenter' | 'mouseleave' | 'mousemove' | 'mouseout' | 'mouseover' | 'mouseup' | 'touchcancel' | 'touchend' | 'touchmove' | 'touchstart' | 'pointerdown' | 'pointermove' | 'pointerup' | 'pointercancel' | 'pointerenter' | 'pointerleave' | 'pointerover' | 'pointerout' | 'scroll' | 'wheel' | 'click' | 'dragstart' | 'dragend' | 'dragenter' | 'dragexit' | 'drag' | 'dragover';
74
+ type SupportedEventNames = 'mousedown' | 'mouseenter' | 'mouseleave' | 'mousemove' | 'mouseout' | 'mouseover' | 'mouseup' | 'touchcancel' | 'touchend' | 'touchmove' | 'touchstart' | 'pointerdown' | 'pointermove' | 'pointerup' | 'pointercancel' | 'pointerenter' | 'pointerleave' | 'pointerover' | 'pointerout' | 'scroll' | 'wheel' | 'click' | 'dragstart' | 'dragend' | 'dragenter' | 'dragexit' | 'drag' | 'dragover' | 'contextmenu';
73
75
  type SupportedEventMap = {
74
76
  [Name in keyof SupportedEvents]: Array<SupportedEvents[Name]>;
75
77
  };
@@ -169,7 +171,7 @@ declare class CompositeResource extends AbstractContent implements SpacialConten
169
171
  images: SpacialContent[];
170
172
  allImages: SpacialContent[];
171
173
  scaleFactors: number[];
172
- aggregateBuffer: Float32Array;
174
+ aggregateBuffer: Strand;
173
175
  lazyLoader?: () => Promise<SpacialContent[]>;
174
176
  isFullyLoaded: boolean;
175
177
  maxScaleFactor: number;
@@ -272,9 +274,9 @@ declare class WorldObject extends BaseObject<WorldObjectProps, Paintable> {
272
274
  * So a 1000x1000 drawn at 0.1 scale at x=5, y=10 on the world would have world points 0,0,100,100
273
275
  */
274
276
  worldPoints: Strand;
275
- intersectionBuffer: Float32Array;
276
- aggregateBuffer: Float32Array;
277
- invertedBuffer: Float32Array;
277
+ intersectionBuffer: Strand;
278
+ aggregateBuffer: Strand;
279
+ invertedBuffer: Strand;
278
280
  rotation: number;
279
281
  filteredPointsBuffer: Strand;
280
282
  _updatedList: any[];
@@ -290,7 +292,7 @@ declare class WorldObject extends BaseObject<WorldObjectProps, Paintable> {
290
292
  insertBefore(item: Paintable, before: Paintable): void;
291
293
  hideInstance(): void;
292
294
  getObjectsAt(target: Strand, all?: boolean): Paintable[];
293
- applyRotation(target: Strand): Float32Array;
295
+ applyRotation(target: Strand): Strand;
294
296
  getAllPointsAt(target: Strand, aggregate: Strand, scaleFactor: number): Paint[];
295
297
  addLayers(paintables: Paintable[]): void;
296
298
  getScheduledUpdates(target: Strand, scaleFactor: number): Array<() => void | Promise<void>>;
@@ -313,7 +315,7 @@ declare class World extends BaseObject<WorldProps, WorldObject> {
313
315
  _height: number;
314
316
  aspectRatio: number;
315
317
  viewingDirection: ViewingDirection;
316
- aggregateBuffer: Float32Array;
318
+ aggregateBuffer: Strand;
317
319
  isDirty: boolean;
318
320
  zones: ZoneInterface[];
319
321
  filteredPointsBuffer: Strand;
@@ -321,7 +323,7 @@ declare class World extends BaseObject<WorldProps, WorldObject> {
321
323
  triggerQueue: Array<[string, any]>;
322
324
  activatedEvents: string[];
323
325
  _updatedList: any[];
324
- translationBuffer: Float32Array;
326
+ translationBuffer: Strand;
325
327
  needsRecalculate: boolean;
326
328
  emptyPaintables: never[];
327
329
  renderOrder: number[];
@@ -369,7 +371,7 @@ declare class World extends BaseObject<WorldProps, WorldObject> {
369
371
  translateWorldObject(index: number, x: number, y: number): void;
370
372
  resize(width: number, height: number): this;
371
373
  getObjects(): (WorldObject | null)[];
372
- getPoints(): Float32Array;
374
+ getPoints(): Strand;
373
375
  getPointsFromViewer(target: Viewer, aggregate?: Strand): Paint[];
374
376
  addLayoutSubscriber(subscription: (type: string, data: unknown) => void): () => void;
375
377
  getScheduledUpdates(target: Strand, scaleFactor: number): Array<() => void | Promise<void>>;
@@ -454,7 +456,7 @@ declare class TransitionManager {
454
456
  constructor(runtime: Runtime);
455
457
  hasPending(): boolean;
456
458
  getPendingTransition(): PendingTransition;
457
- getPendingFrom(): Float32Array;
459
+ getPendingFrom(): Strand;
458
460
  customTransition(func: (transition: PendingTransition) => void): void;
459
461
  stopTransition(): void;
460
462
  runTransition(target: Strand, delta: number): void;
@@ -562,9 +564,9 @@ declare class Runtime {
562
564
  focalPosition: Strand;
563
565
  transitionManager: TransitionManager;
564
566
  aggregate: Strand;
565
- transformBuffer: Float32Array;
566
- lastTarget: Float32Array;
567
- zoomBuffer: Float32Array;
567
+ transformBuffer: Strand;
568
+ lastTarget: Strand;
569
+ zoomBuffer: Strand;
568
570
  logNextRender: boolean;
569
571
  pendingUpdate: boolean;
570
572
  isCommitting: boolean;
@@ -652,7 +654,7 @@ declare class Runtime {
652
654
  constrainBounds(target: Strand, { panPadding, ref }?: {
653
655
  ref?: boolean;
654
656
  panPadding?: number;
655
- }): readonly [boolean, Float32Array];
657
+ }): readonly [boolean, Strand];
656
658
  /**
657
659
  * Get bounds
658
660
  *
@@ -679,7 +681,7 @@ declare class Runtime {
679
681
  y: number;
680
682
  };
681
683
  fromPos?: Strand;
682
- }): Float32Array;
684
+ }): Strand;
683
685
  clampRegion({ x, y, width, height, padding, }: {
684
686
  x: number;
685
687
  y: number;
@@ -719,7 +721,7 @@ declare class Runtime {
719
721
  y: number;
720
722
  width: number;
721
723
  height: number;
722
- strand: Float32Array;
724
+ strand: Strand;
723
725
  };
724
726
  /**
725
727
  * Set scale
@@ -1105,7 +1107,7 @@ declare class Box extends BaseObject<BoxProps> implements SpacialContent {
1105
1107
  scale: number;
1106
1108
  width: number;
1107
1109
  height: number;
1108
- points: Float32Array;
1110
+ points: Strand;
1109
1111
  };
1110
1112
  _parsed: {
1111
1113
  border: {
@@ -1173,7 +1175,7 @@ declare class Text extends BaseObject<TextProps> implements SpacialContent {
1173
1175
  scale: number;
1174
1176
  width: number;
1175
1177
  height: number;
1176
- points: Float32Array;
1178
+ points: Strand;
1177
1179
  };
1178
1180
  className?: string;
1179
1181
  html?: boolean;
@@ -1247,7 +1249,7 @@ declare class Geometry extends BaseObject<GeometryProps> implements SpacialConte
1247
1249
  scale: number;
1248
1250
  width: number;
1249
1251
  height: number;
1250
- points: Float32Array;
1252
+ points: Strand;
1251
1253
  };
1252
1254
  boundingBox: {
1253
1255
  x: number;
@@ -1438,6 +1440,7 @@ declare class BrowserEventManager {
1438
1440
  activateEvents(): void;
1439
1441
  _realPointerMove: (e: PointerEvent) => void;
1440
1442
  onWheelEvent: (e: WheelEvent) => void;
1443
+ onContextMenu: (e: MouseEvent) => void;
1441
1444
  onTouchEvent: (e: TouchEvent) => void;
1442
1445
  onPointerEvent: (e: PointerEvent | MouseEvent) => void;
1443
1446
  onPointerDown: (e: PointerEvent | MouseEvent) => void;
@@ -1899,6 +1902,7 @@ type SupportedEventFunctions = {
1899
1902
  onScroll(e: AtlasEvent<UIEvent>): void;
1900
1903
  onWheel(e: AtlasEvent<WheelEvent>): void;
1901
1904
  onClick(e: AtlasEvent<MouseEvent>): void;
1905
+ onContextMenu(e: AtlasEvent<MouseEvent>): void;
1902
1906
  onUpdate(e: {
1903
1907
  props: any;
1904
1908
  }): void;
@@ -2189,7 +2193,7 @@ declare class WebGLRenderer implements Renderer {
2189
2193
  resizeCanvasToDisplaySize(): boolean;
2190
2194
  createArrayBuffer(data?: Float32Array): WebGLBuffer;
2191
2195
  setRectangle(x: number, y: number, width: number, height: number): void;
2192
- getRectangle(x: number, y: number, width: number, height: number): Float32Array;
2196
+ getRectangle(x: number, y: number, width: number, height: number): Float32Array<ArrayBufferLike>;
2193
2197
  getRendererScreenPosition(): DOMRect;
2194
2198
  finishLayer(): void;
2195
2199
  reset(): void;
package/dist/index.d.ts CHANGED
@@ -7,7 +7,7 @@ import { RectReadOnly } from 'react-use-measure';
7
7
  import * as react_jsx_runtime from 'react/jsx-runtime';
8
8
  import { CanvasNormalized, ManifestNormalized } from '@iiif/presentation-3-normalized';
9
9
 
10
- declare const supportedEventAttributes: readonly ["onMouseDown", "onMouseEnter", "onMouseLeave", "onMouseMove", "onMouseOut", "onMouseOver", "onMouseUp", "onTouchCancel", "onTouchEnd", "onTouchMove", "onTouchStart", "onPointerDown", "onPointerMove", "onPointerUp", "onPointerCancel", "onPointerEnter", "onPointerLeave", "onPointerOver", "onPointerOut", "onScroll", "onWheel", "onClick", "onDragStart", "onDragEnd", "onDragEnter", "onDragExit", "onDrag", "onDragOver"];
10
+ declare const supportedEventAttributes: readonly ["onMouseDown", "onMouseEnter", "onMouseLeave", "onMouseMove", "onMouseOut", "onMouseOver", "onMouseUp", "onTouchCancel", "onTouchEnd", "onTouchMove", "onTouchStart", "onPointerDown", "onPointerMove", "onPointerUp", "onPointerCancel", "onPointerEnter", "onPointerLeave", "onPointerOver", "onPointerOut", "onScroll", "onWheel", "onClick", "onDragStart", "onDragEnd", "onDragEnter", "onDragExit", "onDrag", "onDragOver", "onContextMenu"];
11
11
  declare function createDefaultEventMap(): SupportedEventMap;
12
12
  declare const supportedEventMap: {
13
13
  mousedown: keyof SupportedEvents;
@@ -38,6 +38,7 @@ declare const supportedEventMap: {
38
38
  dragexit: keyof SupportedEvents;
39
39
  drag: keyof SupportedEvents;
40
40
  dragover: keyof SupportedEvents;
41
+ contextmenu: keyof SupportedEvents;
41
42
  };
42
43
  type SupportedEvents = {
43
44
  onMouseDown(e: any): void;
@@ -68,8 +69,9 @@ type SupportedEvents = {
68
69
  onDragExit(e: any): void;
69
70
  onDrag(e: any): void;
70
71
  onDragOver(e: any): void;
72
+ onContextMenu(e: any): void;
71
73
  };
72
- type SupportedEventNames = 'mousedown' | 'mouseenter' | 'mouseleave' | 'mousemove' | 'mouseout' | 'mouseover' | 'mouseup' | 'touchcancel' | 'touchend' | 'touchmove' | 'touchstart' | 'pointerdown' | 'pointermove' | 'pointerup' | 'pointercancel' | 'pointerenter' | 'pointerleave' | 'pointerover' | 'pointerout' | 'scroll' | 'wheel' | 'click' | 'dragstart' | 'dragend' | 'dragenter' | 'dragexit' | 'drag' | 'dragover';
74
+ type SupportedEventNames = 'mousedown' | 'mouseenter' | 'mouseleave' | 'mousemove' | 'mouseout' | 'mouseover' | 'mouseup' | 'touchcancel' | 'touchend' | 'touchmove' | 'touchstart' | 'pointerdown' | 'pointermove' | 'pointerup' | 'pointercancel' | 'pointerenter' | 'pointerleave' | 'pointerover' | 'pointerout' | 'scroll' | 'wheel' | 'click' | 'dragstart' | 'dragend' | 'dragenter' | 'dragexit' | 'drag' | 'dragover' | 'contextmenu';
73
75
  type SupportedEventMap = {
74
76
  [Name in keyof SupportedEvents]: Array<SupportedEvents[Name]>;
75
77
  };
@@ -169,7 +171,7 @@ declare class CompositeResource extends AbstractContent implements SpacialConten
169
171
  images: SpacialContent[];
170
172
  allImages: SpacialContent[];
171
173
  scaleFactors: number[];
172
- aggregateBuffer: Float32Array;
174
+ aggregateBuffer: Strand;
173
175
  lazyLoader?: () => Promise<SpacialContent[]>;
174
176
  isFullyLoaded: boolean;
175
177
  maxScaleFactor: number;
@@ -272,9 +274,9 @@ declare class WorldObject extends BaseObject<WorldObjectProps, Paintable> {
272
274
  * So a 1000x1000 drawn at 0.1 scale at x=5, y=10 on the world would have world points 0,0,100,100
273
275
  */
274
276
  worldPoints: Strand;
275
- intersectionBuffer: Float32Array;
276
- aggregateBuffer: Float32Array;
277
- invertedBuffer: Float32Array;
277
+ intersectionBuffer: Strand;
278
+ aggregateBuffer: Strand;
279
+ invertedBuffer: Strand;
278
280
  rotation: number;
279
281
  filteredPointsBuffer: Strand;
280
282
  _updatedList: any[];
@@ -290,7 +292,7 @@ declare class WorldObject extends BaseObject<WorldObjectProps, Paintable> {
290
292
  insertBefore(item: Paintable, before: Paintable): void;
291
293
  hideInstance(): void;
292
294
  getObjectsAt(target: Strand, all?: boolean): Paintable[];
293
- applyRotation(target: Strand): Float32Array;
295
+ applyRotation(target: Strand): Strand;
294
296
  getAllPointsAt(target: Strand, aggregate: Strand, scaleFactor: number): Paint[];
295
297
  addLayers(paintables: Paintable[]): void;
296
298
  getScheduledUpdates(target: Strand, scaleFactor: number): Array<() => void | Promise<void>>;
@@ -313,7 +315,7 @@ declare class World extends BaseObject<WorldProps, WorldObject> {
313
315
  _height: number;
314
316
  aspectRatio: number;
315
317
  viewingDirection: ViewingDirection;
316
- aggregateBuffer: Float32Array;
318
+ aggregateBuffer: Strand;
317
319
  isDirty: boolean;
318
320
  zones: ZoneInterface[];
319
321
  filteredPointsBuffer: Strand;
@@ -321,7 +323,7 @@ declare class World extends BaseObject<WorldProps, WorldObject> {
321
323
  triggerQueue: Array<[string, any]>;
322
324
  activatedEvents: string[];
323
325
  _updatedList: any[];
324
- translationBuffer: Float32Array;
326
+ translationBuffer: Strand;
325
327
  needsRecalculate: boolean;
326
328
  emptyPaintables: never[];
327
329
  renderOrder: number[];
@@ -369,7 +371,7 @@ declare class World extends BaseObject<WorldProps, WorldObject> {
369
371
  translateWorldObject(index: number, x: number, y: number): void;
370
372
  resize(width: number, height: number): this;
371
373
  getObjects(): (WorldObject | null)[];
372
- getPoints(): Float32Array;
374
+ getPoints(): Strand;
373
375
  getPointsFromViewer(target: Viewer, aggregate?: Strand): Paint[];
374
376
  addLayoutSubscriber(subscription: (type: string, data: unknown) => void): () => void;
375
377
  getScheduledUpdates(target: Strand, scaleFactor: number): Array<() => void | Promise<void>>;
@@ -454,7 +456,7 @@ declare class TransitionManager {
454
456
  constructor(runtime: Runtime);
455
457
  hasPending(): boolean;
456
458
  getPendingTransition(): PendingTransition;
457
- getPendingFrom(): Float32Array;
459
+ getPendingFrom(): Strand;
458
460
  customTransition(func: (transition: PendingTransition) => void): void;
459
461
  stopTransition(): void;
460
462
  runTransition(target: Strand, delta: number): void;
@@ -562,9 +564,9 @@ declare class Runtime {
562
564
  focalPosition: Strand;
563
565
  transitionManager: TransitionManager;
564
566
  aggregate: Strand;
565
- transformBuffer: Float32Array;
566
- lastTarget: Float32Array;
567
- zoomBuffer: Float32Array;
567
+ transformBuffer: Strand;
568
+ lastTarget: Strand;
569
+ zoomBuffer: Strand;
568
570
  logNextRender: boolean;
569
571
  pendingUpdate: boolean;
570
572
  isCommitting: boolean;
@@ -652,7 +654,7 @@ declare class Runtime {
652
654
  constrainBounds(target: Strand, { panPadding, ref }?: {
653
655
  ref?: boolean;
654
656
  panPadding?: number;
655
- }): readonly [boolean, Float32Array];
657
+ }): readonly [boolean, Strand];
656
658
  /**
657
659
  * Get bounds
658
660
  *
@@ -679,7 +681,7 @@ declare class Runtime {
679
681
  y: number;
680
682
  };
681
683
  fromPos?: Strand;
682
- }): Float32Array;
684
+ }): Strand;
683
685
  clampRegion({ x, y, width, height, padding, }: {
684
686
  x: number;
685
687
  y: number;
@@ -719,7 +721,7 @@ declare class Runtime {
719
721
  y: number;
720
722
  width: number;
721
723
  height: number;
722
- strand: Float32Array;
724
+ strand: Strand;
723
725
  };
724
726
  /**
725
727
  * Set scale
@@ -1105,7 +1107,7 @@ declare class Box extends BaseObject<BoxProps> implements SpacialContent {
1105
1107
  scale: number;
1106
1108
  width: number;
1107
1109
  height: number;
1108
- points: Float32Array;
1110
+ points: Strand;
1109
1111
  };
1110
1112
  _parsed: {
1111
1113
  border: {
@@ -1173,7 +1175,7 @@ declare class Text extends BaseObject<TextProps> implements SpacialContent {
1173
1175
  scale: number;
1174
1176
  width: number;
1175
1177
  height: number;
1176
- points: Float32Array;
1178
+ points: Strand;
1177
1179
  };
1178
1180
  className?: string;
1179
1181
  html?: boolean;
@@ -1247,7 +1249,7 @@ declare class Geometry extends BaseObject<GeometryProps> implements SpacialConte
1247
1249
  scale: number;
1248
1250
  width: number;
1249
1251
  height: number;
1250
- points: Float32Array;
1252
+ points: Strand;
1251
1253
  };
1252
1254
  boundingBox: {
1253
1255
  x: number;
@@ -1438,6 +1440,7 @@ declare class BrowserEventManager {
1438
1440
  activateEvents(): void;
1439
1441
  _realPointerMove: (e: PointerEvent) => void;
1440
1442
  onWheelEvent: (e: WheelEvent) => void;
1443
+ onContextMenu: (e: MouseEvent) => void;
1441
1444
  onTouchEvent: (e: TouchEvent) => void;
1442
1445
  onPointerEvent: (e: PointerEvent | MouseEvent) => void;
1443
1446
  onPointerDown: (e: PointerEvent | MouseEvent) => void;
@@ -1899,6 +1902,7 @@ type SupportedEventFunctions = {
1899
1902
  onScroll(e: AtlasEvent<UIEvent>): void;
1900
1903
  onWheel(e: AtlasEvent<WheelEvent>): void;
1901
1904
  onClick(e: AtlasEvent<MouseEvent>): void;
1905
+ onContextMenu(e: AtlasEvent<MouseEvent>): void;
1902
1906
  onUpdate(e: {
1903
1907
  props: any;
1904
1908
  }): void;
@@ -2189,7 +2193,7 @@ declare class WebGLRenderer implements Renderer {
2189
2193
  resizeCanvasToDisplaySize(): boolean;
2190
2194
  createArrayBuffer(data?: Float32Array): WebGLBuffer;
2191
2195
  setRectangle(x: number, y: number, width: number, height: number): void;
2192
- getRectangle(x: number, y: number, width: number, height: number): Float32Array;
2196
+ getRectangle(x: number, y: number, width: number, height: number): Float32Array<ArrayBufferLike>;
2193
2197
  getRendererScreenPosition(): DOMRect;
2194
2198
  finishLayer(): void;
2195
2199
  reset(): void;