Javascript API

Modified on Monday, 21 December 2015 02:30 PM by 156.75.186.96 Categorized as Javascript
The Javascript API allows applications to embed an application built on the GIS framework directly into their application and to interact with it to perform various tasks. To use the framework the following scripts must be loaded on the page: 
*[^http://jquery.com/|jQuery (version 1.4.3 or greater)] 
*Silverlight.js 
*map.js

These scripts can be referenced directly from the GISFramework website with the following URLs: 

*[^http://tlbstws3.dot.state.fl.us/GISFramework/scripts/jquery-1.4.3.min.js] 
*[^http://tlbstws3.dot.state.fl.us/GISFramework/silverlight.js] 
*[^http://tlbstws3.dot.state.fl.us/GISFramework/scripts/map.js]

You can also reference the all in one package:

*[^http://tlbstws3.dot.state.fl.us/GISFramework/scripts/all.js]

If your site already uses jQuery, load the map scripts in "'''no conflict mode'''" using the following url:

*[^http://tlbstws3.dot.state.fl.us/GISFramework/scripts/all.js?jqnoconflict=true]

The Javascript API has the following functions available: 
{| class="tablesorter"
! Name !! Description
|-
| [MapCreate|FDOT.Map.create] || The create method creates the map object on the page and configures it for use. The onReady callback is executed once the map has completed its initialization.
|-
| [MapDestroy|FDOT.Map.destroy] || The destroy method removes a configured map from the page.
|-
| [ExecuteCommand|FDOT.Map.executeCommand] || Executes a framework command using the specified parameters and the id for a callback to invoke on command completion.
|-
| [ExecuteComponent|FDOT.Map.executeComponent] || Executes a named component.  This is intended for use in embedded mode where a component is needed without having to show the component toolbar.
|-
| [SelectPoint|FDOT.Map.selectPoint] || The selectPoint method enables geometry selection mode for the map. Once the user clicks a point on the map, the callback function will be executed, passing in the selected geometry.
|-
| [SelectPolyline|FDOT.Map.selectPolyline] || The selectPoint method enables geometry selection mode for the map. Once the user clicks a point on the map, the callback function will be executed, passing in the selected geometry.
|-
| [SelectBox|FDOT.Map.selectBox] || The selectBox method enables geometry selection mode for the map. Once the user completes their selection on the map, the callback function will be executed, passing in the selected geometry. 
|-
| [SelectCircle|FDOT.Map.selectCircle] || The selectCircle method enables geometry selection mode for the map. Once the user completes their selection on the map, the callback function will be executed, passing in the selected geometry.
|-
| [SelectPolygon|FDOT.Map.selectPolygon] || The selectPolygon method enables geometry selection mode for the map. Once the user completes their selection on the map, the callback function will be executed, passing in the selected geometry. 
|-
| [CancelGeometrySelection|FDOT.Map.cancelGeometrySelection] || The cancelGeometrySelection method ends geometry selection mode for the map if a geometry selection was in progress.
|-
| [SetProperty|FDOT.Map.setProperty] || Sets a named property in Silverlight's isolated storage using the framework's client-side caching support.  This can be used for storing application-specific information or modifying framework settings.  For example, setProperty('DoPersistCache', 'true') enables client-side caching of query results.
|-
| [GetProperty|FDOT.Map.getProperty] || Returns the named property from Silverlight's isolated storage using the framework's client-side caching support.
|-
| [AddExtentChangedHandler|FDOT.Map.addExtentChangeHandler] || Adds handler when the extent changes on the map.
|-
| [AddFeatureSelectionChangeHandler|FDOT.Map.addFeatureSelectionChangeHandler] || Adds handler when the feature on the map is selected.
|-
| [AddVisibleLayersChangeHandler|FDOT.Map.addVisibleLayersChangeHandler] || Adds handler when the visible layers are changed.
|-
| [getQueryableLayers|FDOT.Map.getQueryableLayers] || Gets the list of queryable layers for the map.
|-
| [GetVisibleLayers|FDOT.Map.getVisibleLayers] || Gets the list of visible layers for the map.
|}

[ExistingCommands|See Also Existing ScriptableCommands]

==See Also==
{Incoming}
Meta Keywords:
Meta Description:
Change Comment:
FDOT Wiki

GisFramework¶

Javascript API
