OpenSpace.Layer.ScreenOverlay

Instances of OpenSpace.Layer.ScreenOverlay are used to display HTML data that does not scroll and zooms with the map, but remains fixed to the map window. The overlay has a given position and size in screen units.

Summary

OpenSpace.Layer.ScreenOverlay	Instances of OpenSpace.Layer.ScreenOverlay are used to display HTML data that does not scroll and zooms with the map, but remains fixed to the map window.
Properties
position	{OpenSpace.ScreenPoint} Position of the overlay on the screen.
size	{OpenSpace.ScreenSize} Size of the overlay on the screen.
html	{<String>} Contents of the overlay to display on the screen.
isFixed	{Boolean} Whether the layer remains in one place while dragging the map.
zIndex	{Number} The zIndex determines the rendering order for a this ScreenOvarlay Layer.
Constructor
OpenSpace.Layer.ScreenOverlay
Functions
setHTML	Set new HTML contents for this overlay.
setPosition	Set a new position for this overlay.
setZIndex
setSize	Set a new size for this overlay.
moveTo	Move the overlay when the base map moves.

Properties

position

{OpenSpace.ScreenPoint} Position of the overlay on the screen.

size

{OpenSpace.ScreenSize} Size of the overlay on the screen.

html

{<String>} Contents of the overlay to display on the screen. Can contain HTML tags.

isFixed

{Boolean} Whether the layer remains in one place while dragging the map.

zIndex

{Number} The zIndex determines the rendering order for a this ScreenOvarlay Layer.

Constructor

OpenSpace.Layer.ScreenOverlay

Parameters

name	{String} name of the overlay.
options	{Object} options are position and html.

Functions

setHTML

setHTML: function( html )

Set new HTML contents for this overlay.

Parameters

html

{String}

setPosition

setPosition: function( px )

Set a new position for this overlay.

Parameters

px	{OpenSpace.Control.ControlPosition} Position of the overlay on the map window.

setZIndex

setZIndex: function ( zIndex )

Parameters

zIndex

{Integer}

setSize

setSize: function( size )

Set a new size for this overlay.

Parameters

px	{OpenSpace.ScreenSize} Size of the overlay.

moveTo

moveTo:function( bounds,
zoomChanged,
dragging )

Move the overlay when the base map moves.

Parameters

bound	{<OpenLayers.Bounds>}
zoomChanged	{Boolean} Tells when zoom has changed, as layers have to do some init work in that case.
dragging	{Boolean}