JavaScript Library

for the ArcGIS Server Application Developer Framework

JavaScript_Library.htm is intended to help familiarize you with the JavaScript functions that are used by the ArcGIS Server Application Developer Framework (ADF).

The objectives of this file are to:

Show which JavaScript functions are in each file.
Give a brief description of the purpose for each function.
List all the parameters for each function and explain what the parameter represents.

The JavaScript functions were designed and coded specifically for the ADF controls that use them. Any customizations to the JavaScript functions can result in errors or incorrect results when using the ADF controls.

map_functions.js

overview_functions.js

page_functions.js

toolbar_functions.js

Common Functions:
MapCreation
createLayer
createLayerWithStyle
createLayerWithEvents
getLayer
setLayerBackgroundColor
setDivZOrder
hideLayer
showLayer
moveLayer
getXY
clipLayer
panClipLayer
getWinWidth
getWinHeight
adjustMapCoords
isLeftButton
convertNSrgb
checkPrompt
calcElementPosition
postBack

Loading functions:
LoadDiv
ShowLoading
HideLoading

Zoombox functions:
ZoomBoxDiv
setClip
displayZoomBox
hideZoomBox
clipZoomBox

Vector functions:
DeleteVector
RestartVectors
CancelVectors
clearObjects
drawObjects
setObjectColor
addToObject
addToObjectColor
line
ie_line
polyline
ie_polyline
polygon
ie_polygon
oval
ie_oval
addToOval
circle
box
vectorObjects
pixelObject
coordList

Common Functions:
MakeMapDiv
clearVectorEvents

Set Tool Functions:
MapDragImage
MapDragRectangle
MapPoint
MapLine
MapPolyline
MapPolygon
MapCircle
MapDragCircle
MapOval
MapDragOval
MapBox
MapDragBox
mapSetTool

MouseDown/Click Functions:
mapDragImageStart
mapDragRectangleStart
mapPointClick
mapVectorClick
getMapDiv
mapVectorMouseDown

MouseMove Functions:
mapDragImageMove
mapDragRectangleMove
mapVectorMove

MouseUp Functions:
mapDragImageUp
mapDragRectangleUp
mapVectorEnd
mapVectorMouseUp

Common Functions:
OVCreation
MakeOVDiv

Setup Function:
SetupOVEvents

Mouse Action Functions:
ovDragStart
ovDragMove
ovDragUp
ovClick
getOVDiv

Common Functions:
PageCreation
MakePageDiv

Set Tool Functions:
PageDragImage
PageDragRectangle
PagePoint
PageMapDragImage
PageMapDragRectangle
PageMapPoint
pageSetTool

MouseDown/Click Functions:
pageDragImageStart
pageDragRectangleStart
pagePointClick
pageMapDragImageStart
pageMapDragRectangleStart
pageMapPointClick
getPageDiv
getPageMapDiv

MouseMove Functions:
pageDragImageMove
pageDragRectangleMove
pageMapDragImageMove
pageMapDragRectangleMove

MouseUp Functions:
pageDragImageUp
pageDragRectangleUp
pageMapDragImageUp
pageMapDragRectangleUp

Common Functions:
ToolbarCreation
ToolbarGroupCreation
ToolbarItemCreation

Mouse Action Functions:
ToolbarMouseDown
ToolbarMouseOver
ToolbarMouseOut
toolbarSelectTool
toolbarRefreshGroup
toolbarRefreshCommands

common.js

Common Functions

MapCreation(controlname,parentindex,index, left, top, width, height, uniquedivid,dragBoxColor,dragLineWidth)

Creates an object to hold parameters associated with the Map WebControl's DIV object.

Parameters:
controlname - Name of Map WebControl
parentIndex - Index of parent PageLayout WebControl. If none, value is zero.
index - Index of Map WebControl
left - Left edge of DIV object
top - Top edge of DIV object
width - Width of DIV object
height - Height of DIV object
uniquedivid - Id of DIV object
dragBoxColor - Color of associated ZoomBox/DragBox DIV object
dragLineWidth - Width of associated ZoomBox/DragBox DIV object lines

