new IWWindowOverlay(map, coordinate)
WindowOverlay interface.
Parameters:
Name | Type | Description |
---|---|---|
map |
IWMap | the map |
coordinate |
IWCoordinate | the coordinate where the window overlay appears on the map |
Extends
Methods
-
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
-
destroyWindowOverlay()
-
Destroys the window overlay. Releases all DOM references and event listeners.
Returns:
- Type
- void
-
getAnchor()
-
Returns the anchor of the window overlay.
Returns:
- Type
- IWPoint
-
getContainer()
-
Returns the DIV container for this map element.
- Inherited From:
Returns:
the container- Type
- HTMLDivElement
-
getCoordinate()
-
Returns the coordinate for this window overlay.
Returns:
- Type
- IWCoordinate
-
getId()
-
Returns the id for this element.
- Inherited From:
Returns:
- Type
- String
-
getParent()
-
Returns the parent container for this element.
- Inherited From:
Returns:
parent- Type
- HTMLDivElement
-
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
-
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
-
redraw()
-
Redraws the window overlay. Calculates and sets the new pixel position where the window overlay appears on the map.
Returns:
- Type
- void
-
setAnchor(anchor)
-
Sets the anchor of the window overlay.
Parameters:
Name Type Description anchor
IWPoint 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:
-
setCoordinate(coordinate)
-
Sets the coordinate for this window overlay.
Parameters:
Name Type Description coordinate
IWCoordinate Returns:
- Type
- void
-
setId(id)
-
Sets the id for this element.
Parameters:
Name Type Description id
String - 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
-
setVisible(visible)
-
Sets the visibility of this control to visible or hidden.
Parameters:
Name Type Description visible
boolean - Inherited From:
Returns:
- Type
- void