Class: IWScalarControl

Extends

• IWControl

Methods

---

afterAppend()

We use this callback method for redrawing the scalar control after it is appended to the map.

Overrides:

• IWControl#afterAppend

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:

• IWMapElement#afterRemove

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:

• IWMapElement#beforeAppend

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:

• IWMapElement#beforeRemove

Returns:

Type

void

---

destroyMapElement()

Releases all event listeners from the container.

Inherited From:

• IWMapElement#destroyMapElement

Returns:

Type

void

---

getBackgroundImage()

Returns the path to the image used by the background.

Deprecated:

• use CSS instead

Returns:

Type

String

---

getBrightImage()

Returns the path to the image used by the bright boxes.

Deprecated:

• use CSS instead

Returns:

Type

String

---

getContainer()

Returns the DIV container for this map element.

Inherited From:

• IWMapElement#getContainer

Returns:

the container

Type

HTMLDivElement

---

getDarkImage()

Returns the path to the image used by the dark boxes.

Deprecated:

• use CSS instead

Returns:

Type

String

---

getFirstOrientation()

Returns the first orientation of this control.

Inherited From:

• IWControl#getFirstOrientation

Returns:

Type

IWAlignment

---

getId()

Returns the id for this element.

Inherited From:

• IWMapElement#getId

Returns:

Type

String

---

getName()

Returns the name of this control.

Inherited From:

• IWControl#getName

Returns:

Type

String

---

getPadding()

Returns the padding for this control.

Inherited From:

• IWControl#getPadding

Returns:

the padding for this control

Type

IWSize

---

getParent()

Returns the parent container for this element.

Inherited From:

• IWMapElement#getParent

Returns:

parent

Type

HTMLDivElement

---

getSecondOrientation()

Returns the second orientation of the control.

Inherited From:

• IWControl#getSecondOrientation

Returns:

Type

IWAlignment

---

getSeparatorImage()

Returns the path to the image used by the separators.

Deprecated:

• use CSS instead

Returns:

Type

String

---

isControl()

Function for IWLayoutManager to check if this interface is implemented.

Inherited From:

• IWControl#isControl

Returns:

true

Type

boolean

---

isDisplayed()

Checks if the element has been added to the DOM tree.

Inherited From:

• IWMapElement#isDisplayed

Returns:

Type

boolean

---

isPrintable()

Returns true if the element is printable otherwise false.

Inherited From:

• IWMapElement#isPrintable

Returns:

Type

boolean

---

isRedrawable()

Returns whether the control will be redrawn by the layout manager or not.

Inherited From:

• IWControl#isRedrawable

Returns:

redrawable

Type

Boolean

---

isVisible()

Returns true if the container is visible, otherwise false.

Inherited From:

• IWMapElement#isVisible

Returns:

true if this container is visible

Type

boolean

---

onClick(event)

Callback method for onclick events.

Parameters:

Name	Type	Description
event	Event

Inherited From:

• IWMapElement#onClick

Returns:

Type

void

---

onContextMenu(event)

Callback method for oncontextmenu events.

Parameters:

Name	Type	Description
event	Event

Inherited From:

• IWMapElement#onContextMenu

Returns:

Type

void

---

onDblClick(event)

Callback method for ondblclick events.

Parameters:

Name	Type	Description
event	Event

Inherited From:

• IWMapElement#onDblClick

Returns:

Type

void

---

onMouseDown(event)

Callback method for onmousedown events.

Parameters:

Name	Type	Description
event	Event

Inherited From:

• IWMapElement#onMouseDown

Returns:

Type

void

---

onMouseMove(event)

Callback method for onmousemove events.

Parameters:

Name	Type	Description
event	Event

Inherited From:

• IWMapElement#onMouseMove

Returns:

Type

void

---

onMouseOut(event)

Callback method for onmouseout events.

Parameters:

Name	Type	Description
event	Event

Inherited From:

• IWMapElement#onMouseOut

Returns:

Type

void

---

onMouseOver(event)

Callback method for onmouseover events.

Parameters:

Name	Type	Description
event	Event

Inherited From:

• IWMapElement#onMouseOver

Returns:

Type

void

---

onMouseUp(event)

Callback method for onmouseup events.

Parameters:

Name	Type	Description
event	Event

Inherited From:

• IWMapElement#onMouseUp

Returns:

Type

void

---

onMouseWheel(event)

Callback method for onmousewheel events.

Parameters:

Name	Type	Description
event	Event

Inherited From:

• IWMapElement#onMouseWheel

Returns:

Type

void

---

setBackgroundImage()

Sets the path to the image used by the background.

Deprecated:

• use CSS instead

Returns:

Type

void

---

setBrightImage()

Sets the path to the image used by the bright boxes.

Deprecated:

• use CSS instead

Returns:

Type

void

---

setContainer(newContainer)

Sets the DIV container for this map element.

Parameters:

Name	Type	Description
newContainer	HTMLDivElement

Inherited From:

• IWMapElement#setContainer

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:

• IWMapElement#setContainerClassname

---

setDarkImage()

Sets the path to the image used by the dark boxes.

Deprecated:

• use CSS instead

Returns:

Type

void

---

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:

• IWControl#setFirstOrientation

Returns:

Type

void

---

setId(id)

Sets the id for this element.

Parameters:

Name	Type	Description
id	String

Inherited From:

• IWMapElement#setId

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:

• IWControl#setPadding

Returns:

Type

void

---

setParent()

Sets the parent container for this element.

Inherited From:

• IWMapElement#setParent

Returns:

newParent

Type

HTMLDivElement

---

setPrintable(printable)

Enables or disables the element for printing.

Parameters:

Name	Type	Description
printable	boolean

Inherited From:

• IWMapElement#setPrintable

Returns:

Type

void

---

setRedrawable(isRedrawable)

Defines if the control will be redrawn by the layout manager.

Parameters:

Name	Type	Description
isRedrawable	boolean

Inherited From:

• IWControl#setRedrawable

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:

• IWControl#setSecondOrientation

Returns:

Type

void

---

setSeparatorImage()

Sets the path to the image used by the separators.

Deprecated:

• use CSS instead

Returns:

Type

void

---

setVisible(visible)

Sets the visibility of this control to visible or hidden.

Parameters:

Name	Type	Description
visible	boolean

Inherited From:

• IWMapElement#setVisible

Returns:

Type

void

---

toString()

Returns a string representation of this scalar control.

Overrides:

• IWControl#toString

Returns:

Type

String