Maps API for JavaScript Developer's Guide

H.ui.Pano

Class Summary

Extends: H.ui.Control

This class represents the UI controls for panorama

[ For full details, see the Class Details ]

Method Summary

Table 1. Methods
Methods

onUnitSystemChange (unitSystem)

This abstract method can be overridden by deriving classes to be invoked when the UI object's unit system changes.

onMapEngineTypeChange (engineType)

This abstract method can be overridden by deriving classes to be invoked when the underlying map engine changes.

getMap () : {?H.Map}

This method returns the map to which this control is attached.

getLocalization () : {H.ui.i18n.Localization}

This method returns the localization object which corresponds to the UI's current locale.

getAlignment () : {H.ui.LayoutAlignment}

This method returns this control's layout alignment.

setAlignment (alignment) : {H.ui.Control}

This method sets the control's layout alignments.

addChild (child) : {H.ui.base.Container}

Adds a child element to be rendered within the container element.

getChildren () : {Array<H.ui.base.Element>}

Returns the child collection of this container.

removeChild (child)

Removes a child element from this container's child collection.

addEventListener (type, handler, opt_capture, opt_scope)

This method allows to listen for specific event triggered by the object

removeEventListener (type, handler, opt_capture, opt_scope)

This method will removed previously added listener from the event target

renderInternal (element, doc)

This method is the concrete implementation of the UI element. This method receives the pre-rendered HTML element which may be modified by deriving classes.

isDisabled () : {boolean}

This method returns this UI element's disabled state as a boolean value.

setDisabled (disabled, opt_force) : {H.ui.base.Element}

This method set's the disabled state of this UI element.

getData () : {*}

This method returns a previously stored arbitrary data from this element.

setData (data)

This method stores arbitrary data with this UI element.

getElement () : {?HTMLElement}

This method returns the HTML element this UI element renders.

setVisibility (visibility)

Sets the visibility of this element.

getVisibility () : {boolean}

Returns the visibility of this element.

addClass (className) : {H.ui.base.Element}

This method adds a CSS class to this UI element (if it is not already present).

removeClass (className) : {H.ui.base.Element}

This method removes a CSS class from this UI element (if it is present).

Events Summary

Table 2. Events
Events

alignmentchange : {H.util.Event}

This event is fired when control is realigned

Class Description

This class represents the UI controls for panorama

Constructor Details

H.ui.Pano(opt_options)

Parameters:
 
opt_options:
{H.ui.Pano.Options=} [optional]
 
optional parameters to be passed to the map.

Method Details

onUnitSystemChange (unitSystem)

This abstract method can be overridden by deriving classes to be invoked when the UI object's unit system changes.

Parameters:
 
unitSystem:
{H.ui.UnitSystem}
 
the unit system the UI currently uses

onMapEngineTypeChange (engineType)

This abstract method can be overridden by deriving classes to be invoked when the underlying map engine changes.

Parameters:
 
engineType:
{H.Map.EngineType}
 
the engine type the map currently uses

getMap () : {?H.Map}

This method returns the map to which this control is attached.

Note: Before adding a control to a UI object this method returns null.

Returns:
 
{?H.Map}
return the map

getLocalization () : {H.ui.i18n.Localization}

This method returns the localization object which corresponds to the UI's current locale.

Returns:
 
{H.ui.i18n.Localization}

getAlignment () : {H.ui.LayoutAlignment}

This method returns this control's layout alignment.

Returns:
 
{H.ui.LayoutAlignment}
the control's current layout alignment

setAlignment (alignment) : {H.ui.Control}

This method sets the control's layout alignments.

The possible alignments are as follows within the map view port:


