MapAPI 1.3

Class: IWSlideInMenuControl

IWSlideInMenuControl

This control adds a menu bar to the left side of the map. It contains an empty panel which can be used to show controls like IWRoutingControl. The menu can be collapsed or expanded using an arrow button.

This class is part of the module controls.

new IWSlideInMenuControl(map, size)

Creates a new menu.
Parameters:
Name Type Description
map IWMap the map
size IWSize size of the panel in pixels (the menu itself is slightly wider)

Extends

Methods

adjustBackground(size)

Adjusts the size of the background if the size of the panel has changed.
Parameters:
Name Type Description
size IWSize in pixel
Returns:
Type
void

afterAppend()

Callback method. This method will be called after the element has been added to the DOM. Overwrite this method to react on this event.
Inherited From:
Overrides:
Returns:
Type
void

afterRemove()

Callback method. This method will be called after the element has been removed from the DOM. Overwrite this method to react on this event.
Inherited From:
Returns:
Type
void

beforeAppend()

Callback method. This method will be called before the element has been added to the DOM. Overwrite this method to react on this event.
Inherited From:
Returns:
Type
void

beforeRemove()

Callback method. This method will be called before the element has been removed from the DOM. Overwrite this method to react on this event.
Inherited From:
Returns:
Type
void

close()

Sets the menu to closed (without movement)
Returns:
Type
void

collapse()

Closes the menu smoothly.
Returns:
Type
void

destroyMapElement()

Releases all event listeners from the container.
Inherited From:
Returns:
Type
void

expand()

Opens the menu smoothly.
Returns:
Type
void

getBackgroundColor()

Returns the background color.
Deprecated:
  • use CSS instead to set the background
Returns:
color
Type
string

getContainer()

Returns the DIV container for this map element.
Inherited From:
Returns:
the container
Type
HTMLDivElement

getFirstOrientation()

Returns the first orientation of this control.
Inherited From:
Returns:
Type
IWAlignment

getId()

Returns the id for this element.
Inherited From:
Returns:
Type
String

getLayoutManager()

Returns the LayoutManager for this menu.
Returns:
the layout manager
Type
IWLayoutManager

getName()

Returns the name of this control.
Inherited From:
Returns:
Type
String

getOpacity()

Returns the opacity.
Deprecated:
  • use CSS instead to set the opacity
Returns:
an alpha value between 0 and 1
Type
float

getPadding()

Returns the padding for this control.
Inherited From:
Returns:
the padding for this control
Type
IWSize

getParent()

Returns the parent container for this element.
Inherited From:
Returns:
parent
Type
HTMLDivElement

getSecondOrientation()

Returns the second orientation of the control.
Inherited From:
Returns:
Type
IWAlignment

getSize()

Returns the size of the panel of the menu.

isControl()

Function for IWLayoutManager to check if this interface is implemented.
Inherited From:
Returns:
true
Type
boolean

isDisplayed()

Checks if the element has been added to the DOM tree.
Inherited From:
Returns:
Type
boolean

isOpen()

Returns true when the menu is open and false when it is closed.

isPrintable()

Returns true if the element is printable otherwise false.
Inherited From:
Returns:
Type
boolean

isRedrawable()

Returns whether the control will be redrawn by the layout manager or not.
Inherited From:
Returns:
redrawable
Type
Boolean

isVisible()

Returns true if the container is visible, otherwise false.
Inherited From:
Returns:
true if this container is visible
Type
boolean

onClick(event)

Callback method for onclick events.
Parameters:
Name Type Description
event Event
Inherited From:
Returns:
Type
void

onContextMenu(event)

Callback method for oncontextmenu events.
Parameters:
Name Type Description
event Event
Inherited From:
Returns:
Type
void

onDblClick(event)

Callback method for ondblclick events.
Parameters:
Name Type Description
event Event
Inherited From:
Returns:
Type
void

onMouseDown(event)

Callback method for onmousedown events.
Parameters:
Name Type Description
event Event
Inherited From:
Returns:
Type
void

onMouseMove(event)

Callback method for onmousemove events.
Parameters:
Name Type Description
event Event
Inherited From:
Returns:
Type
void

onMouseOut(event)

Callback method for onmouseout events.
Parameters:
Name Type Description
event Event
Inherited From:
Returns:
Type
void

onMouseOver(event)

Callback method for onmouseover events.
Parameters:
Name Type Description
event Event
Inherited From:
Returns:
Type
void

onMouseUp(event)

Callback method for onmouseup events.
Parameters:
Name Type Description
event Event
Inherited From:
Returns:
Type
void

onMouseWheel(event)

Callback method for onmousewheel events.
Parameters:
Name Type Description
event Event
Inherited From:
Returns:
Type
void

open()

Sets the menu to opened (without movement).
Returns:
Type
void

setBackgroundColor(color)

Sets the background color of the panel
Parameters:
Name Type Description
color String a CSS color string like #ffffff or white
Deprecated:
  • use CSS instead to set the background

setContainer(newContainer)

Sets the DIV container for this map element.
Parameters:
Name Type Description
newContainer HTMLDivElement
Inherited From:
Returns:
Type
void

setContainerClassname(classname)

Sets the classname of the container. Only use this method to modify the containers classname because it preserves the classname set by setPrintable(false).
Parameters:
Name Type Description
classname
Inherited From:

setFirstOrientation(alignment)

Sets the first orientation of the control. Possible values are IWAlignment.CENTER, IWAlignment.TOP, IWAlignment.RIGHT, IWAlignment.BOTTOM and IWAlignment.LEFT.
Parameters:
Name Type Description
alignment IWAlignment the first orientation
Inherited From:
Returns:
Type
void

setHorizontalScroll()

Sets the horizontal scroll attribute of the content panel. See IWPanelControl.setHorizontalScroll().
Returns:
Type
void

setId(id)

Sets the id for this element.
Parameters:
Name Type Description
id String
Inherited From:
Returns:
Type
void

setOpacity(alpha)

Sets the opacity.
Parameters:
Name Type Description
alpha float an alpha value between 0 and 1
Deprecated:
  • use CSS instead to set the opacity

setPadding(newPadding)

Sets the padding for this control. A padding defines the space between the current control element and others.
Parameters:
Name Type Description
newPadding IWSize the padding for this control
Inherited From:
Returns:
Type
void

setParent()

Sets the parent container for this element.
Inherited From:
Returns:
newParent
Type
HTMLDivElement

setPrintable(printable)

Enables or disables the element for printing.
Parameters:
Name Type Description
printable boolean
Inherited From:
Returns:
Type
void

setRedrawable(isRedrawable)

Defines if the control will be redrawn by the layout manager.
Parameters:
Name Type Description
isRedrawable boolean
Inherited From:
Returns:
Type
void

setSecondOrientation(alignment)

Sets the second orientation of the control. Possible values are IWAlignment.CENTER, IWAlignment.TOP, IWAlignment.RIGHT, IWAlignment.BOTTOM and IWAlignment.LEFT.
Parameters:
Name Type Description
alignment IWAlignment the secondary orientation
Inherited From:
Returns:
Type
void

setSize(size)

Sets the size of the menu.
Parameters:
Name Type Description
size IWSize in pixel

setVerticalScroll()

Sets the vertical scroll attribute of the content panel. See IWPanelControl.setVerticalScroll().
Returns:
Type
void

setVisible(visible)

Sets the visibility of this control to visible or hidden.
Parameters:
Name Type Description
visible boolean
Inherited From:
Returns:
Type
void

toString()

Returns a string representation of this control.
Inherited From:
Returns:
Type
String