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.
Constructor
OpenSpace. Layer. ScreenOverlay
Functions
setHTML	Set new HTML contents for this overlay.
setPosition	Set a new position for this overlay.
setSize	Set a new size for this overlay.

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.

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.

setSize

setSize: function( size )

Set a new size for this overlay.

Parameters

px	{OpenSpace.ScreenSize} Size of the overlay.

This class represents a screen coordinate, in x and y coordinates

Instances of this class represent a width/height pair

setHTML: function( html )

Set new HTML contents for this overlay.

setPosition: function( px )

Set a new position for this overlay.

setSize: function( size )

Set a new size for this overlay.

Allows a control to be placed relative to a corner of the map window and offset from that corner by a specified amount.