undefined

API Docs for: 5.4.0
Show:

Map Class

Uses
Defined in: src/js/RAMP/Modules/map.js:14
Module: Map
Parent Module: RAMP

Map class represents the ESRI map object. The map is generated based on the application configuration and templates.

Imports RAMP Modules:

GlobalStorage RAMP FeatureClickHandler MapClickHandler Navigation EventManager Util Array

Methods

_hideLoadingImg

() private

Defined in src/js/RAMP/Modules/map.js:128

Hides the loading image.

_initEventHandlers

(
  • map
)
private

Defined in src/js/RAMP/Modules/map.js:377

Creates event handlers for the map control: click, mouse-over, load, extent change, and update events.

Parameters:

  • map Object

    A ESRI map object

_initListeners

(
  • map
)
private

Defined in src/js/RAMP/Modules/map.js:186

Subscribe to external events (published using topic.publish) and react accordingly

Parameters:

_initRepublishers

(
  • map
)
private

Defined in src/js/RAMP/Modules/map.js:155

Republishes map events to the outside using topic.publish

Parameters:

_showLoadingImg

() private

Defined in src/js/RAMP/Modules/map.js:118

Shows the loading image.

_updateScale

(
  • event
)
private

Defined in src/js/RAMP/Modules/map.js:138

Update Map Scale when zoom level changes

Parameters:

AddStaticLayer

(
  • layer_type
  • layer_url
  • layer_op
)
private

Defined in src/js/RAMP/Modules/map.js:592

Add a static, non-interactive Layer to the map NOTE: this function is currently not being used.

Parameters:

  • layer_type String

    A value which controls how the layer is going to be added to the map

  • layer_url String

    A URL pointing to a valid map service endpoint

  • layer_op Number

    A value between 0.0 and 1.0 which determines the transparency of the layer

applyExtentDefaulting

() private

Defined in src/js/RAMP/Modules/map.js:962

Apply extent defaulting prior to URL overrides.

checkBoundary

(
  • e
  • maxExtent
)
Esri/geometry/Extent

Defined in src/js/RAMP/Modules/map.js:994

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:

  • e Esri/geometry/Extent

    the extent Object

  • maxExtent Esri/geometry/Extent

    the maximum extent

Returns:

Esri/geometry/Extent:

An adjusted extent, if the target extent is outside the boundary

enhanceLayer

(
  • layer
  • config
  • userLayer
)

Defined in src/js/RAMP/Modules/map.js:1153

Adds custom ramp properties to layer. Adds handlers to loading events.

Parameters:

  • layer Object

    layer to be prepped

  • config Object

    config object for the layer

  • userLayer Boolean

    optional. indicates if layer was added by a user. default value is false

finishExtentProjection

(
  • projectedMaxExtent
)
private

Defined in src/js/RAMP/Modules/map.js:576

process the projected maximum extent, then alert app to continue loading the map. used as an asynchronous gate for the projection.

Parameters:

  • projectedMaxExtent Array

    an array containing the maximum extent object in the map's projection

getBoundingBoxMapping

() Object

Defined in src/js/RAMP/Modules/map.js:940

Returns the mapping of feature layer ids to assocciated bounding box layers.

Returns:

Object:

A dictionary of String, Esri/layers/GraphicsLayer pairs.

getFeatureLayer

(
  • featureId
)
Esri/layers/FeatureLayer private

Defined in src/js/RAMP/Modules/map.js:950

Return the feature layer corresponding to the given id.

Parameters:

  • featureId String

    the id of the feature layer

Returns:

Esri/layers/FeatureLayer:

feature layer

getVisibleFeatureLayers

() Array

Defined in src/js/RAMP/Modules/map.js:901

Returns a list of feature layers that are currently visible on the map.

Returns:

Array:

an array of Esri/layers/FeatureLayer objects

layerInLODRange

(
  • maxScale
  • minScale
)

Defined in src/js/RAMP/Modules/map.js:823

For a specified layer, determine if the layer's scale fit into map LOD range. Return ture if in range

Parameters:

  • maxScale Number

    maximum scale.

  • minScale Number

    minimum scale

localProjectExtent

(
  • extent
  • sr
)
Esri/Extent private

Defined in src/js/RAMP/Modules/map.js:441

Will project an extent to a desired spatial reference, using client side projection library. Avoids the need for Esri Geometry Service

Parameters:

Returns:

Esri/Extent:

extent in the desired projection

localProjectExtent

(
  • extent
  • sr
)
Esri/Extent

Defined in src/js/RAMP/Modules/map.js:1166

Will project an extent to a desired spatial reference, using client side projection library. Avoids the need for Esri Geometry Service

Parameters:

Returns:

Esri/Extent:

extent in the desired projection

makeFeatureLayer

(
  • layerConfig
  • userLayer
)
Esri/layers/FeatureLayer

