@inweb/viewer-core 25.11.1 → 25.12.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.
@@ -97,6 +97,9 @@ export interface IViewer extends IEventEmitter, ICommandService {
97
97
  * This method requires a `Client` instance to be specified to load model reference files
98
98
  * from the Open Cloud Server.
99
99
  *
100
+ * If there was an active dragger before opening the file, it will be deactivated. After
101
+ * opening the file, you must manually activate the required dragger.
102
+ *
100
103
  * Fires:
101
104
  *
102
105
  * - {@link OpenEvent | open}
@@ -121,7 +124,7 @@ export interface IViewer extends IEventEmitter, ICommandService {
121
124
  */
122
125
  cancel(): this;
123
126
  /**
124
- * Unloads an open file, clears the canvas and markups.
127
+ * Unloads an open file, clears the canvas and markups, deactivates the active dragger.
125
128
  *
126
129
  * Fires:
127
130
  *
@@ -214,13 +217,15 @@ export interface IViewer extends IEventEmitter, ICommandService {
214
217
  */
215
218
  activeDragger(): IDragger | null;
216
219
  /**
217
- * Changes the active dragger. Viewer must be initialized before enable dragger or exception is thrown.
220
+ * Changes the active dragger. The viewer must be initialized before activating the dragger,
221
+ * otherwise an exception will be thrown.
218
222
  *
219
223
  * Fires:
220
224
  *
221
225
  * - {@link ChangeActiveDraggerEvent | changeactivedragger}
222
226
  *
223
- * @param name - Dragger name. Can be one of the {@link draggers} list.
227
+ * @param name - Dragger name. Can be one of the {@link draggers} list or an ampty string to
228
+ * deactivate the current dragger.
224
229
  * @returns Returns the new active dragger reference or `null` if there is no dragger with
225
230
  * the given name.
226
231
  */
@@ -497,7 +497,7 @@ export interface PanEvent {
497
497
  dY: number;
498
498
  }
499
499
  /**
500
- * Event that fires when zooming of the camera.
500
+ * Event that fires when zooming to extents or selected objects.
501
501
  *
502
502
  * @event
503
503
  */
@@ -512,7 +512,7 @@ export interface ZoomEvent {
512
512
  data?: any;
513
513
  }
514
514
  /**
515
- * Event that fires when zooming of the camera.
515
+ * Event that fires when zooming of the camera using mouse wheel.
516
516
  *
517
517
  * @event
518
518
  */
@@ -674,15 +674,15 @@ export interface ViewerEventMap {
674
674
  */
675
675
  walkstart: WalkStartEvent;
676
676
  /**
677
- * Event that fires when zooming of the camera.
677
+ * Event that fires when zooming to extents or selected objects.
678
678
  */
679
679
  zoom: ZoomEvent;
680
680
  /**
681
- * Event that fires when zooming of the camera.
681
+ * Event that fires when zooming of the camera using mouse wheel.
682
682
  */
683
683
  zoomat: ZoomAtEvent;
684
684
  /**
685
- * Event that fires when zooming to entity.
685
+ * Event that fires when zooming to object.
686
686
  */
687
687
  zoomtoentity: ZoomToEntityEvent;
688
688
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@inweb/viewer-core",
3
- "version": "25.11.1",
3
+ "version": "25.12.0",
4
4
  "description": "3D CAD and BIM data Viewer core",
5
5
  "homepage": "https://cloud.opendesign.com/docs/index.html",
6
6
  "license": "SEE LICENSE IN LICENSE",
@@ -26,9 +26,9 @@
26
26
  "test": "karma start karma.conf.js"
27
27
  },
28
28
  "devDependencies": {
29
- "@inweb/eventemitter2": "~25.11.1"
29
+ "@inweb/eventemitter2": "~25.12.0"
30
30
  },
31
31
  "peerDependencies": {
32
- "@inweb/eventemitter2": "~25.11.1"
32
+ "@inweb/eventemitter2": "~25.12.0"
33
33
  }
34
34
  }
@@ -130,6 +130,9 @@ export interface IViewer extends IEventEmitter, ICommandService {
130
130
  * This method requires a `Client` instance to be specified to load model reference files
131
131
  * from the Open Cloud Server.
132
132
  *
133
+ * If there was an active dragger before opening the file, it will be deactivated. After
134
+ * opening the file, you must manually activate the required dragger.
135
+ *
133
136
  * Fires:
134
137
  *
135
138
  * - {@link OpenEvent | open}
@@ -156,7 +159,7 @@ export interface IViewer extends IEventEmitter, ICommandService {
156
159
  cancel(): this;
157
160
 
158
161
  /**
159
- * Unloads an open file, clears the canvas and markups.
162
+ * Unloads an open file, clears the canvas and markups, deactivates the active dragger.
160
163
  *
161
164
  * Fires:
162
165
  *
@@ -263,13 +266,15 @@ export interface IViewer extends IEventEmitter, ICommandService {
263
266
  activeDragger(): IDragger | null;
264
267
 
265
268
  /**
266
- * Changes the active dragger. Viewer must be initialized before enable dragger or exception is thrown.
269
+ * Changes the active dragger. The viewer must be initialized before activating the dragger,
270
+ * otherwise an exception will be thrown.
267
271
  *
268
272
  * Fires:
269
273
  *
270
274
  * - {@link ChangeActiveDraggerEvent | changeactivedragger}
271
275
  *
272
- * @param name - Dragger name. Can be one of the {@link draggers} list.
276
+ * @param name - Dragger name. Can be one of the {@link draggers} list or an ampty string to
277
+ * deactivate the current dragger.
273
278
  * @returns Returns the new active dragger reference or `null` if there is no dragger with
274
279
  * the given name.
275
280
  */
@@ -565,7 +565,7 @@ export interface PanEvent {
565
565
  }
566
566
 
567
567
  /**
568
- * Event that fires when zooming of the camera.
568
+ * Event that fires when zooming to extents or selected objects.
569
569
  *
570
570
  * @event
571
571
  */
@@ -582,7 +582,7 @@ export interface ZoomEvent {
582
582
  }
583
583
 
584
584
  /**
585
- * Event that fires when zooming of the camera.
585
+ * Event that fires when zooming of the camera using mouse wheel.
586
586
  *
587
587
  * @event
588
588
  */
@@ -779,17 +779,17 @@ export interface ViewerEventMap {
779
779
  walkstart: WalkStartEvent;
780
780
 
781
781
  /**
782
- * Event that fires when zooming of the camera.
782
+ * Event that fires when zooming to extents or selected objects.
783
783
  */
784
784
  zoom: ZoomEvent;
785
785
 
786
786
  /**
787
- * Event that fires when zooming of the camera.
787
+ * Event that fires when zooming of the camera using mouse wheel.
788
788
  */
789
789
  zoomat: ZoomAtEvent;
790
790
 
791
791
  /**
792
- * Event that fires when zooming to entity.
792
+ * Event that fires when zooming to object.
793
793
  */
794
794
  zoomtoentity: ZoomToEntityEvent;
795
795
  }