Place
Extends
AbstractEntity
class Place extends AbstractEntity
Static
create
static create(json = null): Place
Parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| json | null | object | No | null | Used to constructor from a JSON representation. See fromJSON |
Returns:
Type: Place
getName
static getName(): "Place"
Returns:
Type: constant ("Place": string)
Constructor
constructor
constructor(json = null): Place
Parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| json | null | object | No | null | Used to constructor from a JSON representation. See fromJSON |
Properties
building_id
| Type | Default | Description |
|---|---|---|
| int | null | null |
created_at
| Type | Default | Description |
|---|---|---|
| Date | null | null |
custom_objects
| Type | Default | Description |
|---|---|---|
| Collection<CustomObject> | new Collection('CustomObject') |
floor_id
| Type | Default | Description |
|---|---|---|
| int | null | null |
id
| Type | Default | Description |
|---|---|---|
| null | int | symbol | null | The entity identifier |
name
| Type | Default | Description |
|---|---|---|
| string | null |
metadata
| Type | Default | Description |
|---|---|---|
| Map | new Map() |
path_node_id
| Type | Default | Description |
|---|---|---|
| int | null | null |
pois
| Type | Default | Description |
|---|---|---|
| Collection<Poi> | new Collection('Poi') |
position
| Type | Default | Description |
|---|---|---|
| Vector | new Vector() |
shape_id
| Type | Default | Description |
|---|---|---|
| int | null | null |
signature
| Type | Default | Description |
|---|---|---|
| string | null | null |
site
| Type | Default | Description |
|---|---|---|
| Reference<Site> | new Reference('Site', null) |
updated_at
| Type | Default | Description |
|---|---|---|
| Date | null | null |
Read-Only
version
| Type | Default | Description |
|---|---|---|
| int | null |
Read-Only
Methods
toJSON
toJSON(): object
Returns:
Type: object (see properties bellow)
| Name | Type | Description |
|---|---|---|
| building_id | int | null | |
| created_at | string | null | Datetime in ISO 8601 format |
| custom_objects | Array< int | symbol ≷ | |
| floor_id | int | null | |
| id | int | symbol | null | |
| name | string | null | |
| metadata | object | |
| pois | Array< int | symbol ≷ | |
| position | {x: number, y: number, z: number} | |
| shape_id | int | null | |
| signature | string | null | |
| site | int | symbol | null | |
| updated_at | string | null | Datetime in ISO 8601 format |
| version | int |
fromJSON
fromJSON(json: object): Place
Parameters:
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| json | object | Yes | - | |
| json.building_id | int | null | No | null | |
| json.created_at | string | null | No | null | Datetime in ISO 8601 format |
| json.custom_objects | Array< int | symbol ≷ | No | [] | |
| json.floor_id | int | null | No | null | |
| json.id | int | symbol | null | No | null | |
| json.name | string | null | No | null | |
| json.metadata | object | No | {} | |
| json.pois | Array< int | symbol ≷ | No | [] | |
| json.position | {x: number, y: number, z: number} | No | {x: 0, y: 0, z: 0} | |
| json.shape_id | int | null | No | null | |
| json.signature | string | null | No | null | |
| json.site | int | symbol | null | No | null | |
| json.updated_at | string | null | No | null | Datetime in ISO 8601 format |
| json.version | int | No | null |
Returns:
Returns this
clone
clone(): Place
Returns:
A new deep copy
Type: Place