Moxi Media Inc.
Button and Tool Examples Discussion Forum

IMF Developer's Guide » Button and Tool Examples  

This document provides example configuration snippets for standard buttons and tools. This is by no means a complete listing of all button and tool capabilities of the IMF. You can easily add new buttons and tools using handlers that you write and images from the Tool Image Gallery or images in your own application directory.

This is not a complete list. A sample set of tools that you can paste into your configuration file is at the bottom of this page.

Space: Add spacing between your buttons and tools
A space can be added anywhere in the toolbar using the following: 
<space width="10"/>
or just: 
<space/>

Button: BC Extent
This button can be added to your web site to perform an extent change to show the entire Province of BC. Note that this button could be changed to zoom to any extent. 

<button name="BC Extent"
        url="JavaScript:zoomToExtent(199960,331657,1874985,1745737);"
        target="mapFrame"
        hint="BC Extent"
        status="Zoom out so you can see the whole province of BC."
        graphic="$FRAMEWORK/tools/zoombc.gif"
        width="16" height="16" />

Button: Clear

This button displays a document to allow individual clearing of selected sets or user graphics. 

<button name="Clear"
        url="$FRAMEWORK/imfClear.jsp"
        target="dataFrame"
        hint="Clear Selection"
        status="Unselects features and clears user added graphics."
        help="$FRAMEWORK/help/clearButton.txt"
        graphic="$FRAMEWORK/tools/clearhighlight_1.gif"
        width="16" height="16" />

Button: Email
This script displays the form to send the map to someone by e-mail. The script has two optional arguments, subject and mailto to specify default values: 

<button name="Email"
        url="$FRAMEWORK/imfEmailButton.jsp"
        target="dataFrame"
        hint="Email"
        help="$FRAMEWORK/help/emailButton.txt"
        status="Send this map to someone by e-mail."
        graphic="$FRAMEWORK/tools/mail_1.gif"
        width="16" height="16" />

Button: Full Extent
This tool zooms to the full extent of the map. 

<button name="Full Extent"
        url="JavaScript:fullExtent();"
        target="mapFrame"
        hint="Full Extent"
        status="Zoom to the full extent of this map."
        help="$FRAMEWORK/help/fullExtentButton.txt"
        graphic="$FRAMEWORK/tools/zoomfull.gif"
        width="16" height="16" />

Button: Grid Markup
This button displays a form for the user to enter a grid size that puts a grid on the map. 

<button name="Grid Markup" 
        url="$FRAMEWORK/imfGridMarkupForm.jsp"
        target="dataFrame"
        hint="Grid Markup"
        status="Adds a user defined grid to the map."
        help="$FRAMEWORK/help/markupGridButton.txt"
        graphic="$FRAMEWORK/tools/markup_grid1.gif"
        width="18" height="18"/>

Button: Index Map
This script displays the index map document. There are no arguments to this script. 

<button name="Overview Map"
        url="$FRAMEWORK/imfIndexMapCrosshair.jsp"
        target="dataFrame"
        hint="Overview Map"
        help="$FRAMEWORK/help/indexMapButton.txt"
        status="Displays an overview map showing the location of the map in the main window."
        graphic="$FRAMEWORK/tools/toggleov.gif"
        width="16" height="16"/>

Button: Navigation Map
This script works as a toggle. When the navigation map is active, a simple map will be displayed to allow quick navigation to the desired location. The simple map is specified as arguments for the script. The following is an example of how to set a button to use this script: 

<button name="Navigation Map"
        url="$FRAMEWORK/imfNavigateMap.jsp?server=myserver&service=mymap"
        target="hiddenFrame"
        hint="Navigation Map"
        status="Displays a navigation map for quick-refreshing navigation."
        graphic="$FRAMEWORK/tools/resize_1.gif"
        width="16" height="16" />

Button: Print Map Template (using print configuration XML file)
This script opens a document to create a printable map in PDF format. There are no arguments to this script. 

<button name="Print"
        url="$FRAMEWORK/imfPrintMapTemplateForm.jsp"
        target="dataFrame"
        hint="Print"
        status="Creates a scaled map document that you can save or print."
        help="$FRAMEWORK/help/printMapButton.txt"
        graphic="$FRAMEWORK/tools/print_1.gif"
        width="16" height="16" />

Button: Print Scaled Map
This script opens a document to create a printable map in PDF format. There are no arguments to this script. 

<button name="Print"
        url="$FRAMEWORK/imfPrintScaledMapForm.jsp"
        target="dataFrame"
        hint="Print"
        status="Prints a scaled map on your printer."
        help="$FRAMEWORK/help/printMapButton.txt"
        graphic="$FRAMEWORK/tools/print_1.gif"
        width="16" height="16" />

