Maps API for JavaScript Developer's Guide

H.service.venues.Building

Class Summary

Extends: H.map.Group

The class represents a building in the venue hierarchy (see H.service.venues.Venue) and holds the floors that belong to the building.

[ For full details, see the Class Details ]

Method Summary

Table 1. Methods
Methods

getVenue () : {H.service.venues.Venue}

This method retrieves the parent object - venue (see H.service.venues.Venue) to which the given building belongs.

getMinLevel () : {number}

This method retrieves the minimum floor level in the given building.

getMaxLevel () : {number}

This method retrieves the maximum floor level of the given building

getFloor (level) : {(H.service.venues.Floor | undefined)}

This method retrieves a floor (see H.service.venues.Floor) if it is loaded. This method does not fetch the floor data.

Class Description

The class represents a building in the venue hierarchy (see H.service.venues.Venue) and holds the floors that belong to the building.

Constructor Details

H.service.venues.Building(provider, uid, minLevel, maxLevel)

Parameters:
 
provider:
{H.map.provider.ObjectProvider}
 
The object provider of the given venue building
uid:
{string}
 
A unique identifier of the building
minLevel:
{number}
 
The minimum floor level in the building
maxLevel:
{number}
 
The maximum floor level in the building

Method Details

getVenue () : {H.service.venues.Venue}

This method retrieves the parent object - venue (see H.service.venues.Venue) to which the given building belongs.

Returns:
 
{H.service.venues.Venue}
An object representing the parent object (a venue)

getMinLevel () : {number}

This method retrieves the minimum floor level in the given building.

Returns:
 
{number}
A value indicating he lowest floor level in the building

getMaxLevel () : {number}

This method retrieves the maximum floor level of the given building

Returns:
 
{number}
A value indicating he highest floor level in the building

getFloor (level) : {(H.service.venues.Floor | undefined)}

This method retrieves a floor (see H.service.venues.Floor) if it is loaded. This method does not fetch the floor data.

Parameters:
 
level:
{number}
 
The floor level within the range defined by the minimum and maximum floor levels for the given building
Returns:
 
{(H.service.venues.Floor | undefined)}
The floor object or undefined if floor has not yet been loaded