Maps API for JavaScript Developer's Guide

H.map.render.panorama.RenderEngine

Class Summary

Extends: H.map.render.RenderEngine

This class represents a panorama render engine responsible for presenting the geographic position provided by the view model as a 'street view'. In addition, it provides extra functionality specific to 'street view'.

[ For full details, see the Class Details ]

Method Summary

Table 1. Methods
Methods

static getClosestPanoramas (coord, callback)

This method searches for the closest panoramas for coordinates supplied by the caller. You can call this method method multiple times without waiting for the callback, but note that the intermediate calls are implicitly cancelled and the callback gets 'undefined' as a parameter.

static getImageUrl (pano) : {string}

This method retrieves the URL of the panorama preview based on the panorama object provided by he caller.

static configure (appId, appCode, useHTTPS)

This method implements the interface H.platform.IConfigurable. It must be called before the render engine can be set on the map or any method invoked.

getPanoramaId () : {string}

This method retrieves the ID of the currently displayed panorama.

Class Description

This class represents a panorama render engine responsible for presenting the geographic position provided by the view model as a 'street view'. In addition, it provides extra functionality specific to 'street view'.

Constructor Details

H.map.render.panorama.RenderEngine(viewPort, viewModel, dataModel, opt_options)

Parameters:
 
viewPort:
{H.map.ViewPort}
 
An object representing the map viewport
viewModel:
{H.map.ViewModel}
 
An object representing a view of the map
dataModel:
{H.map.DataModel}
 
An object encapsulating the data to be rendered on the map (layers and objects)
opt_options:
{H.map.render.RenderEngine.Options=} [optional]
 
An object containing the render engine initialization options

Method Details

static getClosestPanoramas (coord, callback)

This method searches for the closest panoramas for coordinates supplied by the caller. You can call this method method multiple times without waiting for the callback, but note that the intermediate calls are implicitly cancelled and the callback gets 'undefined' as a parameter.

Parameters:
 
coord:
{H.geo.IPoint}
 
An object representing the location for which to find the closest panoramas
callback:
{!function(Array<H.map.render.panorama.RenderEngine.Panorama>)}
 
A function to be called with the results of the search.

static getImageUrl (pano) : {string}

This method retrieves the URL of the panorama preview based on the panorama object provided by he caller.

Parameters:
 
pano:
{!H.map.render.panorama.RenderEngine.Panorama}
 
An object representing the panorama
Returns:
 
{string}
A string containing the URL of the panorama

static configure (appId, appCode, useHTTPS)

This method implements the interface H.platform.IConfigurable. It must be called before the render engine can be set on the map or any method invoked.

Parameters:
 
appId:
{string}
 
The app_id for your application
appCode:
{string}
 
The app_code for your application
useHTTPS:
{boolean}
 
A value indicating whether to use HTTPS (true) or HTTP (false)

getPanoramaId () : {string}

This method retrieves the ID of the currently displayed panorama.

Returns:
 
{string}
The panorama ID or an empty string if a panorama is not loaded