+--------------------------------------------------------------------------------+
|  "top-left"  > >       < <  "top-center"  > >      < <  "top-right"  |
|  "lef-ttop"                             "right-top"  |
|  v                                      v  |
|  v                                      v  |
|                                        |
|                                        |
|  ^                                      ^  |
|  ^                                      ^  |
|  "left-middle"                         "right-middle"  |
|  v                                      v  |
|  v                                      v  |
|                                        |
|                                        |
|  ^                                      ^  |
|  ^                                      ^  |
|  "left-bottom"                         "right-bottom"  |
|  "bottom-left"  > >     < <  "bottom-center"  > >     < <  "bottom-right"  |
+--------------------------------------------------------------------------------+

Elements with the same layout alignments are lined up in the directions of the arrows (see the illustration above).

Parameters:
 
alignment:
{H.ui.LayoutAlignment}
 
The new alignment of the control
Returns:
 
{H.ui.Control}
returns this control instance

addChild (child) : {H.ui.base.Container}

Adds a child element to be rendered within the container element.

Parameters:
 
child:
{H.ui.base.Element}
 
the child element to be added
Returns:
 
{H.ui.base.Container}
this container instance

getChildren () : {Array<H.ui.base.Element>}

Returns the child collection of this container.

Returns:
 
{Array<H.ui.base.Element>}
the children of this container

removeChild (child)

Removes a child element from this container's child collection.

Parameters:
 
child:
{H.ui.base.Element}
 
the child element to be removed

addEventListener (type, handler, opt_capture, opt_scope)

This method allows to listen for specific event triggered by the object

Parameters:
 
type:
{string}
 
name of event
handler:
{!Function}
 
event handler function
opt_capture:
{boolean=} [optional]
 
if set to true will listen in the capture phase (bubble otherwise)
opt_scope:
{Object=} [optional]
 
scope for the handler function

removeEventListener (type, handler, opt_capture, opt_scope)

This method will removed previously added listener from the event target

Parameters:
 
type:
{string}
 
name of event
handler:
{!Function}
 
previously added event handler
opt_capture:
{boolean=} [optional]
 
if set to true will listen in the capture phase (bubble otherwise)
opt_scope:
{Object=} [optional]
 
scope for the handler function

renderInternal (element, doc)

This method is the concrete implementation of the UI element. This method receives the pre-rendered HTML element which may be modified by deriving classes.

Parameters:
 
element:
{Element}
 
this UI element's HTML representation
doc:
{Document}
 
the HTML document into which the element is currently being rendered

isDisabled () : {boolean}

This method returns this UI element's disabled state as a boolean value.

Returns:
 
{boolean}
true if the element is disabled, false otherwise

setDisabled (disabled, opt_force) : {H.ui.base.Element}

This method set's the disabled state of this UI element.

Parameters:
 
disabled:
{boolean}
 
true to disabled the element, false to enabled it
opt_force:
{boolean=} [optional]
 
an optional boolean flag indicating that the value should be set and propagated even if it is the same as the current state
Returns:
 
{H.ui.base.Element}
this element instance

getData () : {*}

This method returns a previously stored arbitrary data from this element.

Returns:
 
{*}
the previously stored data object or null if not data was stored.

setData (data)

This method stores arbitrary data with this UI element.

Parameters:
 
data:
{*}
 
the data to be stored

getElement () : {?HTMLElement}

This method returns the HTML element this UI element renders.

Note: Before the UI element was rendered the method returns null.

Returns:
 
{?HTMLElement}
the element

setVisibility (visibility)

Sets the visibility of this element.

Parameters:
 
visibility:
{boolean}
 

getVisibility () : {boolean}

Returns the visibility of this element.

Returns:
 
{boolean}
visibility

addClass (className) : {H.ui.base.Element}

This method adds a CSS class to this UI element (if it is not already present).

Parameters:
 
className:
{string}
 
the CSS class name to add
Returns:
 
{H.ui.base.Element}
this UI element instance

removeClass (className) : {H.ui.base.Element}

This method removes a CSS class from this UI element (if it is present).

Parameters:
 
className:
{string}
 
the CSS class name to add
Returns:
 
{H.ui.base.Element}
this UI element instance

Event Details

alignmentchange: {H.util.Event}

This event is fired when control is realigned

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.