Button: Print Scaled ArcMap Template
This script opens a document to create a high resolution printable map in PDF format using an ArcMap template. There are no arguments to this script. 

<button name="Print"
        url="$FRAMEWORK/imfPrintScaledArcMapForm.jsp"
        target="dataFrame"
        hint="Print"
        status="Prints a scaled map on your printer."
        help="$FRAMEWORK/help/printMapButton.txt"
        graphic="$FRAMEWORK/tools/print_1.gif"
        width="16" height="16" />

Button: Save Session to IMF server
This script saves the session to a server file that can be restored later. There are no arguments to this script. 

<button name="Save Session"
        url="$FRAMEWORK/imfSessionSaveToServer.jsp"
        target="dataFrame"
        hint="Save Session"
        status="Saves the current map settings for you to restore later."
        graphic="$FRAMEWORK/tools/save_1.gif"
        width="16" height="16"/>

Button: Save Session to user's computer
This script creates a session file that the user can download so that the session can be restored later. If you use this button, you must also add a button to restore the session. Both XML snippets are listed below. 

<button name="Save Session"
        url="$FRAMEWORK/imfSessionSaveToClient.jsp"
        target="dataFrame"
        hint="Save Session"
        status="Saves the current map settings for you to restore later."
        graphic="$FRAMEWORK/tools/save_1.gif"
        width="16" height="16"/>
<button name="Open Session"
        url="$FRAMEWORK/imfSessionRestoreForm.jsp"
        target="dataFrame"
        hint="Open Session"
        status="Opens a project session that you have previously saved to your computer."
        graphic="$FRAMEWORK/tools/open_1.gif"
        width="16" height="16"/>

Button: Toolbox
This script is used to change the tools and associated help to a defined tool set. 

<button name="Other Tools"
        url="$FRAMEWORK/imfTools.jsp?toolset=mytools"
        target="toolFrame"
        hint="Other Tools"
        status="Shows another tool set."
        graphic="$FRAMEWORK/tools/tools_close.gif"
        width="16" height="16" />

Button: Zoom Previous
This tool returns the map to the previous extent. 

<button name="Zoom Previous"
        url="JavaScript:previousExtent();"
        target="toolFrame"
        hint="Zoom Previous"
        status="Zoom to the extent of this map before your last change."
        help="$FRAMEWORK/help/zoomPreviousButton.txt"
        graphic="$FRAMEWORK/tools/zoomlast.gif"
        width="16" height="16" />

Tool: Drill Down Identify
This tool calls an internal JavaScript routine, but can be set with options to specify that the routine should display feature data found in layers that are not visible or beyond the scale range for that layer. The default is to only show data from visible features. Note that there are also settings in the <layer> and <field> elements that affect the action of this routine. 

<tool name="Drill Down Identify"
      hint="Identify visible"
      options="showInvisible=false,showBeyondThreshold=false,window=false"
      status="Show information about features where you click the map."
      graphic="$FRAMEWORK/tools/drill_1.gif"
      active-graphic="$FRAMEWORK/tools/drill_2.gif"
      width="16" height="16" />

Tool: Identify
This tool displays the identify report for the active identify layer. The report returned depends on the settings of the layer. 

<tool name="Identify"
      hint="Identify"
      status="Display information about the feature that you click."
      graphic="$FRAMEWORK/tools/identify_1.gif"
      active-graphic="$FRAMEWORK/tools/identify_2.gif"
      width="16" height="16" />

Tool: Identify Radius
This tool displays the identify report for the active identify layer that are within the user-specified distance from the location clicked. The report returned depends on the settings of the layer. 

<tool name="Identify Radius"
      handler="$FRAMEWORK/imfIdentifyBuffer.jsp"
      hint="Identify Radius"
      status="Display information about features within a distance of where you click on the map."
      graphic="$FRAMEWORK/tools/identifyradius_1.gif"
      active-graphic="$FRAMEWORK/tools/identifyradius_2.gif"
      width="16" height="16" />

Tool: Location
This tool displays the geographic location of where you click the map. 

<tool name="Location"
      hint="XY Location"
      status="Display the coordinates where you click the map."
      graphic="$FRAMEWORK/tools/addmatch_1.gif"
      active-graphic="$FRAMEWORK/tools/addmatch_2.gif"
      width="16" height="16" />

Tool: Location
This tool displays the geographic location of where you click the map. 

