ObjectManager
Properties
buildings
Type | Read-Only | Description |
---|---|---|
Map< number, BuildingObject> | YES |
floors
Type | Read-Only | Description |
---|---|---|
Map<number, FloorObject> | YES |
labels
Type | Read-Only | Description |
---|---|---|
Map<number, LabelObject> | YES |
site
Type | Read-Only | Description |
---|---|---|
SiteObject | YES |
spaces
Type | Read-Only | Description |
---|---|---|
Map<number, SpaceObject> | YES |
user
Type | Read-Only | Description |
---|---|---|
?UserObject | YES |
Methods
addLabel
async addLabel(labelObject: LabelObject, parent: SiteObject|BuildingObject|FloorObject|SpaceObject): Promise<void, Error>
Parameters:
Name | Type | Required | Default | Description |
---|---|---|---|---|
labelObject | LabelObject | Yes | - | |
parentObject | SiteObject | BuildingObject | FloorObject | SpaceObject | Yes | - |
Returns:
Type: Promise<void, Error>
addLabelOnAdsumLocation
async addLabelOnAdsumLocation(labelObject: LabelObject, location: AdsumLocation): Promise<void, Error>
Parameters:
Name | Type | Required | Default | Description |
---|---|---|---|---|
labelObject | LabelObject | Yes | - | |
location | AdsumLocation | Yes | - |
Returns:
Type: Promise<void, Error>
createLabelImageObject
async createLabelImageObject(options: ?AdsumLocation): Promise<LabelImageObject, Error>
Parameters:
Name | Type | Required | Description |
---|---|---|---|
options | LabelImageObjectOptions | object | Yes | The LabelImageObject options. Can be an LabelImageObjectOptions instance or directly the parameter to pass on the LabelImageObjectOptions constructor |
Returns:
Type: Promise< LabelImageObject, Error >
createLabelTextObject
async createLabelTextObject(parameters: ?AdsumLocation): Promise<LabelTextObject, Error>
Parameters:
Name | Type | Required | Description |
---|---|---|---|
options | LabelTextObjectOptions | object | Yes | The LabelTextObject options. Can be an LabelTextObjectOptions instance or directly the parameter to pass on the LabelTextObjectOptions constructor |
Returns:
Type: Promise< LabelTextObject, Error >
getByAdsumLocation
async getByAdsumLocation(adsumLocation: ?AdsumLocation): Promise<?AdsumObject3D, Error>
Parameters:
Name | Type | Required | Default | Description |
---|---|---|---|---|
adsumLocation | ?AdsumLocation | Yes | - |
Returns:
Type: Promise< ?AdsumObject3D, Error >
getFloor
getFloor(floorId: number|symbol): ?FloorObject
Parameters:
Name | Type | Required | Default | Description |
---|---|---|---|---|
floorId | number | Yes | - |
Returns:
Type: ?FloorObject
getBuilding
getBuilding(buildingId: number|symbol): ?BuildingObject
Parameters:
Name | Type | Required | Default | Description |
---|---|---|---|---|
buildingId | number | Yes | - |
Returns:
Type: ?BuildingObject
getSpace
getSpace(spaceId: number|symbol): ?SpaceObject
Parameters:
Name | Type | Required | Default | Description |
---|---|---|---|---|
spaceId | number | Yes | - |
Returns:
Type: ?SpaceObject
getLabel
getLabel(labelId: number|symbol): ?LabelObject
Parameters:
Name | Type | Required | Default | Description |
---|---|---|---|---|
labelId | number | Yes | - |
Returns:
Type: ?LabelObject
removeLabel
async removeLabel(labelObject: LabelObject): Promise<void, Error>
Parameters:
Name | Type | Required | Default | Description |
---|---|---|---|---|
labelObject | LabelObject | Yes | - |
Returns:
Type: Promise<void, Error>