Class adf.Overview

Extends adf.Control.

Defined in: Overview.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	adf.Overview(id, mapId, wd, ht, ht) Control used to show overview of the map layers inside a toggle window

Field Summary
Field Attributes	Field Name and Description
	bounds The bounds of the overview Control's container node
	box The overview box
	boxFillColor The fill color of overview box
	boxFillOpacity The fill opacity of overview box
	boxLineColor The line color of overview box
	boxLineOpacity The line opacity of overview box
	boxLineWidth The line-width of overview box
	boxZIndex The z-index of overview box
	clientPostBack The parameter dtermines whether the overview control's actions are AJAX enabled or not.
	divId The div id of the overview control
	enableLoading The boolean parameter to enable loading image icon for overview control when the control is loading
	height The Height of the Overview Control window
	imageId The image id of adf.Overview#mage
	imageObject The image displayed by the overview control
	imageUrl The url of adf.Overview#mage
	isContinuousPan The parameter detrmines whether the continuous pan is enabled or disabled on the overview control
	mapId The map id of the map control for which this overview control is shown
	noDataLabel When there is no map source data available, this string is displayed by the overview control
	showNoData This parameter determines whether over should sho map data image or nodata label
	width The Width of the Overview Control window

Fields borrowed from class adf.Control:: divObject, id, type, updateListenerNames, updateListeners

Method Summary
Method Attributes	Method Name and Description
	init(container) This methos initilizes the properties and the enables the events for the overview control and add the control to the container node provided in the argument
	setOverviewImage(url) sets the overview image
	update(left, top, width, height) Upadted the overview's box dimensions
	updateAsync(xml, eventSources) The postback handler of the overview control gets called when the controls on the client side are updated

Methods borrowed from class adf.Control:: addUpdateListener, removeUpdateListener
Methods borrowed from class adf.PageElement:: hide, resize, show

Class Detail

adf.Overview(id, mapId, wd, ht, ht)

Control used to show overview of the map layers inside a toggle window

Parameters:
{String} id: {String} the id of the overview control
{DOM Node} mapId: {DOM Node} the map Control whose map layers are displayed by this control
{String} wd: {Number} Width of the Control
{Number} ht: {Number} Height of the Control
{Number} ht

Field Detail

{Number} bounds

The bounds of the overview Control's container node

Default Value:: 150 px

{Number} box

The overview box

{String} boxFillColor

The fill color of overview box

Default Value:: "#000"

{Number} boxFillOpacity

The fill opacity of overview box

Default Value:: 0.25

{String} boxLineColor

The line color of overview box

Default Value:: "#f00"

{Number} boxLineOpacity

The line opacity of overview box

Default Value:: 1

{Number} boxLineWidth

The line-width of overview box

Default Value:: 2

{Number} boxZIndex

The z-index of overview box

Default Value:: 9

{Boolean} clientPostBack

The parameter dtermines whether the overview control's actions are AJAX enabled or not.

Default Value:: false

{Number} divId

The div id of the overview control

{Boolean} enableLoading

The boolean parameter to enable loading image icon for overview control when the control is loading

Default Value:: false

{Number} height

The Height of the Overview Control window

Default Value:: 150 px

{Number} imageId

The image id of adf.Overview#mage

{Number} imageObject

The image displayed by the overview control

{Number} imageUrl

The url of adf.Overview#mage

{Boolean} isContinuousPan

The parameter detrmines whether the continuous pan is enabled or disabled on the overview control

Default Value:: false

{Number} mapId

The map id of the map control for which this overview control is shown

{Number} noDataLabel

When there is no map source data available, this string is displayed by the overview control

Default Value:: "No Data"

{Boolean} showNoData

This parameter determines whether over should sho map data image or nodata label

Default Value:: false

{Number} width

The Width of the Overview Control window

Default Value:: 150 px

Method Detail

init(container)

This methos initilizes the properties and the enables the events for the overview control and add the control to the container node provided in the argument

Parameters:
{Node} container: {Node} Container node of the overview control

setOverviewImage(url)

sets the overview image

Parameters:
{String} url: {Number} image url

update(left, top, width, height)

Upadted the overview's box dimensions

Parameters:
{Number} left: {Number} left coordinate of the box
{Number} top: {Number} top coordinate of the box
{Number} width: {Number} width of the box
{Number} height: {Number} height of the bix

updateAsync(xml, eventSources)

The postback handler of the overview control gets called when the controls on the client side are updated

Parameters:
xml
eventSources

Classes

Class adf.Overview