<tool name="Location"
      hint="XY Location"
      status="Display the coordinates where you click the map."
      graphic="$FRAMEWORK/tools/addmatch_1.gif"
      active-graphic="$FRAMEWORK/tools/addmatch_2.gif"
      width="16" height="16" />

Tool: Measure
This tool displays the distance between points clicked by the user. Note: Works best with Internet Explorer. Consider leaving this tool out of your site if Netscape users are anticipated. 

<tool name="Measure"
      hint="XY Location"
      status="Measures the distance between points where you click."
      graphic="$FRAMEWORK/tools/measure_1.gif"
      active-graphic="$FRAMEWORK/tools/measure_2.gif"
      width="16" height="16" />

Tool: Measure Area
This tool displays the distance and area of a polygon by the user. Note: Works best with Internet Explorer. Consider leaving this tool out of your site if Netscape users are anticipated. 

<tool name="Measure Area"
      hint="Measure Area"
      status="Measures the area of the polygon you draw."
      graphic="$FRAMEWORK/tools/measurearea_1.gif"
      active-graphic="$FRAMEWORK/tools/measurearea_2.gif"
      width="16" height="16" />

Tool: Pan
This tool centers the map with a mouse click, or lets the user drag the map image to a new location. 

<tool name="Pan"
      hint="Pan"
      status="Center the map at the point you click or drag the map."
      graphic="$FRAMEWORK/tools/pan_1.gif"
      active-graphic="$FRAMEWORK/tools/pan_2.gif"
      width="16" height="16" />

Tool: Select
This tool highlights features and displays the select report for the active select layer. If the layer uses selected sets, a summary form is displayed instead. The report returned depends on the settings of the layer. 

<tool name="Select"
      hint="Select"
      status="Displays results for the features you select."
      graphic="$FRAMEWORK/tools/select_rect_1.gif"
      active-graphic="$FRAMEWORK/tools/select_rect_2.gif"
      width="16" height="16" />

Tool: Zoom In
This tool responds to a user mouse click or dragged envelope to zoom in. 

<tool name="Zoom In"
      hint="Zoom In"
      status="Zoom in to the point or rectangle that you specify."
      graphic="$FRAMEWORK/tools/zoomin_1.gif"
      active-graphic="$FRAMEWORK/tools/zoomin_2.gif"
      width="16" height="16" />

Tool: Zoom Out
This tool responds to a user click on the map to zoom out centered on the location clicked. 

<tool name="Zoom Out"
      hint="Zoom Out"
      status="Zoom out to the point you click."
      graphic="$FRAMEWORK/tools/zoomout_1.gif"
      active-graphic="$FRAMEWORK/tools/zoomout_2.gif"
      width="16" height="16" />

Button: Select by Buffer
This button is used to choose a selected set layer and view it's selection. 

<button name="Buffer"
        url="$FRAMEWORK/imfSelectByBufferForm.jsp"
        target="dataFrame"
        hint="Buffer"
        status="Select features within a distance of selected features."
        graphic="$FRAMEWORK/tools/buffer_1.gif"
        active-graphic="$FRAMEWORK/tools/buffer_2.gif"
        width="16" height="16" />

Button: Extract
This button is used choose an extract layer and create a shapefile set. 

<button name="Extract"
      url="$FRAMEWORK/imfExtractForm.jsp"
      target="dataFrame"
      hint="Extract"
      status="Extracts features to a shapefile that you can download"
      graphic="$FRAMEWORK/tools/zipship.gif"
      active-graphic="$FRAMEWORK/tools/zipship.gif"
      width="16" height="16" />

Example toolset: 

