Skip to content

Commit 4d85937

Browse files
[BM-120] setMeasurement Documentation Updates (#280)
* Update `setMeasurement` * Use two tables instead * Add single ticks
1 parent 4e3fd63 commit 4d85937

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

example apps and sdks/bim_webviewer/bim_web_viewer.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3365,18 +3365,27 @@ Model
33653365
<p class="heading-link-container"><a class="heading-link" href="#set-measurement"></a></p>
33663366

33673367
```js
3368-
setMeasurement(enable);
3368+
setMeasurement(enable, options = {});
33693369
```
33703370

33713371
#### Description
33723372

3373-
Enables or disables the measurement tool. Requires the Measurement Tool be enabled upon viewer initialization by adding `MEASUREMENT_SD` to the options tools array.
3373+
Enables or disables the measurement tool. The options parameter allows specifying the measurement mode. The measurementMode can either be `point` for Point to Point measurements or `object` for Shortest Distance measurements.
3374+
33743375

33753376
#### Parameters
33763377

33773378
| Field Name | Required | Type | Description |
33783379
| - | - | - | - |
33793380
| enable | true | boolean | True to enable the measurement tool. False to disable. |
3381+
| options | false | object | Additional options for the measurement tool. |
3382+
3383+
##### Options
3384+
3385+
| Field Name | Required | Type | Description |
3386+
| - | - | - | - |
3387+
| measurementMode | false | string | Specifies the measurement mode. Can be `point` or `object`. |
3388+
33803389

33813390
##### Returns
33823391

0 commit comments

Comments
 (0)