createLayer(name, inleft, intop, width, height, visible, content, classname)

Creates a DIV object to be used by one of the WebControls.

Parameters:
name - Name of new DIV object
inleft - Left position coordinate of DIV object
intop - Top position coordinate of DIV object
width - Width of DIV object
height - Height of DIV object
visible - Starting visibility of DIV object (true/false)
content - Contents of DIV object, usually a string of HTML
classname - Name of class to be included as an attribute of the DIV object, if any

createLayerWithStyle(name, inleft, intop, width, height, visible, content, classname, style)

Creates a DIV object to be used by one of the WebControls, with style included.

Parameters:
name - Name of new DIV object
inleft - Left position coordinate of DIV object
intop - Top position coordinate of DIV object
width - Width of DIV object
height - Height of DIV object
visible - Starting visibility of DIV object (true/false)
content - Contents of DIV tag, usually a string of HTML
classname - Name of class to be included as an attribute of the DIV object, if any
style - Name of style to be used as the style attribute of the DIV object, if any

createLayerWithEvents(name, inleft, intop, width, height, visible, content, classname, mousedownevt, mouseupevt, mousemoveevt, mouseoverevt, mouseoutevt)

Creates a DIV object to be used by one of the WebControls, with mouse events defined.

Parameters:
name - Name of new DIV object
inleft - Left position coordinate of DIV object
intop - Top position coordinate of DIV object
width - Width of DIV object
heigh - Height of DIV object
visible - Starting visibility of DIV object (true/false)
content - Contents of DIV object, usually a string of HTML
classname - Name of class to be included as an attribute of the DIV object, if any
mousedownevt - Name of function, if any, to handle MouseDown events
mouseupevt - Name of function, if any, to handle MouseUp events
mousemoveevt - Name of function, if any, to handle MouseMove events
mouseoverevt - Name of function, if any, to handle MouseOver events
mouseoutevt - Name of function, if any, to handle MouseOut events

getLayer(name)

Returns the style object of the named DIV object. Used to set a style property of the name DIV tag.

Parameters:
name - Name of DIV object

hasLayer(name)

Returns true or false. Used to determine the existence of a named DIV object

Parameters:
name - Name of DIV object

isVisible(name)

Returns true or false. Used to determine the named DIV object is currently visible.

Parameters:
name - Name of DIV object

setLayerBackgroundColor(name, color)

Sets the background color of the named DIV object.

Parameters:
name - Name of DIV object
color - Color to be used. Any acceptable HTML color value

setDivZOrder(name, zvalue)

Sets the z-order of the named DIV object.

Parameters:
name - Name of DIV object
zvalue - Z-Value number

hideLayer(name)

Sets the visibility of the named DIV object to hidden.

Parameters:
name - Name of DIV object

showLayer(name)

Sets the visibility of the named DIV object to visible.

Parameters:
name - Name of DIV object

moveLayer(name, x, y)

Moves the named DIV object to x,y. Coordinates are for the upper left corner of the DIV object.

Parameters:
name - Name of DIV object
x - New left position of DIV object
y - New top position of DIV object

getXY(e)

Sets mouseX and mouseY with coordinates associated with e.

Parameters:
e - Event captured by browser

clipLayer(name, clipleft, cliptop, clipright, clipbottom)

Sets displayed view of named DIV object by resizing it to passed coordinates. Used by ZoomBox/DragBox DIV objects.

Parameters:
name - Name of DIV object
clipleft - Left edge of DIV object
cliptop - Top edge of DIV object
clipright - Right edge of DIV object
clipbottom - Bottom edge of DIV object

panClipLayer(name, clipleft, cliptop, clipright, clipbottom)

Clips displayed view of named DIV object using passed coordinates. Used in "panning" DIV objects.

