CWC2 Widget Documentation

intro text, put a nice little paragraph in here that describes this document.

Index

Attribute Groups

Base Attributes
Label Attributes
Icon Attributes
Button Attributes
Popup Attributes
Text Button Attributes

CWC2 Widgets

CWCWidget
BoundingBoxPopup
CatalogSearch
ClearPoints
ClearWFSFilter
CompassPoint
Cursorpos
DownloadContext
ErrorReport
ExpressionBuilder
Extent
Extract
ExtractWFSData
HelpWidget
JSList
JSTreeView
KeyMap
Language
LayerManager
Legend
LegendTemplate
Link
Locate
MapDHTMLWidget
MapImageSharedResource
MapImageStatic
MapSize
MapTips
MapUnits
OWTChart
PanMap
PrintWidget
ProjectionLabel
ProjectionSelector
Query
QuickZoom
ROIManager
ROIManagerMode
ROIMode
ROIRectangleTool
ROIRemoveAll
ROIRemoveLast
Recenter
Ruler
RulerResult
SLDCache
SQLQuery
Scale
ScaleZoom
Scalebar
SelectLayers
SessionExpired
SharedResource
Table
TimeFilter
Title
UpdateMap
UploadContext
VarSharedResource
VarURL
WMSCache
XMLRPC
XMLThemeLegend
ZoomAllLayers
ZoomFactor
ZoomIn
ZoomOut
ZoomSelectedLayers
ZoomVisibleLayers
cwcjsapi
DownloadSLD
ROICircleTool
ROIPolygonTool
StyleManager
UploadSLD
Z39Query

CWC2 Attribute Groups

The name of the widget. Not all widgets use this. Only the SharedResource widget currently needs this. The type of the widget indicates the actual widget object to create for this tag. Make the widget visible or not in the page, by default this is true for all widgets. Setting this to true will typically result in some HTML comment being written into the page in place of its normal user interface. Note that setting a widget to invisible will not prevent the widget from outputting form variables and javascript. To remove a widget entirely (without deleting it), set its ENABLED property to false. Never attempt to comment out a widget tag using HTML comments in the template. Enable or disable the widget in the interface. If the widget is disabled, then this should result in all output from the widget being removed from the resulting template. It should be used to temporarily remove a widget from normal processing, while leaving a placeholder in the template. Never attempt to comment out a widget tag using HTML comments in the template. The text to display in this label. This should contain valid HTML. Special characters, such as accented characters, must be represented by their HTML encoded version (i.e. é is é). The position of the label around another widget. Position 0 is upper-left. Positions increase clockwise to position 8 which is left of the widget. Default is 8. The horizontal alignment of the label, default is left. The vertical alignment of this label. The default is middle. The CSS class to control the rendering of this label. The default is CWCLabelWidgetClass. The CSS style to apply to this label. The default is no style. The image to display for this icon. The width in pixels of this image. This is used in the resulting <IMG> tag to allow some browsers (like Netscape 4.7) to load the page faster. The height in pixels of this image. This is used in the resulting <IMG> tag to allow some browsers (like Netscape 4.7) to load the page faster. The alternate or tooltip text to display for this image. Not all browsers support this property. The CSS class to control the rendering of this image. The default is no class. A CSS style to apply to this image tag. The default is no style. A name indicating a logical group of tools of which only one can be selected. The image to display when this button is selected. The image to display when the mouse hovers over this button. Sets the width in pixels of a popup window. Sets the height in pixels of a popup window. Controls the display of a toolbar in a popup window. The default is true. Controls the display of a menubar in a popup window. The default is true. Controls the display of a status bar in a popup window. The default is true. Controls the display of scrollbars in a popup window. The default is true. Controls if a popup window is resizable or not. The default is true. The color to fill the background of the text button with. An image to render as the background of the button. The background image is rendered on top of the background color. The image to use as the top left corner of the text button. The image to use as the top edge of the button. The image to use as the top right corner of the text button. The image to use as the right edge of the text button. The image to use as the bottom right corner of the text button. The image to use as the bottom edge of the text button. The image to use as the bottom left corner of the text button. The image to use as the left edge of the text button The overall width of the text button in pixels. The overall height of the text button in pixels. The amount of space to leave between the image and the label in pixels. The amount of vertical adjustment in pixels to apply to the label's vertical placement. The label is centered vertically in the available space but may sometimes appear misaligned because of rounding errors or descenders (qypgj). Path to the TrueType font file to use when rendering the label. The path is specified relative to the cwc2 directory. The font file must exist on the server to be valid. The size of font to use for the label. The horizontal alignment of the label on the button. One of left, center or right. Control the use of antialiasing when rendering the label. This is sometimes desirable to control the quality of the font rendering. The image to display in the button. The image is displayed at the left edge of the button, centered vertically. Control the use of caching when rendering text buttons. Text buttons take a relatively long time to render so it is desirable to cache the text button for improved application performance. However, when developing a new template or modifying existing buttons, it is useful to turn off caching temporarily.

CWC2 Widget Details

cwcwidget

Description:

CWCWidget is the most basic type of widget. It provides the basic functionality of a widget and defines the standard API that widgets must implement in order to function correctly with the CWC service instance. All widgets represent themselves in the template using the CWCWidget tag and set the type and other attributes as necessary.

Tag:

Attributes:

The cwcwidget tag has attributes from the attributes from the Base Attributes group.

Form Elements:

sid: No description available.

Javascript Functions:

None

Javascript Variables:

None

boundingboxpopup

Description:

The BoundingBoxPopupWidget displays a popup dialog box that allows the user to enter bounding box coordinates to zoom to (either rectangle or point)

Tag:

Attributes:

The boundingboxpopup tag has attributes from the Base Attributes, Icon Attributes, Popup Attributes, Label Attributes, and Button Attributes groups.

Form Elements:

NAV_CMD: The last command that was used to interact with the map
NAV_INPUT_TYPE: the type of the last navigation command, either POINT or RECTANGLE
NAV_INPUT_COORDINATES: the coordinates that the last command generated. May be a single point, or two points representing a rectangle

