[BIM-3878] Document resetSectionBox, getNumObjectsHidden, `getSec…

…tionBoxDisplay` added in v12.0.0 (#226) * Document `model.resetSectionBox` * Move getNumObjectsSelected to be next to object selection methods * Document `model.getNumObjectsHidden` * Document `model.getSectionBoxDisplay`
procore · Mar 11, 2024 · 6b74a6a · 6b74a6a
1 parent 808cadf
commit 6b74a6a
Showing 1 changed file with 128 additions and 34 deletions.
diff --git a/bim_webviewer/bim_web_viewer.md b/bim_webviewer/bim_web_viewer.md
@@ -2182,6 +2182,34 @@ Model
 
 ---
 
+### Reset Section Box
+
+<p class="heading-link-container"><a class="heading-link" href="#reset-section-box"></a></p>
+
+```js
+resetSectionBox();
+```
+
+#### Description
+
+Resets section box to global bounding box of model.
+
+#### Parameters
+
+None
+
+##### Returns
+
+```js
+undefined
+```
+
+##### Namespace
+
+Model
+
+---
+
 ### Toggle Section Box Display
 
 <p class="heading-link-container"><a class="heading-link" href="#toggle-section-box-display"></a></p>
@@ -2296,6 +2324,43 @@ Model
 
 ---
 
+### Get Section Box Display
+
+<p class="heading-link-container"><a class="heading-link" href="#get-section-box-display"></a></p>
+
+```ts
+getSectionBoxDisplay();
+```
+
+#### Description
+
+Gets the current section box display status.
+
+#### Parameters
+
+None
+
+##### Returns
+
+```ts
+{
+  enabled: boolean,
+  configuration: ConfigureSectionBoxDisplayConfig,
+  bbox: {
+    min: { x: number, y: number, z: number },
+    max: { x: number, y: number, z: number },
+  },
+}
+```
+
+For `ConfigureSectionBoxDisplayConfig` schema, see [`model.configureSectionBoxDisplay`](#configure-section-box-display).
+
+##### Namespace
+
+Model
+
+---
+
 ### Add Section Plane
 
 <p class="heading-link-container"><a class="heading-link" href="#add-section-plane"></a></p>
@@ -2551,38 +2616,6 @@ Model
 
 ---
 
-### Get Number Of Objects Selected
-
-<p class="heading-link-container"><a class="heading-link" href="#get-number-of-objects-selected"></a></p>
-
-```js
-getNumObjectsSelected(method);
-```
-
-#### Description
-
-Retrieve the number of objects selected base on the count method. 
-
-#### Parameters
-
-| Field Name | Required | Type | Description |
-| - | - | - | - |
-| method | false | string |  Method to count, can be the following: `FirstObject`, `Object`, or `Geometry`. Default value is `FirstObject` |
-
-##### Returns
-
-```js
-{
-  count: number
-}
-```
-
-##### Namespace
-
-Model
-
----
-
 ### Get Object
 
 <p class="heading-link-container"><a class="heading-link" href="#get-object"></a></p>
@@ -2626,7 +2659,6 @@ Model
 
 ---
 
-
 ### Get Objects
 
 <p class="heading-link-container"><a class="heading-link" href="#get-objects"></a></p>
@@ -2747,7 +2779,6 @@ Model
 
 ---
 
-
 ### Hide All Objects
 
 <p class="heading-link-container"><a class="heading-link" href="#hide-all-objects"></a></p>
@@ -2865,6 +2896,36 @@ Model
 
 ---
 
+### Get Number Of Objects Hidden
+
+<p class="heading-link-container"><a class="heading-link" href="#get-number-of-objects-hidden"></a></p>
+
+```js
+getNumObjectsHidden();
+```
+
+#### Description
+
+Retrieve the number of objects selected based on the `FirstObject` counting method.
+
+#### Parameters
+
+None
+
+##### Returns
+
+```js
+{
+  count: number
+}
+```
+
+##### Namespace
+
+Model
+
+---
+
 ### Select Objects
 
 <p class="heading-link-container"><a class="heading-link" href="#select-objects"></a></p>
@@ -3013,6 +3074,39 @@ Model
 
 ---
 
+### Get Number Of Objects Selected
+
+<p class="heading-link-container"><a class="heading-link" href="#get-number-of-objects-selected"></a></p>
+
+```js
+getNumObjectsSelected(method);
+```
+
+#### Description
+
+Retrieve the number of objects selected based on the count method.
+
+#### Parameters
+
+| Field Name | Required | Type | Description |
+| - | - | - | - |
+| method | false | string |  Method to count, can be the following: `FirstObject`, `Object`, or `Geometry`. Default value is `FirstObject` |
+
+##### Returns
+
+```js
+{
+  count: number
+}
+```
+
+##### Namespace
+
+Model
+
+---
+
+
 ### Set X Ray Mode
 
 <p class="heading-link-container"><a class="heading-link" href="#set-x-ray-mode"></a></p>