Parameters:
name - Name of DIV object
clipleft - Left edge of DIV object
cliptop - Top edge of DIV object
clipright - Right edge of DIV object
clipbottom - Bottom edge of DIV object

getWinWidth ()

Returns the width of the current document's window.

Parameters:
None.

getWinHeight ()

Returns the width of the current document's window.

Parameters:
None.

adjustMapCoords()

Adjusts zleft and ztop to account for offset of DIV object.

Parameters:
None.

isLeftButton(e)

Returns if left button has been pressed (true/false).

Parameters:
e - Event captured by browser

convertNSrgb(color)

Returns hexadecimal color value from a Netscape color value of 'rgb(r g b)'

Parameters:
color - Color value to ve converted.

checkPrompt(mode)

Returns if defined confirm dialog is true or false.

Parameters:
mode - Tool mode

calcElementPosition(elementId)

Gets position and dimensions of browser element.

Parameters:
elementId - Id of element.

postBack(control, eventArg)

Posts back to the specified control with the specified event argument. Optionally brings up theloading image.

Parameters:
control - Control to postback to
eventArg - Event argument to pass to control

Loading functions

LoadDiv(imagePath)

Creates DIV object for the "Loading" animated image.

Parameters:
imagePath - Web path to the directory where the image is located

ShowLoading()

Makes the "Loading" DIV object visible.

Parameters:
None.

HideLoading()

Makes the "Loading" DIV object hidden.

Parameters:
None.

Zoombox functions

ZoomBoxDiv(image)

Creates the four DIV objects needed for the ZoomBox/DragBox.

Parameters:
image - Web path of the transparent image file used by the ZoomBox/DragBox

setClip(inSize)

Clips the ZoomBox/DragBox using inSize as the line width. Uses zleft, ztop, zright, and zbottom for clipping.

Parameters:
inSize - Line width size

displayZoomBox(left,top,right,bottom,color)

Displays a zoom box at the specified location with the specified color.

Parameters:
left - The left coordinate of the rectangle
top - The top coordinate of the rectangle
right - The right coordinate of the rectangle
bottom - The bottom coordinate of the rectangle
color - The color of the rectangle

hideZoomBox()

Hides the zoom box.

Parameters:
None.

clipZoomBox(left,top,right,bottom,color,size)

Resizes the zoom box at the specified location with the specified color and size. Called by the other zoom functions.

Parameters:
left - The left coordinate of the rectangle
top - The top coordinate of the rectangle
right - The right coordinate of the rectangle
bottom - The bottom coordinate of the rectangle
color - The color of the rectangle
size - The width of the border

Vector functions

DeleteVector()

Deletes the last vector in a polyline or polygon.

Parameters:
None.

RestartVectors()

Restarts the polyline or polygon. Point count is cleared and set to zero.

Parameters:
None.

CancelVectors()

Stops and clears out all vectors in an object.

Parameters:
None.

clearObjects()

Clears out all contents of the vector DIV object. Used as a method of a vector object.

Parameters:
None.

drawObjects()

Updates the document to display the contents of the vector DIV object. Used as a method of a vector object.

Parameters:
None.

setObjectColor(color)

Sets the color of the vector DIV object. Used as a method of a vector object.

Parameters:
color - Color to be used. Any acceptable HTML color value

addToObject(divleft, divtop, divwidth, divheight)

Adds an element to the vector object by appending a new DIV object to the contents of the vector DIV object. Used as a method of a vector object.

Parameters:
divleft - Left position of the new DIV object
divtop - Top position of the new DIV object
divwidth - Width of the new DIV object
divheight - Height of the new DIV object

addToObjectColor(divleft, divtop, divwidth, divheight, divcolor)

Adds an element to the vector object by appending a new DIV object to the contents of the vector DIV object. Used as a method of a vector object.

Parameters:
divleft - Left position of the new DIV object
divtop - Top position of the new DIV object
divwidth - Width of the new DIV object
divheight - Height of the new DIV object
divcolor - Color to be used. Any acceptable HTML color value

