MapAPI 1.3

Class: IWOverlayLayer

IWOverlayLayer

An layer to show overlays like POIs or search hits on a map.

new IWOverlayLayer(map, parent, layer)

Constructor.
Parameters:
Name Type Description
map IWMap
parent HTMLDivElement the divOverlay element
layer number the zIndex of this layer

Methods

addOverlay(overlay)

Adds a new overlay to this layer.
Parameters:
Name Type Description
overlay IWOverlay
Returns:
Type
void

getLayerIndex()

Returns the index of this layer.
Returns:
Type
number

getOverlayById(id)

Returns the overlay for the given id. If the overlay does not exist null is returned.

The id can by set by the IWOverlay.setId() method.

Parameters:
Name Type Description
id String an id
Returns:
Type
IWOverlay

getOverlays()

Returns the overlays of this layer.
Returns:
Type
Array.<IWOverlay>

getVisibilityRange()

Returns the visibility range of this layer.
Returns:
Type
IWRange

isVisible()

Returns true if this layer is visible.
Returns:
Type
boolean

redraw()

Redraws the overlay layer.
Returns:
Type
void

removeAllOverlays()

Removes all overlays from the layer.
Returns:
Type
void

removeOverlay(overlay)

Removes the specified overlay from the layer.
Parameters:
Name Type Description
overlay IWOverlay
Returns:
Type
void

setVisibilityRange(range)

Sets the visibility range of this layer.
Parameters:
Name Type Description
range IWRange
Returns:
Type
void

setVisible(isVisible)

Sets the visibility of this layer.
Parameters:
Name Type Description
isVisible boolean
Returns:
Type
void