Appearance
BIM Properties
The properties object (serialized as dsProps in some contexts) contains comprehensive metadata specific to the application logic and BIM data.
Properties Object
| Key | Type | Description |
|---|---|---|
type | String | The classification of the element (e.g., "Wall", "Slab"). |
keepSourceMesh | Boolean | Whether to preserve the original mesh data. |
edited | Boolean | Indicates if the element has been modified. |
isLocked | Boolean | Whether the element is locked from editing. |
isSelected | Boolean | Selection state. |
isHeightLocked | Boolean | Whether the height property is constrained. |
revitMetaData | Object | Revit-specific data including path and parameters. |
areas | Object | Calculated areas (e.g., bottomFace). |
cost | Number | Base cost value. |
constructionCost | Object | Breakdown of construction costs. |
changeData | Object | Tracking for changes in volume, area, length, etc. |
properties | Object | Detailed material and layer properties (see below). |
structure_id | String | ID of the parent structure. |
storey | Number | Storey index. |
quantitativeData | Object | Geometric quantities (area, volume, running length). |
slope | Number | Slope value. |
profile | Number | Profile identifier. |
id | String | Element unique identifier (e.g., "wl_z4ww48gox"). |
room_id | String | ID of the room this element belongs to. |
thickness | Number | Element thickness. |
brep | String | Serialized B-Rep (Boundary Representation) data. |
Nested Property Objects
Properties (Material/Layer Data)
| Key | Type | Description |
|---|---|---|
type | String | Material type description (e.g., "Exposed concrete"). |
layers | Array | List of material layers. |
thickness | Number | Total thickness. |
purpose | String | Usage classification (e.g., "External"). |
version | Number | Version number. |
Layer Definition
| Key | Type | Description |
|---|---|---|
name | String | Layer name. |
thickness | Number | Layer thickness. |
material | Object | Material reference (type, name). |
type | String | Layer function (e.g., "Structure"). |
thicknessType | String | Type definition (e.g., "Regular"). |
isCore | Boolean | Whether this is a core layer. |
Quantitative Data
| Key | Type | Description |
|---|---|---|
area | Object | Area breakdown (bottom, lateralSurface, largest). |
runningLength | Number | Linear length of the element. |
volume | Number | Volume of the element. |
Example Snippet
json
"dsProps": {
"type": "Wall",
"isLocked": false,
"isHeightLocked": true,
"revitMetaData": {
"path": "",
"parametricExportSupportStatus": "NOT_CHECKED"
},
"properties": {
"type": "Exposed concrete",
"layers": [
{
"name": "Concrete",
"thickness": 0.8,
"material": { "type": "Concrete", "name": "Concrete_Grooved.jpg" },
"type": "Structure",
"isCore": false
}
],
"thickness": 1.6,
"purpose": "External"
},
"quantitativeData": {
"area": { "bottom": 48.6, "lateralSurface": 346.5 },
"volume": 554.4
},
"height": 12
}