line(inX1, inY1, inX2, inY2)

Adds a line to the vector object by appending new DIV objects to the contents of the vector DIV object. Used as a method of a vector object.

Parameters:
inX - Left position of the start point of line
inY - Top position of the start point of line
inX2 - Left position of the end point of line
inY2 - Top position of the end point of line

ie_line(inX1, inY1, inX2, inY2)

Adds a line to the vector object by appending a VML tag to the contents of the vector DIV object. Used as a method of a vector object.

Parameters:
inX - Left position of the start point of line
inY - Top position of the start point of line
inX2 - Left position of the end point of line
inY2 - Top position of the end point of line

polyline(xArray, yArray)

Adds a polyline to the vector object by appending new DIV objects to the contents of the vector DIV object. Used as a method of a vector object.

Parameters:
xArray - Array of x coordinates of points defining the polyline
yArray - Array of y coordinates of points defining the polyline

ie_polyline(xArray, yArray)

Adds a polyline to the vector object by appending a VML tag to the contents of the vector DIV object. Used as a method of a vector object.

Parameters:
xArray - Array of x coordinates of points defining the polyline
yArray - Array of y coordinates of points defining the polyline

polygon(xArray, yArray)

Adds a polygon to the vector object by appending appending new DIV objects to the contents of the vector DIV object. Used as a method of a vector object.

Parameters:
xArray - Array of x coordinates of points defining the polygon
yArray - Array of y coordinates of points defining the polygon

ie_polygon(xArray, yArray)

Adds a polygon to the vector object by appending a VML tag to the contents of the vector DIV object. Used as a method of a vector object.

Parameters:
xArray - Array of x coordinates of points defining the polygon
yArray - Array of y coordinates of points defining the polygon

oval(ovleft, ovtop, inwidth, inheight)

Adds an oval to the vector object by appending a new DIV object to the contents of the vector DIV object. Used as a method of a vector object.

Parameters:
ovleft - Left position of the oval
ovtop - Top position of the oval
inwidth - Width of the oval
inheight - Height of the oval

ie_oval(ovleft, ovtop, inwidth, inheight)

Adds an oval to the vector object by appending a VML tag to the contents of the vector DIV object. Used as a method of a vector object.

Parameters:
ovleft - Left position of the oval
ovtop - Top position of the oval
inwidth - Width of the oval
inheight - Height of the oval

addToOval(centerx, centery, dleft, dright, dtop, dbottom, dwidth, dheight)

Adds 4 elements to the oval object diagonally from each other. Used as a method of a vector object to build the oval object.

Parameters:
centerx - X-coordinate of centroid of the oval
centery - Y-coordinate of centroid of the oval
dleft - Left offset of oval element
dright - Right offset of oval element
dtop - Top offset of oval element
dbottom - Bottom offset of oval element
dwidth - Width of oval element
dheight - Height of oval element

circle(centerX, centerY, radius, addcrosshair)

Adds an circle to the vector object by calling either the oval or the ie_oval method. Used as a method of a vector object.

Parameters:
centerX - X-coordinate of centroid of the circle
centerY - Y-coordinate of centroid of the circle
radius - Radius of the circle
addcrosshair - Add a crosshair to the circle at the centroid? (true/false)

box(leftX, topY, rightX, bottomY)

Adds an box to the vector object. Used as a method of a vector object.

Parameters:
leftX - Left X-coordinate of the box
topY - Top Y-coordinate of the box
rightX - Right X-coordinate of the box
bottomY - Bottom Y-coordinate of the box

vectorObjects(divid)

Creates a vector object to create and display vectors on the document.

Parameters:
divid - Id of the DIV object that will contain vector elements

pixelObject(controlname, inleft, intop, inwidth, inheight)

Creates an object for holding screen coordinates for mouse movement and clicks. Used with vector objects.

Parameters:
controlname - Name of Map WebControl
inleft - Left position of DIV object associated with controlname
intop - Top position of DIV object associated with controlname
inwidth - Width of DIV object associated with controlname
inheight - Height of DIV object associated with controlname

