@inweb/client 25.2.2 → 25.2.5

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.
Files changed (222) hide show
  1. package/LICENSE +20 -20
  2. package/README.md +70 -70
  3. package/dist/client.js +12739 -12352
  4. package/dist/client.js.map +1 -1
  5. package/dist/client.min.js +1 -1
  6. package/dist/client.module.js +588 -157
  7. package/dist/client.module.js.map +1 -1
  8. package/lib/Api/Assembly.d.ts +338 -338
  9. package/lib/Api/ClashTest.d.ts +175 -175
  10. package/lib/Api/Client.d.ts +451 -451
  11. package/lib/Api/ClientEvents.d.ts +28 -28
  12. package/lib/Api/File.d.ts +567 -567
  13. package/lib/Api/HttpClient.d.ts +12 -12
  14. package/lib/Api/IAssembly.d.ts +13 -13
  15. package/lib/Api/IFile.d.ts +45 -45
  16. package/lib/Api/IHttpClient.d.ts +10 -10
  17. package/lib/Api/IUser.d.ts +10 -10
  18. package/lib/Api/Job.d.ts +141 -141
  19. package/lib/Api/Member.d.ts +84 -84
  20. package/lib/Api/Model.d.ts +146 -146
  21. package/lib/Api/Permission.d.ts +92 -92
  22. package/lib/Api/Project.d.ts +246 -246
  23. package/lib/Api/Role.d.ts +81 -81
  24. package/lib/Api/User.d.ts +196 -196
  25. package/lib/Api/impl/FetchError.d.ts +17 -17
  26. package/lib/Api/impl/Utils.d.ts +32 -32
  27. package/lib/Api/impl/http.d.ts +66 -66
  28. package/lib/ConvetMath.d.ts +28 -28
  29. package/lib/Viewer/CanvasEvents.d.ts +1 -1
  30. package/lib/Viewer/Commands/ApplyModelTransform.d.ts +1 -1
  31. package/lib/Viewer/Commands/ClearMarkup.d.ts +1 -1
  32. package/lib/Viewer/Commands/ClearSlices.d.ts +1 -1
  33. package/lib/Viewer/Commands/CreatePreview.d.ts +1 -1
  34. package/lib/Viewer/Commands/Explode.d.ts +1 -1
  35. package/lib/Viewer/Commands/GetDefaultViewPositions.d.ts +1 -1
  36. package/lib/Viewer/Commands/GetModels.d.ts +1 -1
  37. package/lib/Viewer/Commands/GetSelected.d.ts +1 -1
  38. package/lib/Viewer/Commands/HideSelected.d.ts +1 -1
  39. package/lib/Viewer/Commands/IsolateSelected.d.ts +1 -1
  40. package/lib/Viewer/Commands/RegenerateAll.d.ts +1 -1
  41. package/lib/Viewer/Commands/ResetView.d.ts +1 -1
  42. package/lib/Viewer/Commands/SelectModel.d.ts +1 -1
  43. package/lib/Viewer/Commands/SetActiveDragger.d.ts +1 -1
  44. package/lib/Viewer/Commands/SetDefaultViewPosition.d.ts +1 -1
  45. package/lib/Viewer/Commands/SetMarkupColor.d.ts +1 -1
  46. package/lib/Viewer/Commands/SetSelected.d.ts +1 -1
  47. package/lib/Viewer/Commands/ShowAll.d.ts +1 -1
  48. package/lib/Viewer/Commands/Unselect.d.ts +1 -1
  49. package/lib/Viewer/Commands/ZoomToExtents.d.ts +1 -1
  50. package/lib/Viewer/Commands/ZoomToObjects.d.ts +1 -1
  51. package/lib/Viewer/Commands/ZoomToSelected.d.ts +1 -1
  52. package/lib/Viewer/Commands.d.ts +2 -2
  53. package/lib/Viewer/Draggers/Actions/OrbitAction.d.ts +21 -21
  54. package/lib/Viewer/Draggers/Actions/PanAction.d.ts +17 -17
  55. package/lib/Viewer/Draggers/Actions/ZoomAction.d.ts +7 -7
  56. package/lib/Viewer/Draggers/Common/Geometry.d.ts +114 -114
  57. package/lib/Viewer/Draggers/Common/GestureManager.d.ts +40 -40
  58. package/lib/Viewer/Draggers/Common/OdBaseDragger.d.ts +53 -53
  59. package/lib/Viewer/Draggers/Common/OdaGeAction.d.ts +29 -29
  60. package/lib/Viewer/Draggers/MeasureLineDragger/MeasureLineItem.d.ts +30 -30
  61. package/lib/Viewer/Draggers/MeasureLineDragger/MeasureUtils.d.ts +19 -19
  62. package/lib/Viewer/Draggers/MeasureLineDragger/index.d.ts +23 -23
  63. package/lib/Viewer/Draggers/OdBaseCuttingPlaneDragger.d.ts +26 -26
  64. package/lib/Viewer/Draggers/OdCuttingPlaneXAxisDragger.d.ts +7 -7
  65. package/lib/Viewer/Draggers/OdCuttingPlaneYAxisDragger.d.ts +7 -7
  66. package/lib/Viewer/Draggers/OdCuttingPlaneZAxisDragger.d.ts +7 -7
  67. package/lib/Viewer/Draggers/OdOrbitDragger.d.ts +14 -14
  68. package/lib/Viewer/Draggers/OdPanDragger.d.ts +11 -11
  69. package/lib/Viewer/Draggers/OdZoomDragger.d.ts +11 -11
  70. package/lib/Viewer/Draggers/OdZoomWheelDragger.d.ts +10 -10
  71. package/lib/Viewer/Draggers/OdZoomWindowDragger/OdSelectionFrame.d.ts +18 -18
  72. package/lib/Viewer/Draggers/OdZoomWindowDragger/index.d.ts +13 -13
  73. package/lib/Viewer/Draggers/OdaLineDragger.d.ts +14 -14
  74. package/lib/Viewer/Draggers/OdaTextDragger.d.ts +15 -15
  75. package/lib/Viewer/Draggers/OdaWalkDragger.d.ts +29 -29
  76. package/lib/Viewer/Draggers/OrbitAroundBuildingDragger.d.ts +18 -18
  77. package/lib/Viewer/EventEmitter2.d.ts +53 -53
  78. package/lib/Viewer/ICommands.d.ts +24 -24
  79. package/lib/Viewer/IEventEmitter2.d.ts +12 -12
  80. package/lib/Viewer/IViewer.d.ts +26 -26
  81. package/lib/Viewer/Loaders/BaseLoader.d.ts +10 -10
  82. package/lib/Viewer/Loaders/LoaderFactory.d.ts +9 -9
  83. package/lib/Viewer/Loaders/TCSLoader.d.ts +4 -4
  84. package/lib/Viewer/Loaders/UpdaterController.d.ts +14 -14
  85. package/lib/Viewer/Loaders/VsfXLoader.d.ts +4 -4
  86. package/lib/Viewer/Loaders/VsfXPartialLoader.d.ts +4 -4
  87. package/lib/Viewer/Markup/Api/IMarkupArrow.d.ts +21 -11
  88. package/lib/Viewer/Markup/Api/IMarkupCloud.d.ts +15 -0
  89. package/lib/Viewer/Markup/Api/IMarkupColorable.d.ts +4 -4
  90. package/lib/Viewer/Markup/Api/IMarkupEllipse.d.ts +14 -14
  91. package/lib/Viewer/Markup/Api/IMarkupImage.d.ts +14 -14
  92. package/lib/Viewer/Markup/Api/IMarkupLine.d.ts +18 -10
  93. package/lib/Viewer/Markup/Api/IMarkupObject.d.ts +11 -11
  94. package/lib/Viewer/Markup/Api/IMarkupRectangle.d.ts +14 -14
  95. package/lib/Viewer/Markup/Api/IMarkupText.d.ts +12 -12
  96. package/lib/Viewer/Markup/Api/Impl/Konva/KonvaArrow.d.ts +46 -31
  97. package/lib/Viewer/Markup/Api/Impl/Konva/KonvaCloud.d.ts +36 -0
  98. package/lib/Viewer/Markup/Api/Impl/Konva/KonvaEllipse.d.ts +40 -39
  99. package/lib/Viewer/Markup/Api/Impl/Konva/KonvaImage.d.ts +36 -35
  100. package/lib/Viewer/Markup/Api/Impl/Konva/KonvaLine.d.ts +35 -31
  101. package/lib/Viewer/Markup/Api/Impl/Konva/KonvaRectangle.d.ts +38 -37
  102. package/lib/Viewer/Markup/Api/Impl/Konva/KonvaText.d.ts +37 -36
  103. package/lib/Viewer/Markup/IMarkup.d.ts +38 -37
  104. package/lib/Viewer/Markup/Impl/Konva/KonvaMarkup.d.ts +71 -62
  105. package/lib/Viewer/Markup/Impl/Konva/MarkupColor.d.ts +18 -18
  106. package/lib/Viewer/Markup/Impl/Visualize/VisualizeMarkup.d.ts +32 -32
  107. package/lib/Viewer/Markup/MarkupFactory.d.ts +6 -6
  108. package/lib/Viewer/Options.d.ts +227 -227
  109. package/lib/Viewer/OptionsEvents.d.ts +25 -25
  110. package/lib/Viewer/Viewer.d.ts +352 -352
  111. package/lib/Viewer/ViewerCommands.d.ts +22 -22
  112. package/lib/Viewer/ViewerEvents.d.ts +600 -600
  113. package/lib/Viewer/utils.d.ts +3 -3
  114. package/lib/index.d.ts +23 -23
  115. package/package.json +38 -32
  116. package/src/Api/Assembly.ts +678 -678
  117. package/src/Api/ClashTest.ts +290 -290
  118. package/src/Api/Client.ts +816 -816
  119. package/src/Api/ClientEvents.ts +31 -31
  120. package/src/Api/File.ts +962 -962
  121. package/src/Api/HttpClient.ts +73 -73
  122. package/src/Api/IAssembly.ts +37 -37
  123. package/src/Api/IFile.ts +74 -74
  124. package/src/Api/IHttpClient.ts +50 -50
  125. package/src/Api/IUser.ts +33 -33
  126. package/src/Api/Job.ts +253 -253
  127. package/src/Api/Member.ts +161 -161
  128. package/src/Api/Model.ts +259 -259
  129. package/src/Api/Permission.ts +173 -173
  130. package/src/Api/Project.ts +479 -479
  131. package/src/Api/Role.ts +158 -158
  132. package/src/Api/User.ts +357 -357
  133. package/src/Api/impl/FetchError.ts +48 -48
  134. package/src/Api/impl/Utils.ts +367 -367
  135. package/src/Api/impl/http.ts +92 -92
  136. package/src/ConvetMath.ts +372 -372
  137. package/src/Viewer/CanvasEvents.ts +41 -41
  138. package/src/Viewer/Commands/ApplyModelTransform.ts +70 -70
  139. package/src/Viewer/Commands/ClearMarkup.ts +28 -28
  140. package/src/Viewer/Commands/ClearSlices.ts +27 -27
  141. package/src/Viewer/Commands/CreatePreview.ts +33 -33
  142. package/src/Viewer/Commands/Explode.ts +38 -38
  143. package/src/Viewer/Commands/GetDefaultViewPositions.ts +36 -36
  144. package/src/Viewer/Commands/GetModels.ts +43 -43
  145. package/src/Viewer/Commands/GetSelected.ts +58 -58
  146. package/src/Viewer/Commands/HideSelected.ts +37 -37
  147. package/src/Viewer/Commands/IsolateSelected.ts +37 -37
  148. package/src/Viewer/Commands/RegenerateAll.ts +37 -37
  149. package/src/Viewer/Commands/ResetView.ts +43 -43
  150. package/src/Viewer/Commands/SelectModel.ts +52 -52
  151. package/src/Viewer/Commands/SetActiveDragger.ts +29 -29
  152. package/src/Viewer/Commands/SetDefaultViewPosition.ts +50 -50
  153. package/src/Viewer/Commands/SetMarkupColor.ts +29 -29
  154. package/src/Viewer/Commands/SetSelected.ts +47 -47
  155. package/src/Viewer/Commands/ShowAll.ts +37 -37
  156. package/src/Viewer/Commands/Unselect.ts +37 -37
  157. package/src/Viewer/Commands/ZoomToExtents.ts +43 -43
  158. package/src/Viewer/Commands/ZoomToObjects.ts +47 -47
  159. package/src/Viewer/Commands/ZoomToSelected.ts +39 -39
  160. package/src/Viewer/Commands.ts +81 -81
  161. package/src/Viewer/Draggers/Actions/OrbitAction.ts +250 -250
  162. package/src/Viewer/Draggers/Actions/PanAction.ts +102 -102
  163. package/src/Viewer/Draggers/Actions/ZoomAction.ts +45 -45
  164. package/src/Viewer/Draggers/Common/Geometry.ts +152 -152
  165. package/src/Viewer/Draggers/Common/GestureManager.ts +263 -263
  166. package/src/Viewer/Draggers/Common/OdBaseDragger.ts +270 -270
  167. package/src/Viewer/Draggers/Common/OdaGeAction.ts +146 -146
  168. package/src/Viewer/Draggers/MeasureLineDragger/MeasureLineItem.ts +248 -248
  169. package/src/Viewer/Draggers/MeasureLineDragger/MeasureUtils.ts +182 -182
  170. package/src/Viewer/Draggers/MeasureLineDragger/index.ts +166 -166
  171. package/src/Viewer/Draggers/OdBaseCuttingPlaneDragger.ts +182 -182
  172. package/src/Viewer/Draggers/OdCuttingPlaneXAxisDragger.ts +53 -53
  173. package/src/Viewer/Draggers/OdCuttingPlaneYAxisDragger.ts +53 -53
  174. package/src/Viewer/Draggers/OdCuttingPlaneZAxisDragger.ts +53 -53
  175. package/src/Viewer/Draggers/OdOrbitDragger.ts +70 -70
  176. package/src/Viewer/Draggers/OdPanDragger.ts +62 -62
  177. package/src/Viewer/Draggers/OdZoomDragger.ts +59 -59
  178. package/src/Viewer/Draggers/OdZoomWheelDragger.ts +103 -103
  179. package/src/Viewer/Draggers/OdZoomWindowDragger/OdSelectionFrame.ts +123 -123
  180. package/src/Viewer/Draggers/OdZoomWindowDragger/index.ts +75 -75
  181. package/src/Viewer/Draggers/OdaLineDragger.ts +80 -80
  182. package/src/Viewer/Draggers/OdaTextDragger.ts +118 -118
  183. package/src/Viewer/Draggers/OdaWalkDragger.ts +278 -278
  184. package/src/Viewer/Draggers/OrbitAroundBuildingDragger.ts +184 -184
  185. package/src/Viewer/EventEmitter2.ts +116 -116
  186. package/src/Viewer/ICommands.ts +53 -53
  187. package/src/Viewer/IEventEmitter2.ts +36 -36
  188. package/src/Viewer/IViewer.ts +55 -55
  189. package/src/Viewer/Loaders/BaseLoader.ts +40 -40
  190. package/src/Viewer/Loaders/LoaderFactory.ts +44 -44
  191. package/src/Viewer/Loaders/TCSLoader.ts +82 -82
  192. package/src/Viewer/Loaders/UpdaterController.ts +36 -36
  193. package/src/Viewer/Loaders/VsfXLoader.ts +87 -87
  194. package/src/Viewer/Loaders/VsfXPartialLoader.ts +208 -208
  195. package/src/Viewer/Markup/Api/IMarkupArrow.ts +12 -15
  196. package/src/Viewer/Markup/Api/IMarkupCloud.ts +15 -0
  197. package/src/Viewer/Markup/Api/IMarkupColorable.ts +4 -4
  198. package/src/Viewer/Markup/Api/IMarkupEllipse.ts +15 -15
  199. package/src/Viewer/Markup/Api/IMarkupImage.ts +15 -15
  200. package/src/Viewer/Markup/Api/IMarkupLine.ts +20 -10
  201. package/src/Viewer/Markup/Api/IMarkupObject.ts +15 -15
  202. package/src/Viewer/Markup/Api/IMarkupRectangle.ts +15 -15
  203. package/src/Viewer/Markup/Api/IMarkupText.ts +12 -12
  204. package/src/Viewer/Markup/Api/Impl/Konva/KonvaArrow.ts +117 -119
  205. package/src/Viewer/Markup/Api/Impl/Konva/KonvaCloud.ts +208 -0
  206. package/src/Viewer/Markup/Api/Impl/Konva/KonvaEllipse.ts +118 -113
  207. package/src/Viewer/Markup/Api/Impl/Konva/KonvaImage.ts +123 -121
  208. package/src/Viewer/Markup/Api/Impl/Konva/KonvaLine.ts +130 -99
  209. package/src/Viewer/Markup/Api/Impl/Konva/KonvaRectangle.ts +119 -113
  210. package/src/Viewer/Markup/Api/Impl/Konva/KonvaText.ts +110 -104
  211. package/src/Viewer/Markup/IMarkup.ts +40 -39
  212. package/src/Viewer/Markup/Impl/Konva/KonvaMarkup.ts +1208 -872
  213. package/src/Viewer/Markup/Impl/Konva/MarkupColor.ts +39 -39
  214. package/src/Viewer/Markup/Impl/Visualize/VisualizeMarkup.ts +273 -273
  215. package/src/Viewer/Markup/MarkupFactory.ts +32 -32
  216. package/src/Viewer/Options.ts +502 -502
  217. package/src/Viewer/OptionsEvents.ts +28 -28
  218. package/src/Viewer/Viewer.ts +1109 -1109
  219. package/src/Viewer/ViewerCommands.ts +45 -45
  220. package/src/Viewer/ViewerEvents.ts +700 -700
  221. package/src/Viewer/utils.ts +74 -74
  222. package/src/index.ts +48 -48