Javascript Functions:

setCurrentTool(): set the currently active tool from a group of tools
flipToolState(): toggle the state of a tool button
registerTool(): used to register a tool in the page
onButtonOver(): callback when the mouse moves over a button
onButtonOut(): callback when the mouse leaves a button
onButtonClick(): callback when a button is clicked.
clickBoundingBoxPopup(): callback function for the user clicking the Zoom to Bounding Box button
applyBoundingBox(): callback function to apply a Zoom to Bounding Box or Point Coordinates.
getMapExtents(): return the current extents of the map.

Javascript Variables:

aToolGroups: array used to manage groups of tools on the page.
aTools: array of tools on the page.

catalogsearch

Description:

The catalog search width allows a user to search a catalog of WMS layers based on an entered keyword and select one or more layers from the results to add to the current context.

Tag:

Attributes:

The catalogsearch tag has attributes from the Base Attributes, Popup Attributes, Label Attributes, and Text Button Attributes groups.

Form Elements:

LAYER_TITLE: The title for the last layer that was selected from the catalog search function
LAYER_ALT_TITLE: The alternate title for the last layer that was selected from the catalog search function
LAYER_SERVER_VERSION: The version of WMS that the server supports for the last layer that was selected from the catalog search function
LAYER_CONNECT_STRING: The connection string for the last layer that was selected from the catalog search function
LAYER_ABSTRACT: The abstract for the last layer that was selected from the catalog search function
LAYER_LLBB: The LatLong bounding box for the last layer that was selected from the catalog search function
LAYER_STYLES: The styles supported by the last layer that was selected from the catalog search function
LAYER_FORMATS: The formats for the last layer that was selected from the catalog search function
LAYER_SRSS: The SRS values supported by the last layer that was selected from the catalog search function

Javascript Functions:

clickCatalogSearch(): callback function for the user clicking the "catalog" button
catalogSearchCB(): callback function for the catalog search page.

Javascript Variables:

None

clearpoints

Description:

The ClearPoints widget allows the user to clear all user created points and refresh the current page without performing any other navigation.

Tag:

Attributes:

The clearpoints tag has attributes from the Base Attributes, and Text Button Attributes groups.

Form Elements:

CLEAR_POINTS: Controls the activation of the ClearPoint widget.

Javascript Functions:

clickClearPoints(): Callback function for the user clicking the "Clear Points" button.

Javascript Variables:

None

clearwfsfilter

Description:

The ClearWFSFilter widget clears the WFS filter from the active layer and deletes the temporary annotation layer.

Tag:

Attributes:

The clearwfsfilter tag has attributes from the Base Attributes, Icon Attributes, Label Attributes, and Button Attributes groups.

Form Elements:

WFS_CLEAR_FILTER: Flag to trigger a clear filter action.

Javascript Functions:

setCurrentTool(): set the currently active tool from a group of tools
flipToolState(): toggle the state of a tool button
registerTool(): used to register a tool in the page
onButtonOver(): callback when the mouse moves over a button
onButtonOut(): callback when the mouse leaves a button
onButtonClick(): callback when a button is clicked.
clickClearWFSFilter(): Clears the current WFS filter on the selected layer.

Javascript Variables:

aToolGroups: array used to manage groups of tools on the page.
aTools: array of tools on the page.

compasspoint

Description:

The CompassPoint widget is a clickable image that the user can click to pan in a given direcion.

Tag:

Attributes:

The compasspoint tag has attributes from the Base Attributes, Icon Attributes, and Button Attributes groups plus the following attributes:

DEFAULT: Determine if this compass point will be active when the page loads, not used.
WIDGETSTYLE: The style to apply to images that represent this widget.
MAPID: Control the map to which this compass point will apply when clicked.
DIRECTION: The direction that the compass point will pan the map when clicked.
PANPERCENT: The amount to pan the map in the given direction as a percentage of the map width or height.

Form Elements:

NAV_CMD: The last command that was used to interact with the map
NAV_ALLOW_RECTANGLE: Tracks whether the current navigation tool uses a rubber-banding box or not.

Javascript Functions:

setCurrentTool(): set the currently active tool from a group of tools
flipToolState(): toggle the state of a tool button
registerTool(): used to register a tool in the page
onButtonOver(): callback when the mouse moves over a button
onButtonOut(): callback when the mouse leaves a button
onButtonClick(): callback when a button is clicked.
NavSetActiveTool(): set the active navigation tool for a particular group of tools

Javascript Variables:

aToolGroups: array used to manage groups of tools on the page.
aTools: array of tools on the page.

cursorpos

Description:

Display the current cursor position in geographic coordinates. To assist template developers, this widget can be configured to display one of the two axis of the cursor position. The cursor position must be displayed in an HTML element that can be updated, so an HTML INPUT box is used. CSS can be used to modify the appearance of the INPUT box to make it look nicer in more modern browsers.

Tag:

Attributes:

The cursorpos tag has attributes from the Base Attributes, and Label Attributes groups plus the following attributes:

AXIS: Determine if the X or Y value of the current cursor position is displayed.
TEXTFIELDSIZE: The size in characters of the text box that displays the cursor position.
WIDGETCLASS: The CSS class to control the style of the HTML INPUT box. The default is CWCCursorPositionWidgetClass.
WIDGETSTYLE: The CSS Style to control the style of the HTML INPUT box. The default is no style.

Form Elements:

sid: No description available.

Javascript Functions:

CursorXMouseMoved(): callback function for tracking mouse movement in the X direction
WidgetPix2Geo(): Convert pixel position to geographic coordinates

Javascript Variables:

None

downloadcontext

Description:

The ContextDownloadWidget allows the user to download the current state of the map as a Context document. Window size, current extents, and layer visibility are preserved.

Tag:

Attributes:

The downloadcontext tag has attributes from the Base Attributes, Popup Attributes, Label Attributes, and Text Button Attributes groups.

