@x-viewer/plugins 0.9.0 → 0.11.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/README.md CHANGED
@@ -1,3 +1,38 @@
1
1
  # plugins
2
2
 
3
- This is the plugin package of reusable crucial pieces of code for x-viewer.
3
+ Plugin package that provides extensible functionality modules for x-viewer. It includes measurement tools, markup annotations, section planes, toolbars, property panels, layer management, export/screenshot features, and various UI enhancements for building rich CAD/BIM viewing experiences.
4
+
5
+ ## Example
6
+
7
+ ### Toolbar, Layer Manager, and Measurement (Viewer2d)
8
+
9
+ ```typescript
10
+ import { Viewer2d } from "@x-viewer/core";
11
+ import {
12
+ LayerManagerPlugin,
13
+ MeasurementPlugin,
14
+ MeasurementType,
15
+ Viewer2dToolbarPlugin,
16
+ } from "@x-viewer/plugins";
17
+
18
+ // Create a 2D viewer
19
+ const viewer = new Viewer2d({
20
+ containerId: "viewer2d",
21
+ enableLayoutBar: true,
22
+ });
23
+
24
+ // Install toolbar plugin
25
+ const toolbarPlugin = new Viewer2dToolbarPlugin(viewer);
26
+
27
+ // Install layer manager plugin (the panel is attached to the element with id 'layer-panel')
28
+ const layerManager = new LayerManagerPlugin(viewer, {
29
+ containerId: "layer-panel",
30
+ visible: true,
31
+ });
32
+
33
+ // Install measurement plugin
34
+ const measurement = new MeasurementPlugin(viewer);
35
+
36
+ // Enable distance measurement mode (users can click in the view to create measurements)
37
+ measurement.activate(MeasurementType.Distance);
38
+ ```