<tools toolset="default" active="Zoom In" help="$FRAMEWORK/imfHelp.jsp">
 <button name="Full Extent" url="JavaScript:fullExtent();" target="mapFrame" hint="Full Extent" help="$FRAMEWORK/help/fullExtentButton.txt" status="Zoom to the designed full extent of this map." graphic="$FRAMEWORK/tools/zoomfull.gif" width="16" height="16"/>
 <tool name="Zoom In" hint="Zoom In" help="$FRAMEWORK/help/zoomInTool.txt" status="Zoom in to the point you click or the rectangle that you specify." graphic="$FRAMEWORK/tools/zoomin_1.gif" active-graphic="$FRAMEWORK/tools/zoomin_2.gif" width="16" height="16"/>
 <tool name="Zoom Out" hint="Zoom Out" help="$FRAMEWORK/help/zoomOutTool.txt" status="Zoom out to the point you click or the zoom the window into an rectangle that you specify." graphic="$FRAMEWORK/tools/zoomout_1.gif" active-graphic="$FRAMEWORK/tools/zoomout_2.gif" width="16" height="16"/>
 <tool name="Pan" hint="Pan" help="$FRAMEWORK/help/panTool.txt" status="Centre the map at the point you click or drag the map." graphic="$FRAMEWORK/tools/pan_1.gif" active-graphic="$FRAMEWORK/tools/pan_2.gif" width="16" height="16"/>
 <button name="Zoom Previous" url="JavaScript:previousExtent();" target="toolFrame" hint="Zoom Previous" help="$FRAMEWORK/help/zoomPreviousButton.txt" status="Zoom to the extent of this map before your last extent change." graphic="$FRAMEWORK/tools/zoomlast.gif" width="16" height="16"/>
 <button name="Overview Map" url="$FRAMEWORK/imfIndexMapCrosshair.jsp" target="dataFrame" hint="Overview Map" help="$FRAMEWORK/help/indexMapButton.txt" status="Displays an overview map showing the location of the map in the main window." graphic="$FRAMEWORK/tools/toggleov.gif" width="16" height="16"/>
 <button name="Print" url="$FRAMEWORK/imfPrintScaledMapForm.jsp" target="dataFrame" hint="Print to PDF" help="$FRAMEWORK/help/printMapButton.txt" status="Prepares a scaled map in PDF format." graphic="$FRAMEWORK/tools/print_1.gif" width="16" height="16"/>
 <button name="Print ArcMap" url="$FRAMEWORK/imfPrintScaledArcMapForm.jsp" target="dataFrame" hint="Print to PDF" help="$FRAMEWORK/help/printMapButton.txt" status="Prepares a scaled map in PDF format." graphic="$FRAMEWORK/tools/print_1.gif" width="16" height="16"/>
 <button name="Email" url="$FRAMEWORK/imfEmailButton.jsp" target="dataFrame" hint="Email" help="$FRAMEWORK/help/emailButton.txt" status="Send this map to someone by e-mail." graphic="$FRAMEWORK/tools/mail_1.gif" width="16" height="16"/>
 <button name="Save Session" url="$FRAMEWORK/imfSessionSaveToServer.jsp" target="dataFrame" hint="Save Session" status="Saves the current map settings for you to restore later." graphic="$FRAMEWORK/tools/save_1.gif" width="16" height="16"/>
 <space/>
 <tool name="Drill Down Identify" hint="Identify visible" help="$FRAMEWORK/help/drillIdentifyTool.txt" status="Display information about the features for all the visible layers where you click the map." graphic="$FRAMEWORK/tools/drill_1.gif" active-graphic="$FRAMEWORK/tools/drill_2.gif" width="16" height="16"/>
 <tool name="Identify" hint="Identify" help="$FRAMEWORK/help/identifyTool.txt" status="Display information about the features that you can click the map." graphic="$FRAMEWORK/tools/identify_1.gif" active-graphic="$FRAMEWORK/tools/identify_2.gif" width="16" height="16"/>
 <tool name="Identify Radius" handler="$FRAMEWORK/imfIdentifyBuffer.jsp" hint="Identify Radius" status="Display information about features within a distance of where you click on the map." graphic="$FRAMEWORK/tools/identifyradius_1.gif" active-graphic="$FRAMEWORK/tools/identifyradius_2.gif" width="16" height="16"/>
 <tool name="Select" hint="Select" help="$FRAMEWORK/help/selectTool.txt" status="Display information about the features that you can click the map." graphic="$FRAMEWORK/tools/select_1.gif" active-graphic="$FRAMEWORK/tools/select_2.gif" width="16" height="16"/>
 <tool name="Buffer" handler="$FRAMEWORK/imfSelectByBufferForm.jsp" hint="Buffer" status="Select features within a distance of selected features." graphic="$FRAMEWORK/tools/buffer_1.gif" active-graphic="$FRAMEWORK/tools/buffer_2.gif" width="16" height="16"/>
 <tool name="Measure" hint="Measure Distance" options="units=feet" help="$FRAMEWORK/help/measureTool.txt" status="Measures the distance between points where you click." graphic="$FRAMEWORK/tools/measure_1.gif" active-graphic="$FRAMEWORK/tools/measure_2.gif" width="16" height="16"/>
 <tool name="Measure Area" hint="Measure Area" options="units=feet" help="$FRAMEWORK/help/measureAreaTool.txt" status="Measures the area of the polygon you draw." graphic="$FRAMEWORK/tools/measurearea_1.gif" active-graphic="$FRAMEWORK/tools/measurearea_2.gif" width="16" height="16"/>
 <space/>
 <tool name="Location" hint="XY Location" status="Display the location coordinates at the point you click on the map." graphic="$FRAMEWORK/tools/addmatch_1.gif" active-graphic="$FRAMEWORK/tools/addmatch_2.gif" width="16" height="16"/>
 <space/>
 <tool name="Point Markup" hint="Point Markup" shape="point" handler="$FRAMEWORK/imfMarkupToolPoint.jsp" status="Adds user-defined points to the map." help="$FRAMEWORK/help/markupPointTool.txt" graphic="$FRAMEWORK/tools/markup_point1.gif" active-graphic="$FRAMEWORK/tools/markup_point2.gif" width="18" height="18"/>
 <tool name="Line Markup" hint="Line Markup" shape="line" handler="$FRAMEWORK/imfMarkupToolLine.jsp" status="Adds user-defined lines to the map." help="$FRAMEWORK/help/markupLineTool.txt" graphic="$FRAMEWORK/tools/markup_line1.gif" active-graphic="$FRAMEWORK/tools/markup_line2.gif" width="18" height="18"/>
 <tool name="Rectangle Markup" hint="Rectangle Markup" shape="box" handler="$FRAMEWORK/imfMarkupToolRectangle.jsp" status="Adds user-defined rectangles to the map." help="$FRAMEWORK/help/markupRectangleTool.txt" graphic="$FRAMEWORK/tools/markup_rect1.gif" active-graphic="$FRAMEWORK/tools/markup_rect2.gif" width="18" height="18"/>
 <tool name="Polygon Markup" hint="Polygon Markup" shape="polygon" handler="$FRAMEWORK/imfMarkupToolPolygon.jsp" status="Adds user-defined polygon to the map." help="$FRAMEWORK/help/markupPolygonTool.txt" graphic="$FRAMEWORK/tools/markup_polygon1.gif" active-graphic="$FRAMEWORK/tools/markup_polygon2.gif" width="18" height="18"/>
 <tool name="TextMarkup" hint="Text Markup" shape="point" handler="$FRAMEWORK/imfMarkupToolText.jsp" status="Adds user-defined text to the map." help="$FRAMEWORK/help/markupTextTool.txt" graphic="$FRAMEWORK/tools/markup_text1.gif" active-graphic="$FRAMEWORK/tools/markup_text2.gif" width="18" height="18"/>
 <tool name="LabelMarkup" hint="Label Markup" shape="point" handler="$FRAMEWORK/imfMarkupToolLabel.jsp" status="Adds a label from the feature table of a layer to the map at the point you click." help="$FRAMEWORK/help/markupLabelTool.txt" graphic="$FRAMEWORK/tools/markup_label1.gif" active-graphic="$FRAMEWORK/tools/markup_label2.gif" width="18" height="18"/>
 <button name="Grid Markup" url="$FRAMEWORK/imfGridMarkupForm.jsp" target="dataFrame" hint="Grid Markup" status="Adds a user defined grid to the map." help="$FRAMEWORK/help/markupGridButton.txt" graphic="$FRAMEWORK/tools/markup_grid1.gif" width="18" height="18"/>
 <tool name="Erase Markup" hint="Erase Markup" shape="box" handler="$FRAMEWORK/imfMarkupToolErase.jsp" status="Removes user markup from the map using a point or a box." help="$FRAMEWORK/help/markupEraseTool.txt" graphic="$FRAMEWORK/tools/markup_erase1.gif" active-graphic="$FRAMEWORK/tools/markup_erase2.gif" width="18" height="18"/>
 <button name="Clear" url="$FRAMEWORK/imfClear.jsp" target="dataFrame" hint="Clear Selection" help="$FRAMEWORK/help/clearButton.txt" status="Unselects features and clears user added graphics." graphic="$FRAMEWORK/tools/clearhighlight_1.gif"/>
 <space/>
 <button name="Extract" url="$FRAMEWORK/imfExtractForm.jsp" target="dataFrame" hint="Extract" status="Extract data to a shapefile." graphic="$FRAMEWORK/tools/zipship.gif" width="16" height="16"/>
 <button name="Extract GML" hint="Extract GML" status="Creates a GML file containing features from a layer." help="$FRAMEWORK/help/extractGmlButton.txt" url="$FRAMEWORK/imfExtractGmlForm.jsp" target="dataFrame" graphic="$FRAMEWORK/tools/gml.gif" width="16" height="16"/>
 <button name="Extract Excel" hint="Extract Excel" help="$FRAMEWORK/help/extractExcel.txt" status="Creates an Excel file containing attributes from a layer." url="$FRAMEWORK/imfExtractExcelForm.jsp" target="dataFrame" graphic="$FRAMEWORK/tools/excel.gif" width="16" height="16"/>
</tools>