Form Elements:

sid: No description available.

Javascript Functions:

clickContextDownload(): callback function for the user clicking the "download context" button

Javascript Variables:

None

errorreport

Description:

This is a utility widget used to display errors that have occurred during processing. Normally the errors are non-fatal, but could be useful in debugging widgets or a new template.

Tag:

Attributes:

The errorreport tag has attributes from the Base Attributes, and Popup Attributes groups.

Form Elements:

sid: No description available.

Javascript Functions:

DisplayErrors(): Popup a window displaying error messages that occurred.

Javascript Variables:

None

expressionbuilder

Description:

The ExpressionBuilder widget displays a popup window that allows the user to interactively build expressions.

Tag:

Attributes:

The expressionbuilder tag has attributes from the Base Attributes, Icon Attributes, Popup Attributes, Label Attributes, and Button Attributes groups plus the following attributes:

SLD: This option is not yet available.
WILDCARD: This character is used in conjunction with the `LIKE` operator for defining a wildcard in an expression
SINGLECHAR: This character is used in conjunction with the `LIKE` operator for defining single characters in an expression.
ESCAPE: This character is used in conjunction with the `LIKE` operator for escaping special characters in an expression.

Form Elements:

WFS_FILTER: Hidden varible containing the WFS Filter to be applied to the active layer.
WFS_FILTER_LAYER_INDEX: Index of layer to appy filter to.
WFS_FILTER_EXPRESSIONLIST: No description available.
WFS_FILTER_APPLYTOMAP: No description available.
WFS_FILTER_SLD: No description available.
WFS_FILTER_SLD_FILE: No description available.
WFS_FILTER_CONNECTION: No description available.
WFS_FILTER_LAYERTYPE: No description available.

Javascript Functions:

setCurrentTool(): set the currently active tool from a group of tools
flipToolState(): toggle the state of a tool button
registerTool(): used to register a tool in the page
onButtonOver(): callback when the mouse moves over a button
onButtonOut(): callback when the mouse leaves a button
onButtonClick(): callback when a button is clicked.
clickExpressionBuilder(): launches the Expression Builder widget popup.
applyWFSFilter(): function to apply the current WFS filter on the selected layer.
saveExpressions(): No description available.

Javascript Variables:

aToolGroups: array used to manage groups of tools on the page.
aTools: array of tools on the page.

extent

Description:

The Extent widget displays one of the extents of the map in text on the output page.

Tag:

Attributes:

The extent tag has attributes from the Base Attributes, and Label Attributes groups plus the following attributes:

EXTENT: The extent to display.
WIDGETCLASS: The CSS class to control the style of the extent text. The default is CWCExtentWidgetClass
WIDGETSTYLE: The CSS style to control the style of the extent text. The default is none.
TEXTFIELDSIZE: The size in characters to make the extent widget in JSAPI mode.

Form Elements:

sid: No description available.

Javascript Functions:

None

Javascript Variables:

None

extract

Description:

The Extract widget is specific to GeoBase. It connects the user to an extraction service that allows for the extraction of visible layers at the current extents.

Tag:

Attributes:

The extract tag has attributes from the Base Attributes, and Text Button Attributes groups plus the following attributes:

HREF: The URL to connect to for the extraction service.
APPENDGET: Additional URL parameters to append to the GET request generated by the extract widget.
APPENDSID: A session ID to append to the GET request.
TARGET: Allow the extract widget to load the HREF in a named window.
MINSCALE: The minimum scale at which extraction is allowed. Below this, the user will be warned that extraction is not allowed.
MAXSCALE: The maximum scale at which extraction is allowed. Above this, the user will be warned that extraction is not allowed.

Form Elements:

sid: No description available.

Javascript Functions:

doExtract(): callback function for the user clicking the Extract button

Javascript Variables:

aToolGroups: array used to manage groups of tools on the page.
aTools: array of tools on the page.

extractwfsdata

Description:

The Extract WFS Data widget allows the user to extract data based on the current selected layer and ROI. Currently the following formats are supported: GML Shape

Tag:

Attributes:

The extractwfsdata tag has attributes from the Base Attributes, Icon Attributes, Popup Attributes, Label Attributes, and Button Attributes groups plus the following attribute:

OUTPUTFORMATS: No description available.

Form Elements:

None

Javascript Functions:

setCurrentTool(): set the currently active tool from a group of tools
flipToolState(): toggle the state of a tool button
registerTool(): used to register a tool in the page
onButtonOver(): callback when the mouse moves over a button
onButtonOut(): callback when the mouse leaves a button
onButtonClick(): callback when a button is clicked.
clickExtractWFSData(): launches the Extract WFS Data widget popup.

Javascript Variables:

aToolGroups: array used to manage groups of tools on the page.
aTools: array of tools on the page.

helpwidget

Description:

Display help content.

Tag:

Attributes:

The helpwidget tag has attributes from the attributes from the Base Attributes group.

Form Elements:

sid: No description available.

Javascript Functions:

None

Javascript Variables:

None

jslist

Description:

The JSList widget creates a SELECT input and populates it with values from a SharedResource.

Tag:

Attributes:

The jslist tag has attributes from the attributes from the Base Attributes group plus the following attributes:

JSSHAREDRESOURCE: The name of a javascript-enabled SharedResource to draw values from.
LABELFIELD: The name of the property to get from the SharedResources to display for the user.
VALUEFIELD: The name of the property to get from the SharedResource to use as a value in the options generated in the select list.
ONCHANGE: A javascript function to call if the list changes. This must be the name of the function only. The callback passes the select object and the selected option object to this function.
WIDGETCLASS: The CSS class name to apply to the list box.
WIDGETSTYLE: The CSS style to apply to the list box.

Form Elements:

sid: No description available.

Javascript Functions:

initJSList_(): Called by each JSList widget to initialize itself.

Javascript Variables:

None

jstreeview

Description:

