MapAPI 1.4

Class: IWSVGToolbarControl

IWSVGToolbarControl

A simple toolbar based on SVG icons.

Available properties are:

  • size: size of the symbols (in px; default is 40)
  • highlightSize: size of the symbols when highlighted (in px; default is 50)
  • vertical: true to create a vertical toolbar, false for a horizontal one (default is false)

This class is part of the module controls.

new IWSVGToolbarControl(map, properties)

Creates a new toolbar.
Parameters:
Name Type Description
map IWMap the map
properties object the properties as defined above

Extends

Methods

addItem(item)

Adds an item to the toolbar. An item is defined by a name, an URL to an icon SVG, and a tooltip text: Example:
const toolbar = new IWSVGToolbarControl();
toolbar.addItem({
    name: 'roadmap',
    icon: 'https://example.org/roadmap.svg',
    tooltip: 'Show roadmap'
});
Parameters:
Name Type Description
item object the item to add
Returns:
Type
void

addSeparator()

Add a separator to the toolbar.
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:
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

destroyMapElement()

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

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

getItem(name)

Returns the item with the given name.
Parameters:
Name Type Description
name string the name of the item
Returns:
Type
void

getName()

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

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

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

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

removeItem(name)

Removes an item from the toolbar.
Parameters:
Name Type Description
name string the name of the item to remove
Returns:
Type
void

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

setId(id)

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

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

setState(name, state)

Sets the state of the item with the given name. State can be IWSVGToolbarControl.STATE_NORMAL, IWSVGToolbarControl.STATE_SELECTED or IWSVGToolbarControl.STATE_INACTIVE.
Parameters:
Name Type Description
name string the name of the item
state string the new state of the icon
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