@@ -1,353 +1,353 @@
1
- import { IViewer } from "./IViewer";
2
- import { EventEmitter2 } from "./EventEmitter2";
3
- import { ViewerEventMap } from "./ViewerEvents";
4
- import { OptionsEventMap } from "./OptionsEvents";
5
- import { OdBaseDragger } from "./Draggers/Common/OdBaseDragger";
6
- import { Client } from "../Api/Client";
7
- import { File } from "../Api/File";
8
- import { Assembly } from "../Api/Assembly";
9
- import { Model } from "../Api/Model";
10
- import { Options, OptionsData } from "./Options";
11
- import { IMarkup, MarkupType } from "./Markup/IMarkup";
12
- /**
13
- * The `Client.js` library class that provides methods to integrate with the
14
- * [VisualizeJS](https://cloud.opendesign.com/docs/index.html#/visualizejs) library.
15
- */
16
- export declare class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventMap> implements IViewer {
17
- private _activeDragger;
18
- private _zoomWheelDragger;
19
- private _gestureManager;
20
- private _enableAutoUpdate;
21
- private _isNeedRender;
22
- private _isRunAsyncUpdate;
23
- private _renderTime;
24
- protected _options: Options;
25
- protected _visualizeJsUrl: string;
26
- protected _abortControllerForReferences: AbortController | undefined;
27
- private clientoptionschange;
28
- private canvaseventlistener;
29
- draggerFactory: Map<string, typeof OdBaseDragger>;
30
- canvasEvents: string[];
31
- private frameId;
32
- private _resizeObserver;
33
- canvas: HTMLCanvasElement | undefined;
34
- markup: IMarkup;
35
- visualizeJs: any;
36
- _abortController: AbortController | undefined;
37
- _abortControllerForRequestMap: Map<string, AbortController> | undefined;
38
- client: Client;
39
- /**
40
- * @param client - The `Client` instance that provides access to a server. Do not specify
41
- * `Client` if you need a standalone viewer instance without access to server models.
42
- * @param params - An object containing viewer configuration parameters.
43
- * @param params.visualizeJsUrl - `VisualizeJS` library URL. Set this URL to use your own
44
- * library instance, or leave it undefined or blank to use the default URL defined by
45
- * `Client.js` you are using.
46
- *
47
- * _Note: Your own `VisualizeJS` library version must match the version of the `Client.js`
48
- * you are using._
49
- * @param params.enableAutoUpdate - Enable auto-update of the viewer after any changes. If
50
- * the auto-update is disabled, you need to update the `VisualizeJS` viewer and the active
51
- * dragger manually using the `update` event. Default is `true`.
52
- */
53
- constructor(client?: Client, params?: {
54
- visualizeJsUrl?: string;
55
- enableAutoUpdate?: boolean;
56
- markupType?: MarkupType;
57
- });
58
- /**
59
- * `VisualizeJS` parameters.
60
- *
61
- * Use this only for standalone viewer instances. Use {@link Client#options | Client.options}
62
- * instead if the viewer was created with a `Client` reference using
63
- * {@link Viewer | Viewer.create(client)}. Changes in client options will be automatically
64
- * applied to the viewer options.
65
- */
66
- get options(): Options;
67
- /**
68
- * `VisualizeJS` library URL. Use {@link Viewer#configure | configure()} to change library URL.
69
- *
70
- * @readonly
71
- */
72
- get visualizeJsUrl(): string;
73
- /**
74
- * Change the viewer configuration parameters.
75
- *
76
- * @param params - An object containing new configuration parameters.
77
- * @param params.visualizeJsUrl - `VisualizeJS` library URL. Set this URL to use your own
78
- * library instance or leave it blank to use the default URL defined by `Client.js`.
79
- */
80
- configure(params: {
81
- visualizeJsUrl?: string;
82
- }): this;
83
- /**
84
- * A [Viewer]{@link Viewer} event measuring progress of loading a `VisualizeJS` library.
85
- *
86
- * @property {string} type - `visualizeprogress`
87
- * @property {number} loaded - A 64-bit unsigned integer value indicating the amount of work
88
- * already performed by the underlying process. The ratio of work done can be calculated by
89
- * dividing total by the value of this property.
90
- * @property {number} total - A 64-bit unsigned integer representing the total amount of work
91
- * that the underlying process is in the progress of performing.
92
- * @event visualizeprogress
93
- */
94
- /**
95
- * Load `VisualizeJS` module and initialize it with the specified canvas. Call
96
- * {@link Viewer#dispose | dispose()} to release allocated resources.
97
- *
98
- * @async
99
- * @param canvas - HTML `<canvas>` element for `VisualizeJS`.
100
- * @param onProgress - A callback function that handles events measuring progress of loading
101
- * of the `VisualizeJS` library. Retrieves {@link event:visualizeprogress | visualizeprogress} event.
102
- */
103
- initialize(canvas: HTMLCanvasElement, onProgress?: (event: ProgressEvent) => void): Promise<this>;
104
- /**
105
- * Releases all resources allocated by this `Viewer` instance. Call this method before
106
- * release the `Viewer` instance.
107
- */
108
- dispose(): this;
109
- /**
110
- * Returns `true` if `VisualizeJS` module has been loaded andinitialized.
111
- */
112
- isInitialized(): boolean;
113
- private render;
114
- resize(): this;
115
- /**
116
- * Updates the viewer. Do nothing if the auto-update mode is disabled in the constructor (use
117
- * the `update` event to update viewer manually).
118
- *
119
- * Fires:
120
- *
121
- * - {@link UpdateEvent | update}
122
- *
123
- * @param force - If `true` updates the viewer immidietly. Otherwise updates on next
124
- * animation frame. Default is `false`.
125
- */
126
- update(force?: boolean): void;
127
- /**
128
- * Update with internal schedule, need after change operation when have long update for
129
- * update without lock UI
130
- *
131
- * @param maxScheduleUpdateTimeInMs - Maximum time for one update, by default 30 ms
132
- * @param maxScheduleUpdateCount - Maximum count of schedule update
133
- * @returns return void Promise
134
- */
135
- private scheduleUpdateAsync;
136
- updateAsync(maxScheduleUpdateTimeInMs?: number, maxScheduleUpdateCount?: number): Promise<void>;
137
- /**
138
- * Returns `VisualizeJS`
139
- * {@link https://cloud.opendesign.com/docs/index.html#/visualizejs_api | module} instance.
140
- */
141
- visLib(): any;
142
- /**
143
- * Returns `VisualizeJS`
144
- * {@link https://cloud.opendesign.com/docs/index.html#/vis/Viewer | Viewer} instance.
145
- */
146
- visViewer(): any;
147
- syncOpenCloudVisualStyle(isInitializing: boolean): this;
148
- syncOptions(options?: OptionsData): this;
149
- syncHighlightingOptions(options?: OptionsData): this;
150
- /**
151
- * List of names of available draggers:
152
- *
153
- * - `Line`
154
- * - `Text`
155
- * - `Pan`
156
- * - `Orbit`
157
- * - `Zoom`
158
- * - `ZoomWindow`
159
- * - `OrbitAroundBuilding`
160
- * - `MeasureLine`
161
- * - `CuttingPlaneXAxis`
162
- * - `CuttingPlaneYAxis`
163
- * - `CuttingPlaneZAxis`
164
- * - `Walk`
165
- *
166
- * @readonly
167
- */
168
- get draggers(): string[];
169
- /**
170
- * Register dragger on draggerFactory.
171
- *
172
- * @param name - Dragger name.
173
- * @param dragger - Dragger class.
174
- */
175
- registerDragger(name: string, dragger: typeof OdBaseDragger): void;
176
- /**
177
- * Returns active dragger instance or `null` if there is no active dragger.
178
- */
179
- activeDragger(): any | null;
180
- /**
181
- * Set active dragger. `Viewer` must be {@link Viewer#initialize | initialized} before enable
182
- * dragger or exception is thrown.
183
- *
184
- * Fires:
185
- *
186
- * - {@link ChangeActiveDragger | changeactivedragger}
187
- *
188
- * @param name - Dragger name. Can be one of the {@link Viewer#draggers | draggers} list.
189
- * @returns Returns active dragger instance or `null` if there is no dragger with the given name.
190
- */
191
- setActiveDragger(name: string): OdBaseDragger | null;
192
- /**
193
- * Reset the state of the active dragger.
194
- */
195
- resetActiveDragger(): void;
196
- /**
197
- * Remove all cutting planes.
198
- */
199
- clearSlices(): void;
200
- /**
201
- * Remove markup overlay.
202
- */
203
- clearOverlay(): void;
204
- /**
205
- * Synchronize markup overlay.
206
- */
207
- syncOverlay(): any;
208
- /**
209
- * Returns `true` if current drawing is 3D drawing.
210
- */
211
- is3D(): boolean;
212
- /**
213
- * Returns a list of original handles for the selected entities.
214
- */
215
- getSelected(): string[];
216
- /**
217
- * Select model entities by original handles that are obtained using
218
- * {@link File.getProperties | File.getProperties()} or
219
- * {@link File.searchProperties | File.searchProperties()} methods.
220
- *
221
- * Fires:
222
- *
223
- * - {@link SelectEvent | select}
224
- *
225
- * @param handles - The list of original handles.
226
- */
227
- setSelected(handles?: string[]): void;
228
- /**
229
- * Load model references into the viewer. References are images, fonts, or any other files to
230
- * correct rendering of the model.
231
- *
232
- * @async
233
- * @param model - Instance of model with references. If a `File` instance is specified
234
- * instead of a model, the file references will be loaded.
235
- */
236
- loadReferences(model: Model | File | Assembly): Promise<this>;
237
- applyModelTransformMatrix(model: Model | Assembly): void;
238
- applySceneGraphSettings(options?: Options): void;
239
- /**
240
- * Loads a model of a file or assembly into the viewer.
241
- *
242
- * This method requires a [Client]{@link Client | Client} instance to work. For standalone
243
- * viewer instance use {@link Viewer#openVsfFile | openVsfFile()} or
244
- * {@link Viewer#openVsfxFile | openVsfxFile()}.
245
- *
246
- * Fires:
247
- *
248
- * - {@link OpenEvent | open}
249
- * - {@link GeometryStartEvent | geometrystart}
250
- * - {@link GeometryProgressEvent | geometryprogress}
251
- * - {@link DatabaseChunkEvent | databasechunk}
252
- * - {@link GeometryChunkEvent | geometrychunk}
253
- * - {@link GeometryEndEvent | geometryend}
254
- * - {@link GeometryErrorEvent | geometryerror}
255
- *
256
- * @async
257
- * @param model - Model instance to load. If a `File` instance with multiple models is
258
- * specified, the default model will be loaded. If there is no default model, first
259
- * availiable model will be loaded.
260
- */
261
- open(model: Model | File | Assembly): Promise<this>;
262
- /**
263
- * Loads a VSF file into the viewer.
264
- *
265
- * Fires:
266
- *
267
- * - {@link OpenEvent | open}
268
- * - {@link GeometryStartEvent | geometrystart}
269
- * - {@link GeometryProgressEvent | geometryprogress}
270
- * - {@link DatabaseChunkEvent | databasechunk}
271
- * - {@link GeometryEndEvent | geometryend}
272
- * - {@link GeometryErrorEvent | geometryerror}
273
- *
274
- * @param buffer - Binary data buffer to load.
275
- */
276
- openVsfFile(buffer: Uint8Array | ArrayBuffer): this;
277
- /**
278
- * Loads a VSFX file into the viewer.
279
- *
280
- * Fires:
281
- *
282
- * - {@link OpenEvent | open}
283
- * - {@link GeometryStartEvent | geometrystart}
284
- * - {@link GeometryProgressEvent | geometryprogress}
285
- * - {@link DatabaseChunkEvent | databasechunk}
286
- * - {@link GeometryEndEvent | geometryend}
287
- * - {@link GeometryErrorEvent | geometryerror}
288
- *
289
- * @param buffer - Binary data buffer to load.
290
- */
291
- openVsfxFile(buffer: Uint8Array | ArrayBuffer): this;
292
- /**
293
- * Cancels asynchronous model loading started by {@link Viewer#open | open()}.
294
- */
295
- cancel(): this;
296
- /**
297
- * Unloads the model and clears the viewer.
298
- */
299
- clear(): this;
300
- /**
301
- * Get markup color.
302
- *
303
- * @returns Color with `RGB` values.
304
- */
305
- getMarkupColor(): {
306
- r: number;
307
- g: number;
308
- b: number;
309
- };
310
- /**
311
- * Set markup color.
312
- *
313
- * @param r - `Red` part of color.
314
- * @param g - `Green` part of color.
315
- * @param b - `Blue` part of color.
316
- */
317
- setMarkupColor(r?: number, g?: number, b?: number): void;
318
- /**
319
- * Colorize all markup entities with the specified color.
320
- *
321
- * @param r - `Red` part of color.
322
- * @param g - `Green` part of color.
323
- * @param b - `Blue` part of color.
324
- */
325
- colorizeAllMarkup(r?: number, g?: number, b?: number): void;
326
- /**
327
- * Add an empty markup entity to the overlay.
328
- */
329
- addMarkupEntity(entityName: string): any;
330
- /**
331
- * Draw a viewpoint. To get a list of available model viewpoints, use the
332
- * {@link Model#getViewpoints | Model.getViewpoints()} or
333
- * {@link File#getViewpoints | File.getViewpoints()}.
334
- *
335
- * @param viewpoint - Viewpoint.
336
- */
337
- drawViewpoint(viewpoint: any): void;
338
- /**
339
- * Create a viewpoint. To add a viewpoint to the list of model viewpoints, use the
340
- * {@link Model#saveViewpoint | Model.saveViewpoint()} or
341
- * {@link File#saveViewpoint | File.saveViewpoint()}.
342
- */
343
- createViewpoint(): object;
344
- /**
345
- * Executes the command denoted by the given command identifier.
346
- *
347
- * @param id - Identifier of the command to execute.
348
- * @param args - Parameters passed to the command function.
349
- * @returns A returned value of the given command. Returns `undefined` when the command doesn't exists.
350
- */
351
- executeCommand(id: string, ...args: any[]): any;
352
- }
1
+ import { IViewer } from "./IViewer";
2
+ import { EventEmitter2 } from "./EventEmitter2";
3
+ import { ViewerEventMap } from "./ViewerEvents";
4
+ import { OptionsEventMap } from "./OptionsEvents";
5
+ import { OdBaseDragger } from "./Draggers/Common/OdBaseDragger";
6
+ import { Client } from "../Api/Client";
7
+ import { File } from "../Api/File";
8
+ import { Assembly } from "../Api/Assembly";
9
+ import { Model } from "../Api/Model";
10
+ import { Options, OptionsData } from "./Options";
11
+ import { IMarkup, MarkupType } from "./Markup/IMarkup";
12
+ /**
13
+ * The `Client.js` library class that provides methods to integrate with the
14
+ * [VisualizeJS](https://cloud.opendesign.com/docs/index.html#/visualizejs) library.
15
+ */
16
+ export declare class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventMap> implements IViewer {
17
+ private _activeDragger;
18
+ private _zoomWheelDragger;
19
+ private _gestureManager;
20
+ private _enableAutoUpdate;
21
+ private _isNeedRender;
22
+ private _isRunAsyncUpdate;
23
+ private _renderTime;
24
+ protected _options: Options;
25
+ protected _visualizeJsUrl: string;
26
+ protected _abortControllerForReferences: AbortController | undefined;
27
+ private clientoptionschange;
28
+ private canvaseventlistener;
29
+ draggerFactory: Map<string, typeof OdBaseDragger>;
30
+ canvasEvents: string[];
31
+ private frameId;
32
+ private _resizeObserver;
33
+ canvas: HTMLCanvasElement | undefined;
34
+ markup: IMarkup;
35
+ visualizeJs: any;
36
+ _abortController: AbortController | undefined;
37
+ _abortControllerForRequestMap: Map<string, AbortController> | undefined;
38
+ client: Client;
39
+ /**
40
+ * @param client - The `Client` instance that provides access to a server. Do not specify
41
+ * `Client` if you need a standalone viewer instance without access to server models.
42
+ * @param params - An object containing viewer configuration parameters.
43
+ * @param params.visualizeJsUrl - `VisualizeJS` library URL. Set this URL to use your own
44
+ * library instance, or leave it undefined or blank to use the default URL defined by
45
+ * `Client.js` you are using.
46
+ *
47
+ * _Note: Your own `VisualizeJS` library version must match the version of the `Client.js`
48
+ * you are using._
49
+ * @param params.enableAutoUpdate - Enable auto-update of the viewer after any changes. If
50
+ * the auto-update is disabled, you need to update the `VisualizeJS` viewer and the active
51
+ * dragger manually using the `update` event. Default is `true`.
52
+ */
53
+ constructor(client?: Client, params?: {
54
+ visualizeJsUrl?: string;
55
+ enableAutoUpdate?: boolean;
56
+ markupType?: MarkupType;
57
+ });
58
+ /**
59
+ * `VisualizeJS` parameters.
60
+ *
61
+ * Use this only for standalone viewer instances. Use {@link Client#options | Client.options}
62
+ * instead if the viewer was created with a `Client` reference using
63
+ * {@link Viewer | Viewer.create(client)}. Changes in client options will be automatically
64
+ * applied to the viewer options.
65
+ */
66
+ get options(): Options;
67
+ /**
68
+ * `VisualizeJS` library URL. Use {@link Viewer#configure | configure()} to change library URL.
69
+ *
70
+ * @readonly
71
+ */
72
+ get visualizeJsUrl(): string;
73
+ /**
74
+ * Change the viewer configuration parameters.
75
+ *
76
+ * @param params - An object containing new configuration parameters.
77
+ * @param params.visualizeJsUrl - `VisualizeJS` library URL. Set this URL to use your own
78
+ * library instance or leave it blank to use the default URL defined by `Client.js`.
79
+ */
80
+ configure(params: {
81
+ visualizeJsUrl?: string;
82
+ }): this;
83
+ /**
84
+ * A [Viewer]{@link Viewer} event measuring progress of loading a `VisualizeJS` library.
85
+ *
86
+ * @property {string} type - `visualizeprogress`
87
+ * @property {number} loaded - A 64-bit unsigned integer value indicating the amount of work
88
+ * already performed by the underlying process. The ratio of work done can be calculated by
89
+ * dividing total by the value of this property.
90
+ * @property {number} total - A 64-bit unsigned integer representing the total amount of work
91
+ * that the underlying process is in the progress of performing.
92
+ * @event visualizeprogress
93
+ */
94
+ /**
95
+ * Load `VisualizeJS` module and initialize it with the specified canvas. Call
96
+ * {@link Viewer#dispose | dispose()} to release allocated resources.
97
+ *
98
+ * @async
99
+ * @param canvas - HTML `<canvas>` element for `VisualizeJS`.
100
+ * @param onProgress - A callback function that handles events measuring progress of loading
101
+ * of the `VisualizeJS` library. Retrieves {@link event:visualizeprogress | visualizeprogress} event.
102
+ */
103
+ initialize(canvas: HTMLCanvasElement, onProgress?: (event: ProgressEvent) => void): Promise<this>;
104
+ /**
105
+ * Releases all resources allocated by this `Viewer` instance. Call this method before
106
+ * release the `Viewer` instance.
107
+ */
108
+ dispose(): this;
109
+ /**
110
+ * Returns `true` if `VisualizeJS` module has been loaded andinitialized.
111
+ */
112
+ isInitialized(): boolean;
113
+ private render;
114
+ resize(): this;
115
+ /**
116
+ * Updates the viewer. Do nothing if the auto-update mode is disabled in the constructor (use
117
+ * the `update` event to update viewer manually).
118
+ *
119
+ * Fires:
120
+ *
121
+ * - {@link UpdateEvent | update}
122
+ *
123
+ * @param force - If `true` updates the viewer immidietly. Otherwise updates on next
124
+ * animation frame. Default is `false`.
125
+ */
126
+ update(force?: boolean): void;
127
+ /**
128
+ * Update with internal schedule, need after change operation when have long update for
129
+ * update without lock UI
130
+ *
131
+ * @param maxScheduleUpdateTimeInMs - Maximum time for one update, by default 30 ms
132
+ * @param maxScheduleUpdateCount - Maximum count of schedule update
133
+ * @returns return void Promise
134
+ */
135
+ private scheduleUpdateAsync;
136
+ updateAsync(maxScheduleUpdateTimeInMs?: number, maxScheduleUpdateCount?: number): Promise<void>;
137
+ /**
138
+ * Returns `VisualizeJS`
139
+ * {@link https://cloud.opendesign.com/docs/index.html#/visualizejs_api | module} instance.
140
+ */
141
+ visLib(): any;
142
+ /**
143
+ * Returns `VisualizeJS`
144
+ * {@link https://cloud.opendesign.com/docs/index.html#/vis/Viewer | Viewer} instance.
145
+ */
146
+ visViewer(): any;
147
+ syncOpenCloudVisualStyle(isInitializing: boolean): this;
148
+ syncOptions(options?: OptionsData): this;
149
+ syncHighlightingOptions(options?: OptionsData): this;
150
+ /**
151
+ * List of names of available draggers:
152
+ *
153
+ * - `Line`
154
+ * - `Text`
155
+ * - `Pan`
156
+ * - `Orbit`
157
+ * - `Zoom`
158
+ * - `ZoomWindow`
159
+ * - `OrbitAroundBuilding`
160
+ * - `MeasureLine`
161
+ * - `CuttingPlaneXAxis`
162
+ * - `CuttingPlaneYAxis`
163
+ * - `CuttingPlaneZAxis`
164
+ * - `Walk`
165
+ *
166
+ * @readonly
167
+ */
168
+ get draggers(): string[];
169
+ /**
170
+ * Register dragger on draggerFactory.
171
+ *
172
+ * @param name - Dragger name.
173
+ * @param dragger - Dragger class.
174
+ */
175
+ registerDragger(name: string, dragger: typeof OdBaseDragger): void;
176
+ /**
177
+ * Returns active dragger instance or `null` if there is no active dragger.
178
+ */
179
+ activeDragger(): any | null;
180
+ /**
181
+ * Set active dragger. `Viewer` must be {@link Viewer#initialize | initialized} before enable
182
+ * dragger or exception is thrown.
183
+ *
184
+ * Fires:
185
+ *
186
+ * - {@link ChangeActiveDragger | changeactivedragger}
187
+ *
188
+ * @param name - Dragger name. Can be one of the {@link Viewer#draggers | draggers} list.
189
+ * @returns Returns active dragger instance or `null` if there is no dragger with the given name.
190
+ */
191
+ setActiveDragger(name: string): OdBaseDragger | null;
192
+ /**
193
+ * Reset the state of the active dragger.
194
+ */
195
+ resetActiveDragger(): void;
196
+ /**
197
+ * Remove all cutting planes.
198
+ */
199
+ clearSlices(): void;
200
+ /**
201
+ * Remove markup overlay.
202
+ */
203
+ clearOverlay(): void;
204
+ /**
205
+ * Synchronize markup overlay.
206
+ */
207
+ syncOverlay(): any;
208
+ /**
209
+ * Returns `true` if current drawing is 3D drawing.
210
+ */
211
+ is3D(): boolean;
212
+ /**
213
+ * Returns a list of original handles for the selected entities.
214
+ */
215
+ getSelected(): string[];
216
+ /**
217
+ * Select model entities by original handles that are obtained using
218
+ * {@link File.getProperties | File.getProperties()} or
219
+ * {@link File.searchProperties | File.searchProperties()} methods.
220
+ *
221
+ * Fires:
222
+ *
223
+ * - {@link SelectEvent | select}
224
+ *
225
+ * @param handles - The list of original handles.
226
+ */
227
+ setSelected(handles?: string[]): void;
228
+ /**
229
+ * Load model references into the viewer. References are images, fonts, or any other files to
230
+ * correct rendering of the model.
231
+ *
232
+ * @async
233
+ * @param model - Instance of model with references. If a `File` instance is specified
234
+ * instead of a model, the file references will be loaded.
235
+ */
236
+ loadReferences(model: Model | File | Assembly): Promise<this>;
237
+ applyModelTransformMatrix(model: Model | Assembly): void;
238
+ applySceneGraphSettings(options?: Options): void;
239
+ /**
240
+ * Loads a model of a file or assembly into the viewer.
241
+ *
242
+ * This method requires a [Client]{@link Client | Client} instance to work. For standalone
243
+ * viewer instance use {@link Viewer#openVsfFile | openVsfFile()} or
244
+ * {@link Viewer#openVsfxFile | openVsfxFile()}.
245
+ *
246
+ * Fires:
247
+ *
248
+ * - {@link OpenEvent | open}
249
+ * - {@link GeometryStartEvent | geometrystart}
250
+ * - {@link GeometryProgressEvent | geometryprogress}
251
+ * - {@link DatabaseChunkEvent | databasechunk}
252
+ * - {@link GeometryChunkEvent | geometrychunk}
253
+ * - {@link GeometryEndEvent | geometryend}
254
+ * - {@link GeometryErrorEvent | geometryerror}
255
+ *
256
+ * @async
257
+ * @param model - Model instance to load. If a `File` instance with multiple models is
258
+ * specified, the default model will be loaded. If there is no default model, first
259
+ * availiable model will be loaded.
260
+ */
261
+ open(model: Model | File | Assembly): Promise<this>;
262
+ /**
263
+ * Loads a VSF file into the viewer.
264
+ *
265
+ * Fires:
266
+ *
267
+ * - {@link OpenEvent | open}
268
+ * - {@link GeometryStartEvent | geometrystart}
269
+ * - {@link GeometryProgressEvent | geometryprogress}
270
+ * - {@link DatabaseChunkEvent | databasechunk}
271
+ * - {@link GeometryEndEvent | geometryend}
272
+ * - {@link GeometryErrorEvent | geometryerror}
273
+ *
274
+ * @param buffer - Binary data buffer to load.
275
+ */
276
+ openVsfFile(buffer: Uint8Array | ArrayBuffer): this;
277
+ /**
278
+ * Loads a VSFX file into the viewer.
279
+ *
280
+ * Fires:
281
+ *
282
+ * - {@link OpenEvent | open}
283
+ * - {@link GeometryStartEvent | geometrystart}
284
+ * - {@link GeometryProgressEvent | geometryprogress}
285
+ * - {@link DatabaseChunkEvent | databasechunk}
286
+ * - {@link GeometryEndEvent | geometryend}
287
+ * - {@link GeometryErrorEvent | geometryerror}
288
+ *
289
+ * @param buffer - Binary data buffer to load.
290
+ */
291
+ openVsfxFile(buffer: Uint8Array | ArrayBuffer): this;
292
+ /**
293
+ * Cancels asynchronous model loading started by {@link Viewer#open | open()}.
294
+ */
295
+ cancel(): this;
296
+ /**
297
+ * Unloads the model and clears the viewer.
298
+ */
299
+ clear(): this;
300
+ /**
301
+ * Get markup color.
302
+ *
303
+ * @returns Color with `RGB` values.
304
+ */
305
+ getMarkupColor(): {
306
+ r: number;
307
+ g: number;
308
+ b: number;
309
+ };
310
+ /**
311
+ * Set markup color.
312
+ *
313
+ * @param r - `Red` part of color.
314
+ * @param g - `Green` part of color.
315
+ * @param b - `Blue` part of color.
316
+ */
317
+ setMarkupColor(r?: number, g?: number, b?: number): void;
318
+ /**
319
+ * Colorize all markup entities with the specified color.
320
+ *
321
+ * @param r - `Red` part of color.
322
+ * @param g - `Green` part of color.
323
+ * @param b - `Blue` part of color.
324
+ */
325
+ colorizeAllMarkup(r?: number, g?: number, b?: number): void;
326
+ /**
327
+ * Add an empty markup entity to the overlay.
328
+ */
329
+ addMarkupEntity(entityName: string): any;
330
+ /**
331
+ * Draw a viewpoint. To get a list of available model viewpoints, use the
332
+ * {@link Model#getViewpoints | Model.getViewpoints()} or
333
+ * {@link File#getViewpoints | File.getViewpoints()}.
334
+ *
335
+ * @param viewpoint - Viewpoint.
336
+ */
337
+ drawViewpoint(viewpoint: any): void;
338
+ /**
339
+ * Create a viewpoint. To add a viewpoint to the list of model viewpoints, use the
340
+ * {@link Model#saveViewpoint | Model.saveViewpoint()} or
341
+ * {@link File#saveViewpoint | File.saveViewpoint()}.
342
+ */
343
+ createViewpoint(): object;
344
+ /**
345
+ * Executes the command denoted by the given command identifier.
346
+ *
347
+ * @param id - Identifier of the command to execute.
348
+ * @param args - Parameters passed to the command function.
349
+ * @returns A returned value of the given command. Returns `undefined` when the command doesn't exists.
350
+ */
351
+ executeCommand(id: string, ...args: any[]): any;
352
+ }
353
353
  //# sourceMappingURL=Viewer.d.ts.map