Maps API for JavaScript Developer's Guide

H.service.venues.Floor

Class Summary

Extends: H.map.Group

The class represents the floor object in the venue hierarchy (see H.service.venues.Venue). The class holds information about the floor geometry and spaces (see H.service.venues.Space) that belong to the floor.

[ For full details, see the Class Details ]

Method Summary

Table 1. Methods
Methods

getLevel () : {number}

This method retrieves a value indicating the floor level in the building.

getFloorSpace () : {(H.service.venues.Space | undefined)}

This method retrieves the map geometry that represents the boundaries for the given floor.

getSpaces () : {H.map.Group}

This method retrieves the H.map.Group of all spaces that belong to the floor.

getBuilding () : {H.service.venues.Building}

This method retrieves the parent object - building (see H.service.venues.Building) - for the given floor.

getData () : {*}

This method retrieves raw data associated with the given floor. For more details on data formats, see http://developer.here.com/rest-apis/documentation/venue-maps/topics/resource-type-venue-interaction-tile-floor.html

getSpace (id) : {(H.service.venues.Space | undefined)}

This method retrieves the space object that belongs to the given floor, using the ID provided by the caller.

Class Description

The class represents the floor object in the venue hierarchy (see H.service.venues.Venue). The class holds information about the floor geometry and spaces (see H.service.venues.Space) that belong to the floor.

Constructor Details

H.service.venues.Floor(provider, data, level)

Parameters:
 
provider:
{H.map.provider.ObjectProvider}
 
The object provider of the given venue floor
data:
{*}
 
An object containing the meta data of the given floor
level:
{number}
 
A value indicating the floor level

Method Details

getLevel () : {number}

This method retrieves a value indicating the floor level in the building.

Returns:
 
{number}
A value indicating the floor level

getFloorSpace () : {(H.service.venues.Space | undefined)}

This method retrieves the map geometry that represents the boundaries for the given floor.

Returns:
 
{(H.service.venues.Space | undefined)}
An object containing floor boundary information or undefined

getSpaces () : {H.map.Group}

This method retrieves the H.map.Group of all spaces that belong to the floor.

Returns:
 
{H.map.Group}
An object representing a group with all the spaces in the given floor

getBuilding () : {H.service.venues.Building}

This method retrieves the parent object - building (see H.service.venues.Building) - for the given floor.

Returns:
 
{H.service.venues.Building}
An object representing the parent object for the given floor

getData () : {*}

This method retrieves raw data associated with the given floor. For more details on data formats, see http://developer.here.com/rest-apis/documentation/venue-maps/topics/resource-type-venue-interaction-tile-floor.html

Returns:
 
{*}
An object containing the raw floor data for the floor

getSpace (id) : {(H.service.venues.Space | undefined)}

This method retrieves the space object that belongs to the given floor, using the ID provided by the caller.

Parameters:
 
id:
{string}
 
The ID of the space
Returns:
 
{(H.service.venues.Space | undefined)}
The requested space object or code undefined} if a space matching the ID is not found.

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.