class sap.ui.vk.MapContainer

Control sample: sap.ui.vk.MapContainer
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/vk/MapContainer
Application Component: CA-UI5-VTK

Abstract Constructor for a new Container.


Constructor

Constructor for a new MapContainer.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.

new sap.ui.vk.MapContainer(sId?, mSettings?)
Param Type Default Value Description
sId? string

id for the new control, generated automatically if no id is given

mSettings? object

initial settings for the new control


Properties

Name Type Default Value Description
showHome boolean true

Controls the visibility of the home button

Visibility: public
showMapLayer boolean true

Controls the visibility of the Map Layer Select

Visibility: public
showNavbar boolean true

Show navbar

Visibility: public
showRectangularZoom boolean true

Controls the visibility of the rectangular zoom button

Visibility: public
showZoom boolean true

Controls the visibility of the zoom buttons

Visibility: public

Borrowed Properties

Name Type Default Value Description
autoAdjustHeight boolean false Visibility: public
fullScreen boolean false

Controls whether the control is show fullscreen or embedded

Visibility: public
showFullScreen boolean true

Show fullscreen toggle button in toolbar

Visibility: public
showSelection boolean true

Show selection button in toolbar

Visibility: public
showSettings boolean true

Show settings button in toolbar

Visibility: public
title string empty string

Title to show in toolbar

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
listPanelStack 0..1 sap.ui.vk.ListPanelStack

List Panel aggregation

scrollCont 0..1 sap.m.ScrollContainer

hidden scroll container aggregation needed for binding

Borrowed Aggregations

Name Cardinality Type Description
content 0..n sap.ui.vk.ContainerContent

Content Aggregation.


Methods Overview

Method Description
destroyListPanelStack

Destroys the listPanelStack in the aggregation listPanelStack.

sap.ui.vk.MapContainer.extend

Creates a new subclass of class sap.ui.vk.MapContainer with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.vk.ContainerBase.extend.

getListPanelStack

Gets content of aggregation listPanelStack.

List Panel aggregation

sap.ui.vk.MapContainer.getMetadata

Returns a metadata object for class sap.ui.vk.MapContainer.

getShowHome

Gets current value of property showHome.

Controls the visibility of the home button

Default value is true.

getShowMapLayer

Gets current value of property showMapLayer.

Controls the visibility of the Map Layer Select

Default value is true.

getShowNavbar

Gets current value of property showNavbar.

Show navbar

Default value is true.

getShowRectangularZoom

Gets current value of property showRectangularZoom.

Controls the visibility of the rectangular zoom button

Default value is true.

getShowZoom

Gets current value of property showZoom.

Controls the visibility of the zoom buttons

Default value is true.

setListPanelStack

Sets the aggregated listPanelStack.

setShowHome

Sets a new value for property showHome.

Controls the visibility of the home button

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

setShowMapLayer

Sets a new value for property showMapLayer.

Controls the visibility of the Map Layer Select

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

setShowNavbar

Sets a new value for property showNavbar.

Show navbar

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

setShowRectangularZoom

Sets a new value for property showRectangularZoom.

Controls the visibility of the rectangular zoom button

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

setShowZoom

Sets a new value for property showZoom.

Controls the visibility of the zoom buttons

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

setToolbarItem

Set custom item on the MapContainer toolbar. All custom items added between selection segment button and setting button.

destroyListPanelStack

Destroys the listPanelStack in the aggregation listPanelStack.

sap.ui.vk.MapContainer.extend

Creates a new subclass of class sap.ui.vk.MapContainer with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.vk.ContainerBase.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

getListPanelStack

Gets content of aggregation listPanelStack.

List Panel aggregation

sap.ui.vk.MapContainer.getMetadata

Returns a metadata object for class sap.ui.vk.MapContainer.

getShowHome

Gets current value of property showHome.

Controls the visibility of the home button

Default value is true.

getShowMapLayer

Gets current value of property showMapLayer.

Controls the visibility of the Map Layer Select

Default value is true.

getShowNavbar

Gets current value of property showNavbar.

Show navbar

Default value is true.

getShowRectangularZoom

Gets current value of property showRectangularZoom.

Controls the visibility of the rectangular zoom button

Default value is true.

getShowZoom

Gets current value of property showZoom.

Controls the visibility of the zoom buttons

Default value is true.

setListPanelStack

Sets the aggregated listPanelStack.

Param Type DefaultValue Description
oListPanelStack sap.ui.vk.ListPanelStack

The listPanelStack to set

setShowHome

Sets a new value for property showHome.

Controls the visibility of the home button

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Param Type DefaultValue Description
bShowHome boolean true

New value for property showHome

setShowMapLayer

Sets a new value for property showMapLayer.

Controls the visibility of the Map Layer Select

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Param Type DefaultValue Description
bShowMapLayer boolean true

New value for property showMapLayer

setShowNavbar

Sets a new value for property showNavbar.

Show navbar

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Param Type DefaultValue Description
bShowNavbar boolean true

New value for property showNavbar

setShowRectangularZoom

Sets a new value for property showRectangularZoom.

Controls the visibility of the rectangular zoom button

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Param Type DefaultValue Description
bShowRectangularZoom boolean true

New value for property showRectangularZoom

setShowZoom

Sets a new value for property showZoom.

Controls the visibility of the zoom buttons

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Param Type DefaultValue Description
bShowZoom boolean true

New value for property showZoom

setToolbarItem

Set custom item on the MapContainer toolbar. All custom items added between selection segment button and setting button.

Param Type DefaultValue Description
item object

Item configuration object.

id string

Id of the item for future references.

index int

Relative index of an item across all custom items.

visible boolean

Visibility of an item.

active boolean

Active item or not.

text string

Text of an item.

tooltip string

Tooltip of an item.

overflow boolean

If true create Overflow button or standard if false.

icon sap.ui.core.URI

Icon of an item.

activeIcon sap.ui.core.URI

Alternative icon of an item, see sap.m.Button for details.

type string

The sap.ui.vk.MapContainerButtonType enum.

press function

Callback function which is called when item gets pressed.

toggled boolean

sets the initial pressed state for a sap.ui.vk.MapContainerButtonType Toggle button. This does not fire the pressed event handler. It should be used if pressed logic is activated by application code on first load.