#Shape : Object
Base abstract class, the following objects all extend this object.
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| id | string |
the shape's unique id | |
| name | string |
the shape name | |
| type | int |
0 | the shape's type |
| parentShape | Shape |
the parent shape |
#Layer : Object
The diagram layer data.
Kind: extend from Shape
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| id | string |
the shape's unique id | |
| name | string |
the layer name | |
| type | int |
2 | the shape's type |
| rooms | Array.<Room> |
the rooms in the layer | |
| elevations | Array.<Elevation> |
the elevations in the layer | |
| stairs | Array.<Stair> |
the stairs in the layer | |
| polyLines | Array.<PolyLine> |
the segment lines in the layer | |
| notes | Array.<Note> |
the notes in the layer | |
| blueprints | Array.<string> |
the image ids in the layer |
#Room : Object
The diagram room data.
Kind: extend from Shape
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| id | string |
the shape's unique id | |
| name | string |
the room name | |
| type | int |
3 | the shape's type |
| parentShape | Shape |
the parent shape | |
| floor | Floor |
the floor in the room | |
| walls | Array.<Wall> |
the walls in the room | |
| wallHeight | number |
the wall height | |
| wallThickness | number |
the wall thickness | |
| wallSections | Array.<WallSection> |
the wall section of the room | |
| doors | Array.<Door> |
the doors in the room | |
| windows | Array.<Window> |
the windows in the room |
#Floor : Object
The diagram floor data.
Kind: extend from Shape
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| id | string |
the shape's unique id | |
| type | int |
4 | the shape's type |
| parentShape | Shape |
the parent shape | |
| region | Region |
geometry region | |
| planRegions | Array.<PlanRegion> |
the plan regions in the floor | |
| elevations | Array.<Elevation> |
the elevations in the floor | |
| polyLines | Array.<PolyLine> |
the segment lines in the floor | |
| floorLines | Array.<FloorLine> |
the floor lines in the floor | |
| dividerCount | int |
the divider count | |
| notes | Array.<Note> |
the notes in the floor |
#FloorLine : Object
The diagram floor line data.
Kind: extend from Shape
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| type | int |
14 | the shape's type |
| parentShape | Shape |
the parent shape | |
| assignments | Array.<Assignment> |
the linear/count assignments |
#Wall : Object
The diagram wall data.
Kind: extend from Shape
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| id | string |
the shape's unique id | |
| type | int |
5 | the shape's type |
| parentShape | Shape |
the parent shape | |
| height | number |
the wall height | |
| width | number |
the wall width | |
| planRegions | Array.<PlanRegion> |
the plan regions in the wall | |
| elevations | Array.<Elevation> |
the elevations in the wall | |
| borders | Array.<WallLayerBorder> |
the wall layer borders in the wall | |
| polyLines | Array.<PolyLine> |
the segment lines in the wall | |
| notes | Array.<Note> |
the notes in the wall |
#WallSection : Object
The wall section of the room.
Kind: extend from Shape
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| type | int |
11 | the shape's type |
| parentShape | Shape |
the parent shape | |
| region | Region |
geometry region | |
| floorLineIndex | number |
the wall section dock which floor line | |
| wallHeight | number |
the wall height | |
| thickness | number |
the thickness |
#Door : Object
The diagram door data.
Kind: extend from Shape
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| id | string |
the shape's unique id | |
| type | int |
12 | the shape's type |
| name | string |
the door name | |
| parentShape | Shape |
the parent shape | |
| style | number |
0 | the door style, enumeration values: Common=0, NoLeaf=1, French=2, Sliding=3, Folding=4, DoubleFolding=5, Pocket=6 |
| openIn | boolean |
false |
open in |
| openLeft | boolean |
false |
open left |
| isOpen | boolean |
false |
get or set the door open status |
| assignments | Array.<Assignment> |
the transition assignments | |
| width | number |
the width | |
| height | number |
the height | |
| position | number |
the distance from corner |
#Window : Object
The diagram window data.
Kind: extend from Shape
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| id | string |
the shape's unique id | |
| type | int |
13 | the shape's type |
| parentShape | Shape |
the parent shape | |
| name | string |
the door name | |
| width | number |
the width | |
| height | number |
the height | |
| position | number |
the distance from corner | |
| altitude | number |
the altitude |
#Elevation : Object
The diagram elevation data.
Kind: extend from Shape
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| id | string |
the shape's unique id | |
| type | int |
16 | the shape's type |
| name | string |
the door name | |
| parentShape | Shape |
the parent shape | |
| floor | Floor |
the floor in the elevation | |
| walls | Array.<Wall> |
the walls in the elevation | |
| wallHeight | number |
the wall height | |
| isSunken | boolean |
false |
is recess |
#WallLayerBorder : Object
The diagram wall layer border data.
Kind: extend from Shape
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| type | int |
9 | the shape's type |
| parentShape | Shape |
the parent shape | |
| assignments | Array.<Assignment> |
the linear/count assignments |
#PolyLine : Object
The diagram segment line data.
Kind: extend from Shape
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| type | int |
22 | the shape's type |
| parentShape | Shape |
the parent shape | |
| assignments | Array.<Assignment> |
the linear/count assignments |
#Stair : Object
The diagram stair data.
Kind: extend from Shape
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| id | string |
the shape's unique id | |
| type | int |
33 | the shape's type |
| parentShape | Shape |
the parent shape | |
| units | Array.<StairUnit> |
the stair unit in the stair | |
| stringers | Array.<StairStringer> |
the stair stringers in the stair | |
| planRegions | Array.<PlanRegion> |
the plan regions in the stair |
#StairUnit : Object
The stair unit data in one stair.
Kind: extend from Shape
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| type | int |
32 | the shape's type |
| parentShape | Shape |
the parent shape | |
| steps | Array.<StairStep> |
the steps in one unit |
#StairStep : Object
The stair step data in one stair unit.
Kind: extend from Shape
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| type | int |
31 | the shape's type |
| parentShape | Shape |
the parent shape | |
| assignments | Array.<Assignment> |
the linear/count assignments |
#StairStringer : Object
The stair stringer data in one stair.
Kind: extend from Shape
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| type | int |
30 | the shape's type |
| parentShape | Shape |
the parent shape | |
| assignments | Array.<Assignment> |
the linear/count assignments |
#PlanRegion : Object
The plan region data which contain the product assignments.
Kind: extend from Shape
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| id | string |
the shape's unique id | |
| type | int |
1001 | the shape's type |
| parentShape | Shape |
the parent shape | |
| region | Region |
geometry region | |
| assignments | Array.<Assignment> |
the area/linear/count assignments |
#Assignment : Object
Contains the assigned product and its usage.
Properties
| Name | Type | Description |
|---|---|---|
| prod | Product |
the assigned product |
| usage | number |
the product usage, without unit. can use Measurement to format the string with unit. |
| type | string |
enumeration values of AssignType: Area=1, Linear=2, Count=3, General=4 |
| owner | Shape |
the assigned shape |
| shapeQty | number |
the quantity of the assigned shape |
| isDirect | boolean |
the product is assigned directly |
| repetition | number |
the number of repetitions |