Oracle Maps HTML5 JavaScript API Reference

 
Class: NavigationPanelBar

OM.control. NavigationPanelBar

This class defines the NavigationPanelBar

Parameters:
Name Type Description
options Object

An object specifying the navigation panel. It can have the following attributes.


  • style {int}: Specifies the display mode of NavigationPanelBar, Can be one of four pre-defined options.
    1--display all, 2--slide bar and zoom buttons only, 3--zoom buttons only, 4--navigation panel only.
    Default is 3.

  • anchorPosition {int} : Location of the navigation panel. Can be one of 6 pre-defined options.
    1--upper left,2--upper center,3--upper right,4--lower left,5--lower center,6--lower right.
    Default is 1.
Returns:

An instance of OM.control.NavigationPanelBar

Type
OM.control.NavigationPanelBar

Extends

Methods

isVisible()

Get the visibility of the decoration.

Inherited From:
Returns:

True if the decoration is currently visible,
False if the decoration is currently not visible.

Type
Boolean

on()

A shorthand name for the member function addListener.

Inherited From:
Mixes In:

setDraggable()

Set whether the decoration should be draggable

Parameters:
Name Type Description
draggable. Boolean

True if draggable, false if not.
Inherited From:
Returns:
Type
void

setPosition(offsetX, offsetY)

Set the map decoration position

Parameters:
Name Type Description
offsetX Float

in pixels to the dock icon if the value is greater than 1, or percentage if it is less than 1.
offsetY Float

in pixels to the dock icon if the value is greater than 1, or percentage if it is less than 1.
Inherited From:
Overrides:
Returns:
Type
void

setSize(width, height)

Set the map decoration size

Parameters:
Name Type Description
width int
height int
Inherited From:
Returns:
Type
void

setStyle(mainStyle)

Customize the navigationPanelBar style.

Parameters:
Name Type Description
mainStyle Object

An object with four optional attributes.


  • backgroundColor {String} : The background color for the panel. Specified as #rrggbb, e.g. "#d3d3d3"

  • borderColor {String }: The color for the border in the panel. Specified as #rrggbb, e.g. "#ccd3ca"

setVisible(visible)

Set the visibility.

Parameters:
Name Type Description
visible Boolean

True if visible, false if not.
Inherited From:
Returns:
Type
void

setZoomLevelInfoTips(infoTips)

Set zoom level info tips

Parameters:
Name Type Description
infoTips Object

e.g. {zoomLevel01:"level01Name",zoomLevel02:"level02Name", ...}