coordList()

Creates an object for holding a history list of coordinates of click locations. Used with vector objects.

Parameters:
None.

map_functions.js

Common Functions

MakeMapDiv(mapIndex, control, imageurl, cellname, tooltip)

Creates the DIV objects that will be associated with a Map WebControl.

Parameters:
mapIndex - Index of the Map WebControl
control - Id of the Map WebControl
imageurl - Path of image created by Map WebControl
cellname - Id of DIV object in which the Map DIV objects will be inserted
tooltip - String to be applied to the ToolTip of the DIV object

ClearVectorEvents(divid)

Clears event handling for the vector objects for the specified Map control.

Parameters:

divid - Id of Map WebControl

Set Tool Functions

MapDragImage(divid, mode, showLoading)

Sets up event handling to MapDragImage.

Parameters:

divid - Id of Map WebControl
mode - Tool identifier to be passed to server-side application
showLoading - Display Loading banner (true/false)

MapDragRectangle(divid, mode, showLoading)

Sets up event handling to MapDragRectangle.

Parameters:
divid - Id of Map WebControl
mode - Tool identifier to be passed to server-side application
showLoading - Display Loading banner (true/false)

MapPoint(divid, mode, showLoading)

Sets up event handling to MapPoint.

Parameters:
divid - Id of Map WebControl
mode - Tool identifier to be passed to server-side application
showLoading - Display Loading banner (true/false)

MapLine(divid, mode, showLoading)

Sets up vector object mode to Line.

Parameters:
divid - Id of Map WebControl
mode - Tool identifier to be passed to server-side application
showLoading - Display Loading banner (true/false)

MapPolyline(divid, mode, showLoading)

Sets up vector object mode to Polyline.

Parameters:
divid - Id of Map WebControl
mode - Tool identifier to be passed to server-side application
showLoading - Display Loading banner (true/false)

MapPolygon(divid, mode, showLoading)

Sets up vector object mode to Polygon.

Parameters:
divid - Id of Map WebControl
mode - Tool identifier to be passed to server-side application
showLoading - Display Loading banner (true/false)

MapCircle(divid, mode, showLoading)

Sets up vector object mode to circle for click/move/click mouse actions.

Parameters:
divid - Id of Map WebControl
mode - Tool identifier to be passed to server-side application
showLoading - Display Loading banner (true/false)

MapDragCircle(divid, mode, showLoading)

Sets up vector object mode to circle for button down/drag/button up mouse actions.

Parameters:
divid - Id of Map WebControl
mode - Tool identifier to be passed to server-side application
showLoading - Display Loading banner (true/false)

MapOval(divid, mode, showLoading)

Sets up vector object mode to Oval for click/move/click mouse actions.

Parameters:
divid - Id of Map WebControl
mode - Tool identifier to be passed to server-side application
showLoading - Display Loading banner (true/false)

MapDragOval(divid, mode, showLoading)

Sets up vector object mode to Oval for button down/drag/button up mouse actions.

Parameters:
divid - Id of Map WebControl
mode - Tool identifier to be passed to server-side application
showLoading - Display Loading banner (true/false)

MapBox(divid, mode, showLoading)

Sets up vector object mode to Box/Rectangle for click/move/click mouse actions.

Parameters:
divid - Id of Map WebControl
mode - Tool identifier to be passed to server-side application
showLoading - Display Loading banner (true/false)

MapDragBox(divid, mode, showLoading)

Sets up vector object mode to Box/Rectangle for button down/drag/button up mouse actions.

Parameters:
divid - Id of Map WebControl
mode - Tool identifier to be passed to server-side application
showLoading - Display Loading banner (true/false)

mapSetTool(divid, mode, showLoading, mouseDownFunction, clickFunction, cursor, vectormode, vectorToolbarState, statusMessage)

Sets up map tools.

