ScriptDoc Reference

Properties

static Object Mapifies.AddScreenOverlay.defaults.defaults

Default options for AddScreenOverlay

Functions

Mapifies.AddScreenOverlay(jQuery element, Object options, Function callback) : static Function

This function allows you to add a screen overlay to a map.

jQuery element The element to initialise the map on.
Object options The object that contains the options.
Function callback The callback function to pass out after initialising the map.

Mapifies.AddScreenOverlay.defaults(String imageUrl, Object screenXY, Object overlayXY, Object size) : static Object

Default options for AddScreenOverlay

String imageUrl The URL of the image to load.
Object screenXY The X/Y position in the viewport to place the image.
Object overlayXY The overlay X/Y position in the viewport.
Object size The size of the image, which is converted to a GSize.

Mapifies.RemoveScreenOverlay(jQuery element, GScreenOverlay overlay, Function callback) : static Function

This function allows you to remove a screen overlay from the map

jQuery element The element to initialise the map on.
GScreenOverlay overlay The overlay to be removed
Function callback The callback function to pass out after initialising the map.

jQuery	element	The element to initialise the map on.
Object	options	The object that contains the options.
Function	callback	The callback function to pass out after initialising the map.

String	imageUrl	The URL of the image to load.
Object	screenXY	The X/Y position in the viewport to place the image.
Object	overlayXY	The overlay X/Y position in the viewport.
Object	size	The size of the image, which is converted to a GSize.