The Javascript TreeView displays a client side tree view of the data in a Shared Resource Widget that has the JSEnabled attribute set to true.

Tag:

Attributes:

The jstreeview tag has attributes from the attributes from the Base Attributes group plus the following attributes:

JSSHAREDRESOURCE: The name of a javascript-enabled SharedResource to draw values from.
NODEONCLICK: The name of a javascript function to call when the user clicks on a branch. This must be the name only. The callback is called with the value from the NODEDATAFIELD property of the SharedResource.
NODEDATAFIELD: The name of the property to get from the SharedResources as the data associated with a branch on the tree.
NODELABELFIELD: The name of the property to get from the SharedResources to display as a label on for a branch on the tree.
NODEICONFIELD: The name of the property to get from the SharedResources as the image to be displayed for a branch on the tree when it is closed
NODEICONOPENFIELD: The name of the property to get from the SharedResources to display as a label on for a branch on the tree when it is open. If not provided, the closed icon will be used.
NODECLASS: The CSS class name to use for text displayed in the tree. This is applied to a tag that is wrapped around all labels displayed in the tree.
NODESELECTEDSTYLE: CSS styles to be applied to a label in the tree when it has been selected. This should be zero or more CSS styles. Note that these styles override the associated class NODECLASS settings and cannot be removed without using NODENORMALSTYLE.
NODENORMALSTYLE: CSS styles to be applied to a label in the tree after it was selected and then another item was selected. This should be zero or more CSS styles that essentially reverse the NODESELECTEDSTYLE.
LEAFONCLICK: The name of a javascript function to call when the user clicks on a leaf. This must be the name only. The callback is called with the value from the LEAFDATAFIELD property of the SharedResource.
LEAFLABELFIELD: The name of the property to get from the SharedResources to display as a label on for a leaf on the tree.
LEAFICONFIELD: The name of the property to get from the SharedResources as the image to be displayed for a leaf on the tree.
LEAFDATAFIELD: The name of the property to get from the SharedResources as the data associated with a leaf on the tree.
LINKCLASS: The CSS class name to use for links in the tree. Links are tags inside of the that wraps all labels in the tree.

Form Elements:

sid: No description available.

Javascript Functions:

None

Javascript Variables:

foldersTree: The global javascript object that represents the javascript tree on the page, currently harded-coded to this by the javascript tree code.
HIGHLIGHT: Set to control the javascript treemenu.
ICONPATH: Set to control the javascript treemenu.
USETEXTLINKS: Set to control the javascript treemenu.
USEFRAMES: Set to control the javascript treemenu.
STARTALLOPEN: Set to control the javascript treemenu.
PRESERVESTATE: Set to control the javascript treemenu.
JSTreeViewImage: A global javascript Image object to use for pre-loading tree images.
NODECLASS: Set to control the javascript treemenu.
LINKCLASS: Set to control the javascript treemenu.
NODESELECTEDSTYLE: Set to control the javascript treemenu.
NODENORMALSTYLE: Set to control the javascript treemenu.

keymap

Description:

The KeyMap widget displays a key map (or reference map) that displays the users currently viewed extents within a larger reference frame.

Tag:

Attributes:

The keymap tag has attributes from the Base Attributes, Icon Attributes, and Button Attributes groups plus the following attributes:

DEFAULT: From NavTool, controls if this is the default navigation widget. Ignored for KeyMapWidget.
WIDGETSTYLE: From NavTool, this is the CSS class to control the style of the Keymap image tag. Default is none.
MAPID: The ID of the map to which this widget should apply its navigation.
WIDTH: The width in pixels of the keymap image.
HEIGHT: The height in pixels of the keymap image.
COLOR: The fill color for the box drawn to represent the current extents. Set to "-1 -1 -1" for transparent. The default is "-1-1-1".
OUTLINECOLOR: The outline color for the box drawn to represent the current extents. The default is "255 0 0" for Red.
MINX: The minimum X value in geographic coordinates that this image represents.
MINY: The minimum Y value in geographic coordinates that this image represents.
MAXX: The maximum X value in geographic coordinates that this image represents.
MAXY: The maximum Y value in geographic coordinates that this image represents.
SRS: The projection that the extents for this widget are defined in.

Form Elements:

NAV_INPUT_TYPE: the type of the last navigation command, either POINT or RECTANGLE
NAV_INPUT_COORDINATES: the coordinates that the last command generated. May be a single point, or two points representing a rectangle

Javascript Functions:

TrackMouseXY(): called when the user moves the mouse.
FindObjectPosX(): Return the X coordinates of an HTML object on the page.
FindObjectPosY(): Return the Y coordinates of an HTML object on the page.
KeyMapClicked(): handle the user clicking on the Key Map

Javascript Variables:

KeyMapWidget: Ensure that mouse movement events are captured under IE.
gnMouseX: the current X position of the mouse
gnMouseY: the current Y position of the mouse

language

Description:

The Language widget allows the template designer to specify several languages that the user can switch to from the current template, and makes the current language available to widgets that support a multilingual interface. This widget uses sub-tags in the form: <language name="en-CA"/>. There is a javascript function setLanguage that can be used to automatically load the template associated with a given language while preserving the current context extents and layer visibility.

Tag:

Attributes:

The language tag has attributes from the attributes from the Base Attributes group.

Form Elements:

LANGUAGE: USed by the language widget to track the current language setting.

Javascript Functions:

setLanguage(): set the current language

Javascript Variables:

None

layermanager

Description:

The LayerManager widget is a complex dialog box that allows the user to manage the layers in the current context and add new layers from a list of cached WMS servers.

Tag:

Attributes:

The layermanager tag has attributes from the Base Attributes, Popup Attributes, and Text Button Attributes groups.

Form Elements:

currentState: a key that references the current state of the context.

Javascript Functions:

clickLayerManager(): callback function for the user clicking the Layer Management button
LayerManagerCB(): callback function to handle user input from the Layer Manager dialog

Javascript Variables:

None

legend