Parameters:
divid - Id of Map WebControl
mode - Tool identifier to be passed to server-side application
showLoading - Display Loading banner (true/false)
mouseDownFunction - The function to call on mouse down
clickFunction - The function to call on click
cursor - The cursor
vectormode - Vector mode as a number: 0=Line; 1=Polyline; 2=Polygon; 3=Circle; 4=Oval; -1= Not a vector.
vectorToolbarState - Whether the vector toolbar is visible. Values: "visible" or "hidden"
statusMessage - The message to display in the status bar.

MouseDown/Click Functions

mapDragImageStart(e)

Handles MouseDown event for MapDragImage.

Parameters:
e - Event captured by browser

mapDragRectangleStart(e)

Handles MouseDown event for MapDragRectangle.

Parameters:
e - Event captured by browser

mapPointClick(e)

Handles MouseDown event for MapPoint.

Parameters:
e - Event captured by browser

mapVectorClick(e)

Handles MouseClick event for vector objects.

Parameters:
e - Event captured by browser

getMapDiv(e)

Gets the DIV object where the MouseDown event happened.

Parameters:
e - Event captured by browser

mapVectorMouseDown(e)

Handles MouseDown event for vector objects with button down/drag/button up mouse actions.

Parameters:
e - Event captured by browser

MouseMoveFunctions

mapDragImageMove(e)

Handles MouseMove event for MapDragImage.

Parameters:
e - Event captured by browser

mapDragRectangleMove(e)

Handles MouseMove event for MapDragRectangle.

Parameters:
e - Event captured by browser

mapVectorMove(e)

Handles MouseMove events for vector objects.

Parameters:
e - Event captured by browser

MouseUpFunctions

mapDragImageUp(e)

Handles MouseUp event for MapDragImage.

Parameters:
e - Event captured by browser

mapDragRectangleUp(e)

Handles MouseUp event for MapDragRectangle.

Parameters:
e - Event captured by browser

mapVectorEnd(e)

Finishes up vector object interaction.

Parameters:
e - Event captured by browser

mapVectorMouseUp(e)

Handles MouseUp event for vector objects with button down/drag/button up mouse actions.

Parameters:
e - Event captured by browser

overview_functions.js

Common Functions

OVCreation(controlname,index, width, height, uniquedivid, boxleft, boxtop, boxwidth, boxheight, boxcolor, linewidth)

Creates an object to hold parameters associated with an Overview WebControl's DIV object.

Parameters:
controlname - Id of Overview WebControl
index - Index of Overview DIV object
width - Width of Overview DIV object
height - Height of Overview DIV object
uniqueid - Unique Id for Overview DIV object
boxleft - Left position of AOI box in Overview DIV object
boxtop - Top position of AOI box in Overview DIV object
boxwidth - Width of AOI box in Overview DIV object
boxheight - Height of AOI box in Overview DIV object
boxcolor - Color of AOI box in Overview DIV object
linewidth - Line width of AOI box in Overview DIV object

MakeOVDiv(ovIndex, control, imageurl, blankurl, tooltip, cellname)

Creates the DIV objects that will be associated with an Overview WebControl.

Parameters:
ovIndex - Index of Overview DIV object
control - Unique Id for Overview DIV object
imageurl - Web path of image to be displayed in Overview DIV object
blankurl - Web path of transparent image used by AOI box in Overview DIV object
tooltip - String to be used by DIV ToolTip
cellname - Id of DIV object in which the Overview DIV objects will be inserted

Setup Function

SetupOVEvents() Sets up event handlers for the Overview DIV object.

Parameters:
None.

Mouse Action Functions

ovDragStart(e)

Handles the MouseDown event of the AOI box in the Overview DIV object.

Parameters:
e - Event captured by browser

ovDragMove(e)

Handles the MouseMove event of the AOI box in the Overview DIV object.

Parameters:
e - Event captured by browser

ovDragUp(e)

Handles the MouseUp event of the AOI box in the Overview DIV object.

Parameters:
e - Event captured by browser

ovClick(e)

