Class BaseMapBuilding

constructor

• new BaseMapBuilding(id, name, buildingNumber): BaseMapBuilding

• Initializer to use if the building has and a custom building number. Otherwise the building number is deduced from the id pattern.

  Parameters

  • id: string

    ID of the building.

  • name: string

    Name of the building.

  • buildingNumber: number

    the number of the building

  Returns BaseMapBuilding

  Since

  1.2

addFloor

• addFloor(floor): void

• Adds a floor this building.

  Parameters

  • floor: BaseMapBuildingFloor

    The floor to add.

  Returns void

getBuildingBounds

• getBuildingBounds(): LatLngBounds

• Returns LatLngBounds

  the bounding box for this building

  Since

  1.2

getBuildingNumber

• getBuildingNumber(): number

• Returns number

  the building ordinal value

  Since

  1.1

getCenterLocation

• getCenterLocation(): LatLng

• The center of the building, based on its shape. Note: This may be a weird location if the building is oddly shaped

  Returns LatLng

  the center of the building

  Since

  1.1

getClassName

• getClassName(): string

• Returns string

getCoordinates

• getCoordinates(): LatLng[][]

• Returns LatLng[][]

  the coordinates making of the perimeter of this building

getFeatureId

• getFeatureId(): string

• Returns string

getFloorWithId

• getFloorWithId(floorId): BaseMapBuildingFloor

• Lookup a floor by its id

  Parameters

  • floorId: string

    the floor's id

  Returns BaseMapBuildingFloor

  a floor object if it exists, null otherwise

getFloors

• getFloors(): Map<string, BaseMapBuildingFloor>

• Returns Map<string, BaseMapBuildingFloor>

  Map that contains all of the floors within this building. The key is the floor's uid.

getGeojsonCoordinates

• getGeojsonCoordinates(): any[]

• Returns any[]

  Since

  1.2.1

getGeometryType

• getGeometryType(): string

• Returns string

  Since

  1.2.1

getId

• getId(): string

• Returns string

  Unique identifier of the building.

getName

• getName(): string

• Returns string

  Display name of the building.

getPlaceId

• getPlaceId(): string

• Returns string

hasFloor

• hasFloor(floorId): boolean

• Parameters

  • floorId: string

  Returns boolean

setBuildingBounds

• setBuildingBounds(buildingBounds): void

• Parameters

  • buildingBounds: LatLngBounds

    the new bounding box for this building

  Returns void

  Since

  1.2

setClassName

• setClassName(value): BaseMapBuilding

• Parameters

  • value: string

  Returns BaseMapBuilding

setCoordinates

• setCoordinates(coordinates): BaseMapBuilding

• Parameters

  • coordinates: LatLng[][]

    the coordinates making of the perimeter of this building

  Returns BaseMapBuilding

setFeatureId

• setFeatureId(value): BaseMapBuilding

• Parameters

  • value: string

  Returns BaseMapBuilding

setGeojsonCoordinates

• setGeojsonCoordinates(geojsonCoordinates): BaseMapBuilding

• Parameters

  • geojsonCoordinates: any[]

  Returns BaseMapBuilding

  Since

  1.2.1

setGeometryType

• setGeometryType(geometryType): BaseMapBuilding

• Parameters

  • geometryType: string

  Returns BaseMapBuilding

  Since

  1.2.1

setId

• setId(id): void

• Parameters

  • id: string

    the new unique identifier of the building.

  Returns void

setName

• setName(name): void

• Parameters

  • name: string

    the new name

  Returns void

setPlaceId

• setPlaceId(value): BaseMapBuilding

• Parameters

  • value: string

  Returns BaseMapBuilding

Static extractNumberFromID

• extractNumberFromID(id): number

• Strip off the last number from the end of the id

  Parameters

  • id: string

    the building id

  Returns number

  the number

Static getBuildingWithId

• getBuildingWithId(id): BaseMapBuilding

• Initializer to use if building does not have a name.

  Parameters

  • id: string

    ID of the building.

  Returns BaseMapBuilding

Static getBuildingWithIdAndName

• getBuildingWithIdAndName(id, name): BaseMapBuilding

• Initializer to use if the building has a name.

  Parameters

  • id: string

    ID of the building.

  • name: string

    Name of the building.

  Returns BaseMapBuilding

buildingBounds

buildingNumber

id

name