Description:

The LegendPopup widget allows the user to popup a legend for the current context in a separate window.

Tag:

Attributes:

The legend tag has attributes from the Base Attributes, Popup Attributes, and Text Button Attributes groups.

Form Elements:

LEG_WID_POPUP_OPEN: Used to track if the legend widget has an open popup window so it can be refreshed in CWC2 JSAPI mode.

Javascript Functions:

clickLegendPopup(): callback function for the user clicking the Legend button

Javascript Variables:

None

legendtemplate

Description:

The Legend widget allows the user display a legend based on a legend template. The Legend can either be embedded in the same page or displayed in a separate window.

Tag:

Attributes:

The legendtemplate tag has attributes from the attributes from the Base Attributes group plus the following attribute:

TEMPLATE: the path to the template that is used by MapServer's HTML Legend processor. The path is considered relative to the template if it is not absolute.

Form Elements:

LEGENDTEMPLATE_RESET: Used to control the legend template widget.
LEGENDTEMPLATE_LAYERS: No description available.

Javascript Functions:

LegendTemplateLayerInfo(): Callback function to handle user requesting information about a layer from the LegendTemplate widget.

Javascript Variables:

None

link

Description:

The Link widget allows the template to display a button that will open an arbitrary URL such as a help page for an application.

Tag:

Attributes:

The link tag has attributes from the Base Attributes, and Text Button Attributes groups plus the following attributes:

HREF: The URL to open when the user clicks the associated button.
APPENDGET: Additional URL parameters to append to the GET request generated by the link widget.
APPENDSID: A session ID to append to the GET request.
TARGET: Allow the link widget to load the HREF in a named window.

Form Elements:

sid: No description available.

Javascript Functions:

setCurrentTool(): set the currently active tool from a group of tools
flipToolState(): toggle the state of a tool button
registerTool(): used to register a tool in the page
onButtonOver(): callback when the mouse moves over a button
onButtonOut(): callback when the mouse leaves a button
onButtonClick(): callback when a button is clicked.

Javascript Variables:

aToolGroups: array used to manage groups of tools on the page.
aTools: array of tools on the page.

locate

Description:

The Locate widget provides a dialog box that can be used to search for postal codes, place names and NTS map sheets and zoom the map to one of the results of the search.

Tag:

Attributes:

The locate tag has attributes from the Base Attributes, Popup Attributes, and Text Button Attributes groups plus the following attribute:

ZOOMTOSCALE: The map scale to zoom to when the Locate widget to zoom to a location. A value between 250000 and 1000000 would be reasonable in most applications.

Form Elements:

LOCATE_ZOOM_TO: The geographic coordinates to zoom to when locating something
LOCATE_ADD_ELEMENT: Used to track the element that has been added to the map (point or rectangle)
LOCATE_LATLONG: The lat/long value to zoom to.

Javascript Functions:

onClickLocate(): callback when the locate button is clicked
LocateCB(): callback function to handle user input from the Locate dialog

Javascript Variables:

None

mapdhtmlwidget

Description:

The MapDHTML widget displays the actual visualization of the current context and provides many of the mechanisms for other tools to do their job, primarily the navigation tools.

Tag:

Attributes:

The mapdhtmlwidget tag has attributes from the attributes from the Base Attributes group plus the following attributes:

MARQUEECOLOR: The color to draw the zoom box in.
MARQUEEWIDTH: When drawing the marquee, this is the width/height to make the edges of the zoom box.
MARQUEEVERTICALIMAGE: See MARQUEEHORIZONTALIMAGE. This is used for the top and bottom edges.
MARQUEEHORIZONTALIMAGE: The image to use for drawing the marquee. If properly used, you can create dashed line effects using this. The left and right layers used to draw the edges of the zoom box have this image as the background and show only a slice of the image the height of the zoom box and the defined marquee width.
MINSCALE: The minimum scale to draw the current context at. Zooming in beyond this scale will be prevented.
MAXSCALE: The maximum scale to draw the current context at. Zooming out beyond this scale will be prevented.
ALLOWRESIZE: control the resizability of the map widget. This allows the application to respect or ignore the Window tag in a context document.
WIDTH: The width in pixels of the map width image.
HEIGHT: The initial height in pixels of the map widget image.
WAITIMAGE: The image to use for showing ongoing progress
WAITIMAGEWIDTH: The width in pixels of the wait image.
WAITIMAGEHEIGHT: The height in pixels of the wait image.

Form Elements:

NAV_INPUT_TYPE: the type of the last navigation command, either POINT or RECTANGLE
NAV_INPUT_COORDINATES: the coordinates that the last command generated. May be a single point, or two points representing a rectangle
MAP_EXTENTS_MINX: The minimum X of the map in geographic coordinates
MAP_EXTENTS_MINY: The minimum Y of the map in geographic coordinates
MAP_EXTENTS_MAXX: The maximum X of the map in geographic coordinates
MAP_EXTENTS_MAXY: The maximum Y of the map in geographic coordinates
MAP_WIDTH: The width of the map window in pixels
MAP_HEIGHT: The height of the map window in pixels
MAP_CURSOR_POS_X: The current X position of the cursor over the map
MAP_CURSOR_POS_Y: The current Y position of the cursor over the map
NAV_CMD: The last command that was used to interact with the map

Javascript Functions:

MapWsetZoomBoxSettings(): set the parameters for a user-resizable box that can be used for zooming or querying.
MapWhandleresize(): callback function for the user resizing the page.
MapWchkMouseUp(): handle the user releasing the mouse button
MapWPointNavigation(): submit the current page with a single point for navigation
MapWmapTool(): handle the user pressing a mouse button.
MapWgetImageXY(): return the XY coordinates of an image on the page.
MapWgetMouse(): Get the current position of the mouse..
MapWinsideMap(): return true if a point is inside the map area
MapWstartZoomBox(): put the map widget into Zoom Box mode.
MapWstopZoomBox(): end Zoom Box mode
MapWsetClip(): set the clipping parameters for a DHTML layer
MapWCreateDHTMLLayers(): initializes the DHTML layers required by the Map widget.
MapWidgetInitVariables(): initialization function for the map widget variables.