Handles the MouseDown event of the Overview DIV object. The AOI box will be moved to the location of MouseDown action.

Parameters:
e - Event captured by browser

getOVDiv()

Gets the Overview DIV object that fired the last event.

Parameters:
None.

page_functions.js

Common Functions

PageCreation(controlname, width, height, maparray,dragBoxColor,dragLineWidth)

Creates an object to hold parameters associated with the PageLayout WebControl's DIV object.

Parameters:
controlname - ID of PageLayout WebControl
width - Width of DIV object
height - Height of DIV object
maparray - Array of Map parameters
dragBoxColor - Color of associated ZoomBox/DragBox DIV object
dragLineWidth - Width of associated ZoomBox/DragBox DIV object

MakePageDiv(i, blankImage, cellname, tooltip)

Creates the DIV objects that will be associated with a Map WebControl.

Parameters:
i - Index of Map within the PageLayout
blankImage - Path of transparent image file
cellname - Id of DIV object in which the PageLayout DIV objects will be inserted
tooltip - String inserted in the image's Alt attribute

Set Tool Functions

PageDragImage(divid, mode, showLoading)

Sets up event handling to PageDragImage.

Parameters:
divid - Id of PageLayout WebControl
mode - Tool identifier to be passed to server-side application
showLoading - Display Loading banner (true/false)

PageDragRectangle(divid, mode, showLoading)

Sets up event handling to PageDragRectangle.

Parameters:
divid - Id of PageLayout WebControl
mode - Tool identifier to be passed to server-side application
showLoading - Display Loading banner (true/false)

PagePoint(divid, mode, showLoading)

Sets up event handling to PagePoint.

Parameters:
divid - Id of PageLayout WebControl
mode - Tool identifier to be passed to server-side application
showLoading - Display Loading banner (true/false)

PageMapDragImage(divid, mode, showLoading)

Sets up event handling to MapDragImage.

Parameters:
divid - Id of PageLayout WebControl
mode - Tool identifier to be passed to server-side application
showLoading - Display Loading banner (true/false)

PageMapDragRectangle(divid, mode, showLoading)

Sets up event handling to MapDragRectangle.

Parameters:
divid - Id of PageLayout WebControl
mode - Tool identifier to be passed to server-side application
showLoading - Display Loading banner (true/false)

PageMapPoint(divid, mode, showLoading)

Sets up event handling to MapPoint.

Parameters:
divid - Id of PageLayout WebControl
mode - Tool identifier to be passed to server-side application
showLoading - Display Loading banner (true/false)

pageSetTool(divid, mode, showLoading, pageMouseDownFunction, mapMouseDownFunction, cursor)

Sets up page tools.

Parameters:
divid - Id of PageLayout WebControl
mode - Tool identifier to be passed to server-side application
showLoading - Display Loading banner (true/false)
pageMouseDownFunction - The function to call when the mouse goes down on the page layout.
mapMouseDownFunction - The function to call when the mouse goes down on the maps in the page layout.
cursor - The cursor.

MouseDown/Click Functions

pageDragImageStart(e)

Handles MouseDown event for PageDragRectangle.

Parameters:
e - Event captured by browser

pageDragRectangleStart(e)

Handles MouseDown event for PageDrageRectangle.

Parameters:
e - Event captured by browser

pagePointClick(e)

Handles MouseDown event for PagePoint.

Parameters:
e - Event captured by browser

pageMapDragImageStart(e)

Handles MouseDown event for MapDragImage.

Parameters:
e - Event captured by browser

pageMapDragRectangleStart(e)

Handles MouseDown event for MapDragRectangle.

Parameters:
e - Event captured by browser

pageMapPointClick(e)

Handles MouseDown event for MapPoint.

Parameters:
e - Event captured by browser

getPageDiv(e)

Gets the DIV object associated with the PageLayout where the MouseDown event happened.

Parameters:
e - Event captured by browser

getPageMapDiv(e)

Gets the DIV object associated with the Map within the PageLayout where the MouseDown event happened.