Defined in src/js/RAMP/Modules/map.js:1051

Create a new FeatureLayer object based on the config input

Parameters:

  • layerConfig Object

    config object for the layer to create

  • userLayer Boolean

    optional specifies if layer was added by a user

Returns:

Esri/layers/FeatureLayer:

feature layer object (unloaded)

makeStaticLayer

(
  • layerConfig
  • userLayer
)
Object private

Defined in src/js/RAMP/Modules/map.js:1101

Return the static layer corresponding to the given url.

Parameters:

  • layerConfig Object

    config object for the layer to create

  • userLayer Boolean

    optional specifies if layer was added by a user

Returns:

Object:

layer object of the appropriate type

makeWmsLayer

(
  • layerConfig
  • userLayer
)
Esri/layers/WMSLayer

Defined in src/js/RAMP/Modules/map.js:1071

Return the feature layer corresponding to the given url.

Parameters:

  • layerConfig Object

    config object for the layer to create

  • userLayer Boolean

    optional specifies if layer was added by a user

Returns:

Esri/layers/WMSLayer:

WMS layer

prepLayer

(
  • layer
  • config
  • userLayer
)
private

Defined in src/js/RAMP/Modules/map.js:715

Sets up loading event handlers and initializes the .ramp object of a layer Circular reference errors prevent us from calling LayerLoader directly from this module

Parameters:

  • layer Object

    layer to be prepped

  • config Object

    config object for the layer

  • userLayer Boolean

    optional. indicates if layer was added by a user. default value is false

projectConfigExtents

()

Defined in src/js/RAMP/Modules/map.js:981

initiate the projection of the config extents to basemap extents

projectExtent

(
  • extent
  • sr
  • callWhenDone
)
private

Defined in src/js/RAMP/Modules/map.js:502

project an extent to a new spatial reference, if required when projection is finished, call another function and pass the result to it.

Parameters:

projectFullExtent

(
  • projectedDefaultExtent
)
private

Defined in src/js/RAMP/Modules/map.js:544

process the projected default extent, begin projection of full extent. used as an asynchronous gate for the projection.

Parameters:

  • projectedDefaultExtent Array

    an array containing the default extent object in the map's projection

projectMaxExtent

(
  • projectedFullExtent
)
private

Defined in src/js/RAMP/Modules/map.js:560

process the projected full extent, begin projection of maximum extent. used as an asynchronous gate for the projection.

Parameters:

  • projectedFullExtent Array

    an array containing the full extent object in the map's projection

republish

(
  • name
)
private

Defined in src/js/RAMP/Modules/map.js:165

Republish map events using topic.publish

Parameters:

setBoundingBoxVisibility

(
  • layerId
)
private

Defined in src/js/RAMP/Modules/map.js:637

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:

  • layerId String

    the id of the layer whose bounding box visibility should be set

setLayerMode

(
  • config
)
Object private

Defined in src/js/RAMP/Modules/map.js:685

Sets up layer option object

Parameters:

  • config Object

    config object for the layer

Returns:

Object:

an options object with settings based on the config

zoomToLayerScale

(
  • layerId
)

Defined in src/js/RAMP/Modules/map.js:769

For a specified layer, zooms to the closest level that has some visible data.

Parameters:

  • layerId String

    a layer id to zoom to.

Properties

baseLayer

Esri/layers/ArcGISTiledMapServiceLayer private

Defined in src/js/RAMP/Modules/map.js:1223

The basemap layer

boundingBoxMapping

Object private

Defined in src/js/RAMP/Modules/map.js:92

Maps the id of a graphic layer to the GraphicsLayer Object that represents its extent bounding box. A dictionary of String, Esri/layers/GraphicsLayer pairs.

featureLayers

Array private

Defined in src/js/RAMP/Modules/map.js:76

An Array of Esri/layers/FeatureLayer objects.

featureLayerStartIndex

Integer private

Defined in src/js/RAMP/Modules/map.js:101

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

Defined in src/js/RAMP/Modules/map.js:1258

Used for full extent in nav widget

getMap

Object

Defined in src/js/RAMP/Modules/map.js:888

Return the map control object

getMaxExtent

Object

Defined in src/js/RAMP/Modules/map.js:879

The maximum extent of the map control is allowed to go to

InitExtent

Esri/geometry/Extent private

Defined in src/js/RAMP/Modules/map.js:1249

The initial extent of the map

maxExtent

Esri/geometry/Extent private

Defined in src/js/RAMP/Modules/map.js:1267

The maximum extent of the map

url

String private

Defined in src/js/RAMP/Modules/map.js:1214

The URL of the first layer of the basemap that is on by default.

wmsLayers

Array private

Defined in src/js/RAMP/Modules/map.js:84

An Array of Esri/layer/WMSLayer objects.