Javascript Variables:

gMapWvspcIEadjust: track if IE is in use and adjust the location of layers accordingly
gMapWhspcIEadjust: track if IE is in use and adjust the location of layers accordingly.
gMapWiWidth: the width of the map widget window
gMapWiHeight: the height of the map widget window
gMapWhspc: the horizontal adjustment to apply to the layers.
gMapWvspc: The vertical adjustment to apply to the layers
gMapWmouseX: the X coordinate of the current mouse position
gMapWmouseY: the Y coordinate of the current mouse position
gMapWx1: The X coordinate of the first corner of the zoom box
gMapWy1: The Y coordinate of the first corner of the zoom box
gMapWx2: The X coordinate of the second corner of the zoom box
gMapWy2: The Y coordinate of the second corner of the zoom box
gMapWfirstx: track the first X coordinate clicked
gMapWfirsty: track the first Y coordinate clicked
gMapWsecondx: the second X coordinate clicked
gMapWsecondy: the second Y coordinate clicked
gMapWzleft: the location of the left layer of the zoom box.
gMapWzright: The location of the right layer of the zoom box
gMapWztop: The location of the top layer of the zoom box
gMapWzbottom: The location of the bottom layer of the zoom box.
gMapWmapX: the X coordinate of the map widget
gMapWmapY: the Y coordinate of the map widget
gMapWdragging: track the state of the map widget drag function
gMapWtoplayer: the top edge of the zooming box
gMapWleftlayer: The left edge of the zooming box
gMapWbottomlayer: the bottom edge of the zooming box
gMapWrightlayer: the right edge of the zooming box

mapimagesharedresource

Description:

This widget display a simple non navigable map with point taken from a shared resource on it.

Tag:

Attributes:

The mapimagesharedresource tag has attributes from the attributes from the Base Attributes group plus the following attributes:

WAITIMAGE: The image to use for showing ongoing progress
WAITIMAGEWIDTH: The width in pixels of the wait image.
WAITIMAGEHEIGHT: The height in pixels of the wait image.
BORDER: The border width to display around the image.
ID: An optional id for the static map image.
SRS: The projection that the static map image is to be displayed in.
MINX: The minimum X extent of the static map image
MINY: The minimum Y extent of the static map image
MAXX: The maximum X extent of the static map image
MAXY: The maximum Y extent of the static map image
WIDTH: The width in pixels of the map width image.
HEIGHT: The initial height in pixels of the map widget image.
ALLOWRESIZE: This gives the ability to resize the map from the URL.
NAVIGABLE: If set to true, the map will be html clickable, otherwise the map will be a plain image. Only usefull when adding navigation widget or using the queryable option.
TRANSPARENT: Set if there will be transparency in the map.
IMAGETYPE: The type of the image to display the scalebar as.
AUTOEXTENT: If true, the widget will calculate and set the extent of the map from the list of points.
AUTOEXTENTBUFFER: This force the buffer around all points. For instance if you always want to have a 5 km border around the map, you can set this value to something equivalent in degree.
MINAUTOEXTENTBUFFER: This is the minimum buffer value when the AutoExtent is set to true. This can be usefule when the widget zoom to only one point. If the extent of the map is below that value (in degree), the extent will be ajusted to that minimum value.
QUERYABLE: If true, when the user will click on a point, the Event "PointClicked" will be processed. Note that this functionality require the navigable attribute setted to TRUE.
POINTQUERYFIELD: If setted, the value from the field(s) specified will be passed in the URL in the form variables contained in PointQueryFormVar. There can be more than one, separated by commas, but the number of value and the order must match the order in PointQueryFormVar. This require the Queryable and PointQueryPoints parameters setted to TRUE.
POINTQUERYFORMVAR: If setted, this form variable will be set with the value from the field in PointQueryField. There can be more than one, separated by commas, but the number of value and the order must match the order in PointQueryField. This require the Queryable and PointQueryPoints parameters setted to TRUE.
POINTQUERYPOINTS: This is the POINTS list that will be queried. This require the Queryable parameter setted to TRUE.
POINTQUERYTOLERANCE: This the width and height in pixels that will be checked to see if the user click on a point. This require the Queryable parameter set to TRUE and PointQueryPoints parameters set to the correct shared resource name.
SYMBOLOVERLAP: If false, the points will not overlap each other. Internally, this option will create an annotation layer instead of a point layer and will use the labelcache option of mapserver with a default buffer of 2.

Form Elements:

sid: No description available.
NAV_INPUT_TYPE: the type of the last navigation command, either POINT or RECTANGLE

Javascript Functions:

LoadMap(oLayer, szParam)(): Cause a

Javascript Variables:

bPageLoaded: No description available.

mapimagestatic

Description:

This widget display a simple non navigable map

Tag:

Attributes:

The mapimagestatic tag has attributes from the attributes from the Base Attributes group.

Form Elements:

sid: No description available.
NAV_INPUT_TYPE: the type of the last navigation command, either POINT or RECTANGLE

Javascript Functions:

LoadMap(oLayer, szParam)(): Cause a

Javascript Variables:

bPageLoaded: No description available.

mapsize

Description:

The MapSize widget displays a widget that allows the user to specify new dimensions for the map image. Note that the MapDHTML widget must have ALLOWRESIZE set to true for this to have any effect.

Tag:

Attributes:

The mapsize tag has attributes from the Base Attributes, Popup Attributes, and Text Button Attributes groups.

Form Elements:

SET_MAP_WIDTH: The new map width in pixels when changing the map window size
SET_MAP_HEIGHT: The new map height in pixels when changing the map window size

Javascript Functions:

clickMapSizePopup(): callback function for the user clicking the Map Size button
applyMapSize(): set the map size.
cancelMapSize(): callback function when the user cancels changing the mapsize so the selection can be reset.
getMapSize(): return the size of the map in pixels
changeMapSize(): Callback function when the user has selected a new mapsize from the combo box on the page..

Javascript Variables:

None

maptips

Description:

The MapTips widget allows users to show dynamic or static maptips (tooltips) containing information pertinent to their application. The widget relies on an array of data stored as a Shared Resource. It will create an imagemap from the query results and place js to handle the dhmtl

Tag:

Attributes:

The maptips tag has attributes from the Base Attributes, Icon Attributes, Label Attributes, and Button Attributes groups plus the following attributes:

LAYERTYPE: No description available.
DEFAULTTEXT: No description available.
WIDTH: No description available.
HEIGHT: No description available.
XOFFSET: No description available.
YOFFSET: No description available.
TOLERANCE: No description available.
BGCOLOR: No description available.
BORDERCOLOR: No description available.
ALHPA: No description available.
LINK: No description available.
LINKURL: No description available.
LINKUNIQUEID: No description available.
PIXELX: No description available.
PIXELY: No description available.
STATUS: No description available.
SHAREDRESOURCE: No description available.

Form Elements:

SHOW_MAPTIPS: No description available.

Javascript Functions:

SetMapTipsStatus(): No description available.

Javascript Variables:

None

mapunits

Description:

The MapUnits widget displays the current map units as a label on the page.

Tag:

Attributes:

The mapunits tag has attributes from the Base Attributes, and Label Attributes groups plus the following attributes:

WIDGETCLASS: The CSS class to control the style of the map units HTML INPUT text box. The default is CWCMapUnitClass.
WIDGETSTYLE: The CSS style to control the style of the map units HTML INPUT text box. The default is none.

Form Elements:

sid: No description available.

Javascript Functions:

None

Javascript Variables:

None

owtchart

Description:

OWTChartWidget is a widget that build a OWTChart url with specified parameters.

Tag:

Attributes:

The owtchart tag has attributes from the attributes from the Base Attributes group plus the following attributes:

SHAREDRESOURCENAME: No description available.
CHARTTYPE: No description available.
VALS: No description available.
WIDTH: No description available.
HEIGHT: No description available.
BGCOLOR: No description available.
TRANSBG: No description available.
LINECOLOR: No description available.
GRID: No description available.
GRIDCOLOR: No description available.
IMAGETYPE: No description available.
JPEG_QUALITY: No description available.
3D: No description available.
3DDEPTH: No description available.
3DANGLE: No description available.
PLOTCOLOR: No description available.
SETCOLORS: No description available.
EXTCOLORS: No description available.
VOLCOLOR: No description available.
TITLE: No description available.
RTITLE: No description available.
LTITLE: No description available.
TITLECOLOR: No description available.
TITLEFONT: No description available.
XAXIS: No description available.
XTITLE: No description available.
XTITLEFONT: No description available.
XTITLECOLOR: No description available.
XLABELS: No description available.
XLABELFONT: No description available.
XLABELCOLOR: No description available.
XLABELSPACING: No description available.
YAXIS: No description available.
YSCALETYPE: No description available.
YMIN: No description available.
YMAX: No description available.
YTITLE: No description available.
YTITLEFONT: No description available.
YTITLECOLOR: No description available.
YLABELFONT: No description available.
YLABELCOLOR: No description available.
YAXIS2: No description available.
YMIN2: No description available.
YMAX2: No description available.
YTITLE2: No description available.
YTITLE2COLOR: No description available.
YLABEL2FONT: No description available.
YLABELFMT: No description available.
YLABEL2FMT: No description available.
PIEPCTTYPE: No description available.
PIEPCTFMT: No description available.
PIERADIUS: No description available.
PIELABELFONT: No description available.
STACKTYPE: No description available.
BARWIDTH: No description available.
BARLABELS: No description available.
BARLABELFMT: No description available.
LINESTYLES: No description available.
HLCSTYLE: No description available.
HLCCAPWIDTH: No description available.

Form Elements:

sid: No description available.

Javascript Functions:

None

Javascript Variables:

None

panmap

Description:

The PanMap widget is a navigation tool that allows the user to drag the map image to recenter it at a given location.

Tag:

Attributes:

The panmap tag has attributes from the Base Attributes, Icon Attributes, and Button Attributes groups plus the following attributes:

DEFAULT: Controls whether this widget is the default selected navigation tool.
WIDGETSTYLE: From NavTool, this is the CSS class to control the style of the pan image tag. Default is none.
MAPID: The ID of the map to which this widget should apply its navigation.

Form Elements:

NAV_CMD: The last command that was used to interact with the map
NAV_ALLOW_RECTANGLE: Tracks whether the current navigation tool uses a rubber-banding box or not.

Javascript Functions:

setCurrentTool(): set the currently active tool from a group of tools
flipToolState(): toggle the state of a tool button
registerTool(): used to register a tool in the page
onButtonOver(): callback when the mouse moves over a button
onButtonOut(): callback when the mouse leaves a button
onButtonClick(): callback when a button is clicked.
NavSetActiveTool(): set the active navigation tool for a particular group of tools
PanMapWInit(): initialize the Drag - Pan tool
PanMapWMouseMove(): handle the user moving the mouse
PanMapWMouseUp(): handle the user pressing the mouse button.
PanMapWMouseDown(): handle the user pressing the mouse button
PanMapWDragEnd(): stop drag-panning the map
PanMapWDragStart(): start dragging the map

Javascript Variables:

aToolGroups: array used to manage groups of tools on the page.
aTools: array of tools on the page.
gnPanWFirstPointX: the X coordinate of the point at which the drag pan started
gnPanWFirstPointY: the Y coordinate of the point at which the drag pan started

printwidget

Description:

The PrintPopup widget displays a popup dialog that allows the user to create a printable version of the map with some additional cartographic annotations.

Tag:

Attributes:

The printwidget tag has attributes from the Base Attributes, Popup Attributes, and Text Button Attributes groups plus the following attribute:

