Maps API for JavaScript Developer's Guide

H.service.venues.Venue

Class Summary

Extends: H.map.Group

The class represents a venue and is the root for the venue object hierarchy. The venue inherits from H.map.Group and holds building objects (see H.service.venues.Building). Building objects hold floor objects (see H.service.venues.Floor) and inherit from H.map.Group as well. The leaf objects are spaces (see H.service.venues.Space) that are spatial map objects and reside inside floor containers.

[ For full details, see the Class Details ]

Method Summary

Table 1. Methods
Methods

getBuilding (id) : {(H.service.venues.Building | undefined)}

This method retrieves the building object that belongs to the venue, using the ID provided by the caller. The method doesn't attempt to fetch building data.

getBuildings () : {Object<*, H.service.venues.Building>}

This method retrieves a map of all loaded buildings associated with the given venue.

Class Description

The class represents a venue and is the root for the venue object hierarchy. The venue inherits from H.map.Group and holds building objects (see H.service.venues.Building). Building objects hold floor objects (see H.service.venues.Floor) and inherit from H.map.Group as well. The leaf objects are spaces (see H.service.venues.Space) that are spatial map objects and reside inside floor containers.

Constructor Details

H.service.venues.Venue(provider, uid)

Parameters:
 
provider:
{H.map.provider.ObjectProvider}
 
The object provider of the given venue
uid:
{string}
 
The unique identifier of the venue

Method Details

getBuilding (id) : {(H.service.venues.Building | undefined)}

This method retrieves the building object that belongs to the venue, using the ID provided by the caller. The method doesn't attempt to fetch building data.

Parameters:
 
id:
{string}
 
The ID of the building
Returns:
 
{(H.service.venues.Building | undefined)}
The requested building or code undefined} if the building object has not been loaded

getBuildings () : {Object<*, H.service.venues.Building>}

This method retrieves a map of all loaded buildings associated with the given venue.

Returns:
 
{Object<*, H.service.venues.Building>}
A map object of buildings that are loaded and are associated with the given venue.