Parameters:
e - Event captured by browser

MouseMove Functions

pageDragImageMove(e)

Handles MouseMove event for PageDragImage.

Parameters:
e - Event captured by browser

pageDragRectangleMove(e)

Handles MouseMove event for PageDragRectangle.

Parameters:
e - Event captured by browser

pageMapDragImageMove(e)

Handles MouseMove event for MapDragImage.

Parameters:
e - Event captured by browser

pageMapDragRectangleMove(e)

Handles MouseMove event for MapDragRectangle.

Parameters:
e - Event captured by browser

MouseUp Functions

pageDragImageUp(e)

Handles MouseUp event for PageDragImage.

Parameters:
e - Event captured by browser

pageDragRectangleUp(e)

Handles MouseUp event for PageDragRectangle.

Parameters:
e - Event captured by browser

pageMapDragImageUp(e)

Handles MouseUp event for MapDragImage.

Parameters:
e - Event captured by browser

pageMapDragRectangleUp(e)

Handles MouseUp event for MapDragRectangle.

Parameters:
e - Event captured by browser

toolbar_functions.js

Common Functions

ToolbarCreation(name, toolbarStyle, defaultStyle, selectedStyle, hoverStyle, tools, commands, buddyControls,itemArray)

Creates an object that contains information required to manipulate a toolbar.

Parameters:
name - Name of toolbar
toolbarStyle - Type of toolbar (ImageOnly, TextOnly, ImageAndText)
defaultStyle - String containing text to be used in style attribute used by default
selectedStyle - String containing text to be used in style attribute used by selected toolbar item.
hoverStyle - String containing text to be used in style attribute used when cursor hovers over a toolbar item.
tools - String containing list of tool names, separated by commas
commands - String containing list of commands, separated by commas
buddyControls - String containing list of Controls that the toolbar will be buddied with
itemArray - Name of array containing objects associated with the toolbar items

ToolbarGroupCreation(name, toolbars)

Creates a toolbar group.

Parameters:
name - Name of the group.
toolbars - String containing names of the toolbars making up the toolbar group separated by commas.

ToolbarItemCreation(name, defaultImage, selectedImage, hoverImage, clientToolAction, isClientToolActionCustom, showLoading)

Creates object that contains information for a command or a tool on a toolbar.

Parameters:
name - Name of toolbar item
defaultImage - Path of image to be used by default
selectedImage - Path of image to be used when the item is the selected toolbar item.
hoverImage - Path of image to be used when the cursor hovers over the toolbar item
clientToolAction - Name of ClientToolAction to be associated with toolbar item
sClientToolActionCustom - Is a custom ClientToolAction (true/false)
showLoading - Display Loading banner (true/false)

Mouse Action Functions

ToolbarMouseDown(toolbarName, toolbarItemName, buttonType)

Handles MouseDown event for a toolbar.

Parameters:
toolbarName - Name of toolbar
toolbarItemName - Name of toolbar item
buttonType - "Tool", "Command" or "HtmlCommand"

ToolbarMouseOver(toolbarName, toolbarItemName)

Handles MouseOver event for a toolbar.

Parameters:
toolbarName - Name of toolbar
toolbarItemName - Name of toolbar item

ToolbarMouseOut(toolbarName, toolbarItemName)

Handles MouseOut event for a toolbar.

Parameters:
toolbarName - Name of toolbar
toolbarItemName - Name of toolbar item

toolbarSelectTool(toolbarName)

Sets the style and image of each of the tools in a toolbar so that the selected tool is rendered with the selected style and image.

Parameters:
toolbarName - Name of toolbar

toolbarRefreshGroup(toolbarName)

Refreshes a group of toolbars so that the selected tool for the group is rendered with the selected style and image.

Parameters:
toolbarName - Name of toolbar

toolbarRefreshCommands(toolbarName)

Sets the style and image of the each of the commands in a toolbar.

Parameters:
toolbarName - Name of toolbar