Reusable Accessible Mapping PlatformMap Class
Map class represents the ESRI map object. The map is generated based on the application configuration and templates.
Item Index
Methods
- _getSymbolConfig
- _hideLoadingImg
- _initEventHandlers
- _initListeners
- _initRepublishers
- _initScale
- _showLoadingImg
- _updateScale
- AddStaticLayer
- checkBoundary
- createExtent
- getFeatureLayer
- getLayerConfig
- getServiceURL
- getSymbolForFeature
- getVisibleFeatureLayers
- init
- initListeners
- initTopics
- loadStrings
- onFeatureDeselect
- onFeatureMouseOut
- onFeatureMouseOver
- onFeatureSelect
- republish
- setBoundingBoxVisibility
Methods
_getSymbolConfig
-
layerUrl -
wmsName
Gets the defined symbology from a layer's web service
Parameters:
Returns:
The defined symbology from the layer definition
_hideLoadingImg
()
private
Hides the loading image.
_initEventHandlers
-
map
Creates event handlers for the map control: click, mouse-over, load, extent change, and update events.
Parameters:
-
mapObjectA ESRI map object
_initListeners
-
map
Subscribe to external events (published using topic.publish) and react accordingly
Parameters:
-
mapObjectmap object
_initRepublishers
-
map
Republishes map events to the outside using topic.publish
Parameters:
-
mapObjectobject
_showLoadingImg
()
private
Shows the loading image.
AddStaticLayer
-
layer_type -
layer_url -
layer_op
Add a static, non-interactive Layer to the map
checkBoundary
-
e -
maxExtent
Given an ESRI Extent Object, returns a new ESRI Extent Object that contains the extent adjusted according to this map's maximum extent
NOTE: this method is currently unused!
Parameters:
-
eEsri/geometry/Extentthe extent Object
-
maxExtentEsri/geometry/Extentthe maximum extent
Returns:
An adjusted extent, if the target extent is outside the boundary
createExtent
-
extentConfig -
sr
Instantiates an extent from a JSON config object and spatial reference
Parameters:
-
extentConfigObjectthe JSON config object
-
srEsri/SpatialReference
Returns:
An ESRI extent object based on the config data
getFeatureLayer
-
featureUrl
Return the feature layer corresponding to the given url.
Parameters:
-
featureUrlStringthe url of the feature layer
Returns:
feature layer
getLayerConfig
-
url -
wmsName
Returns the feature layer config for the given url
getServiceURL
-
rampService -
mapID -
language
This method builds a complete service URL callout for a map configuration. The URL is built using a base URL and map ID, and a language culture code.
getSymbolForFeature
-
feature
Given a feature object or a graphic object (or any object that has a getLayer method and an attributes field) return the object containing the image URL and legend text for that feature/graphic object.
Parameters:
-
featureObject
Returns:
The default icon used to represent the feature layer
getVisibleFeatureLayers
()
Array
Returns a list of feature layers that are currently visible on the map.
Returns:
an array of Esri/layer/FeatureLayer objects
init
-
currentLevel
Initialize navigation widget for pan and zooming using global configuration object
Parameters:
-
currentLevelNumber
initListeners
()
private
Listen to map evens and adjust the navigation widget accordingly
initTopics
()
private
Listen to internal events and republish for other modules' benefit
loadStrings
()
Updates some of the Strings on the HTML page using the config string resources
onFeatureDeselect
()
This function is called whenever the "Details" button is deselected (either by the user click on another "Details" button, clicking on another point, or by clicking on an already highlighted "Details" button, or clicking somewhere on the map where is no features present).
onFeatureMouseOut
-
evt
This function is called whenever the user moves the mouse away from a feature being hovered over.
onFeatureMouseOver
-
evt
This function is called whenever the user hovers over a feature on the map when another feature already has been selected.
onFeatureSelect
-
evt
This function is called whenever the feature on the map is clicked/selected by the user. Publish the "Gui/subPanelOpen" message to indicate a feature has been selected. Panel content and Panel event handler information is passed in as the additional object for the event handler.
setBoundingBoxVisibility
-
layerId
Sets the visibility of the bounding box that belongs to the layer with the given layerId. Note: the layerId needs to be the ID of the featurelayer, not the ID of the actual bounding box layer.
Parameters:
-
layerIdStringthe id of the layer whose bounding box visibility should be set
Properties
boundingBoxLayers
Array of esri/layer/GraphicsLayer
A list GraphicsLayer that represent the extent bounding box of the feature layers. {[esr/layer/featurelayers]} featureLayers A list of feature layers found in the application config {[esri/layer/graphiclayer]} An array of graphic layers to add to the map
boundingBoxMapping
Object
private
Maps the id of a graphic layer to the GraphicsLayer Object that represents its extent bounding box. A dictionary of String, Esri/layer/GraphicsLayer pairs.
config
Object
The RAMP application config, it should be treated as read only by all modules other than globalStorage and bootstrapper
configServiceURL
String
Contains a URL that points to the application configuration (JSON format) if it's hosted on a web service. This is not required if the application has a JSON config file in the website's folder
featureLayerStartIndex
Integer
private
The map not only contains feature layers, but also other layers such as the basemap layer, highlight layer, bounding box layer, etc. This variable is used to store the starting index of the feature layers in the map.
fullExtent
Esri/geometry/Extent
private
Used for full extent in nav widget
InitExtent
Esri/geometry/Extent
private
The initial extent of the map
maxExtent
Esri/geometry/Extent
private
The maximum extent of the map
plugins
Object
A registry of plugins for RAMP code to reference, these should be loaded and registered by bootstrapper.js