TEMPLATE: The path to a legend template file that controls the styling of the legend in the printed map.

Form Elements:

sid: No description available.

Javascript Functions:

clickPrintPopup(): callback function for the user clicking the Print button

Javascript Variables:

None

projectionlabel

Description:

The ProjectionLabel widget displays the name of the current projection from those defined in a common resource called "projection". The structure of the common resource is: <projection name="human name" srs="epsg code"/>. This structure is shared with the projection selector widget if used.

Tag:

Attributes:

The projectionlabel tag has attributes from the Base Attributes, and Label Attributes groups plus the following attributes:

WIDGETCLASS: The CSS class to control the style of the projection label text. The default is CWCProjectionLabelWidgetClass.
WIDGETSTYLE: The CSS style to control the style of the projection label text. The default is none.
TEXTFIELDSIZE: The size in characters to make the projection label input when in JSAPI mode.

Form Elements:

sid: No description available.

Javascript Functions:

None

Javascript Variables:

None

projectionselector

Description:

The ProjectionSelector widget allows the user to select a new projection for the current context from those defined in a common resource called "projection". The structure of the common resource is: <projection name="human name" srs="epsg code"/>. This structure is shared with the projection label widget if used.

Tag:

Attributes:

The projectionselector tag has attributes from the Base Attributes, Popup Attributes, and Text Button Attributes groups.

Form Elements:

MAP_PROJECTION: The current projection of the map.

Javascript Functions:

clickProjectionSelectorPopup(): callback for the user clicking the projection selection button
applyProjection(): callback to apply a change in projection.
getProjectionList(): return the list of projections that can be used in this application.
getCurrentProjection(): return the current projection of the map.

Javascript Variables:

None

query

Description:

The Query widget displays a GetFeatureInfo query result for each visible layer at the point the user clicks.

Tag:

Attributes:

The query tag has attributes from the Base Attributes, Icon Attributes, Popup Attributes, and Button Attributes groups plus the following attributes:

DEFAULT: Controls whether this widget is the default selected navigation tool.
WIDGETSTYLE: From NavTool, this is the CSS class to control the style of the pan image tag. Default is none.
MAPID: The ID of the map to which this widget should apply its navigation.
RADIUS: The number of pixels to search around the clicked location for features. This is a CubeWerx-specific extension to the current WMS GetFeatureInfo request and may not be supported by all servers, althought it should at least be ignored. The default is 3.
MAXFEATURES: The number of features to limit a GetFeatureInfo response to. This is the limit for each layer, it is not cumulative. This is a CubeWerx-specific extension to the WMS GetFeatureInfo request and may not be supported by all servers, although it should be at least ignored. The default is 5.

Form Elements:

NAV_CMD: The last command that was used to interact with the map
NAV_ALLOW_RECTANGLE: Tracks whether the current navigation tool uses a rubber-banding box or not.

Javascript Functions:

setCurrentTool(): set the currently active tool from a group of tools
flipToolState(): toggle the state of a tool button
registerTool(): used to register a tool in the page
onButtonOver(): callback when the mouse moves over a button
onButtonOut(): callback when the mouse leaves a button
onButtonClick(): callback when a button is clicked.
NavSetActiveTool(): set the active navigation tool for a particular group of tools
QueryWMouseClick(): handle the user clicking the mouse on the map.
QueryWMouseMove(): handle the user moving the mouse over the map.

Javascript Variables:

aToolGroups: array used to manage groups of tools on the page.
aTools: array of tools on the page.

quickzoom

Description:

The QuickZoom widget defines a list of known extents with human-readable names that the user can select to zoom to quickly. The format for the sub-tags is: <view name="Human Name" minx="-2200000" miny="-712631" maxx="3072800" maxy="3840000" SRS="epsg:42304"/> where the SRS is the projection that the coordinates are defined in. There may be any number of views defined.

Tag:

Attributes:

The quickzoom tag has attributes from the Base Attributes, and Label Attributes groups plus the following attribute:

TITLE: The text to display when nothing is selected.

Form Elements:

NAV_QUICKZOOM: the coordinates to zoom to from the quickzoom widget
SEL_QUICKZOOM: A copy of the currently selected quickzoom value

Javascript Functions:

changeQuickZoom(): callback function for handling the user selecting a new entry in the QuickZoom selector

Javascript Variables:

None

roimanager

Description:

The ROIManager widget allows the user to draw multiple ROIs

Tag:

Attributes:

The roimanager tag has attributes from the attributes from the Base Attributes group plus the following attributes:

MODE: The default mode in which the ROI manager will start when the application is started. The mode can be changed at run time by
EDGECOLOR: The (hex) color to render the edges of the ROI as it is being drawn. The edge is (normally) drawn without transparency, but that depends on the tool that does the drawing.
EDGEWIDTH: The width in pixels to draw the edge of the ROI. The edge is (normally) drawn without transparency, but that depends on the tool that does the drawing.
FILLCOLOR: The (hex) color to fill the ROI with, if a fill is desired.
FILLOPACITY: The opacity of the ROI fill, a percent between 0 and 100. 0 is fully transparent and 100 is fully opaque.
FILLROI: A boolean value to determine if the ROI should be drawn with a fill or not. This currently only affects the ROI as it is being drawn.

Form Elements:

sid: No description available.
ROI_MODE: The current mode of the ROI manager.

Javascript Functions:

ROIManagerInit(): Called during page load to initialize the javascript ROI manager.
ROIManagerCreateDHTMLLayers(): Creates the DHTML layers used by the ROI manager to display the current ROI selection.

Javascript Variables:

gROIRenderer: The URL to use to render an ROI

roimanagermode

Description:: The ROIManagerMode widget allows the user to set the current mode of the ROI Manager.
Tag:: <CWC2 NAME="[string]" TYPE="ROIMANAGERMODE" VISIBLE="[TRUE|FALSE]" ENABLED="[TRUE|FALSE]"