Reusable Accessible Mapping Platform

API Docs for: 5.0.0
Show:

BaseMapSelector Class

Uses
Defined in: src\js\RAMP\Modules\basemapSelector.js:9
Module: RAMP

Populates the BasemapGallery widget located in the maps toolbar with items found in the application configuration. This module also handles all the event needed to change the map basemap and update the UI

Methods

_hideLoadingImg

() private

Inherited from Map: src\js\RAMP\Modules\map.js:127

Hides the loading image.

_initEventHandlers

(
  • map
)
private

Inherited from Map: src\js\RAMP\Modules\map.js:368

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

Inherited from Map: src\js\RAMP\Modules\map.js:215

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

Parameters:

_initRepublishers

(
  • map
)
private

Inherited from Map: src\js\RAMP\Modules\map.js:184

Republishes map events to the outside using topic.publish

Parameters:

_initScale

(
  • event
)
private

Inherited from Map: src\js\RAMP\Modules\map.js:154

Initialize Map Scale

Parameters:

_showLoadingImg

() private

Inherited from Map: src\js\RAMP\Modules\map.js:117

Shows the loading image.

_updateScale

(
  • event
)
private

Inherited from Map: src\js\RAMP\Modules\map.js:137

Update Map Scale when zoom level changes

Parameters:

AddStaticLayer

(
  • layer_type
  • layer_url
  • layer_op
)
private

Inherited from Map: src\js\RAMP\Modules\map.js:566

Add a static, non-interactive Layer to the map

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

Inherited from Map: src\js\RAMP\Modules\map.js:826

Apply extent defaulting prior to URL overrides.

checkBoundary

(
  • e
  • maxExtent
)
Esri/geometry/Extent

Inherited from Map: src\js\RAMP\Modules\map.js:858

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
)

Inherited from Map: src\js\RAMP\Modules\map.js:1025

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

Inherited from Map: src\js\RAMP\Modules\map.js:550

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

Inherited from Map: src\js\RAMP\Modules\map.js:804

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

Inherited from Map: src\js\RAMP\Modules\map.js:814

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

Inherited from Map: src\js\RAMP\Modules\map.js:764

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

Returns:

Array:

an array of Esri/layers/FeatureLayer objects

init

() Object private

Defined in src\js\RAMP\Modules\basemapSelector.js:112

Initiates additional UI components of the widget, setting listeners and registering the popup functionality

Returns:

Object:

itself

initListeners

() private

Defined in src\js\RAMP\Modules\basemapSelector.js:288

Initializes class listeners.

initTopics

() private

Defined in src\js\RAMP\Modules\basemapSelector.js:269

Initializes functions that publish events.

localProjectExtent

(
  • extent
  • sr
)
Esri/Extent private

Inherited from Map but overwritten in src\js\RAMP\Modules\map.js:420

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

Inherited from Map: src\js\RAMP\Modules\map.js:915

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

Inherited from Map: src\js\RAMP\Modules\map.js:969

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

Inherited from Map: src\js\RAMP\Modules\map.js:939

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

Inherited from Map: src\js\RAMP\Modules\map.js:657

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

()

Inherited from Map: src\js\RAMP\Modules\map.js:845

initiate the projection of the config extents to basemap extents

projectExtent

(
  • extent
  • sr
  • callWhenDone
)
private

Inherited from Map: src\js\RAMP\Modules\map.js:476

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

Inherited from Map: src\js\RAMP\Modules\map.js:518

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

Inherited from Map: src\js\RAMP\Modules\map.js:534

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

Inherited from Map: src\js\RAMP\Modules\map.js:194

Republish map events using topic.publish

Parameters:

selectBasemap

(
  • basemapId
  • tileSchema
)
private

Defined in src\js\RAMP\Modules\basemapSelector.js:301

Selects a basemap in the basemapgallery based on the supplied basemap id. If the tileShema is different from the current one, reload the page.

Parameters:

  • basemapId String

    a basemap id used to select a basemap in the basemapgallery

  • tileSchema String

    a tileShema of the selected basemap

setBoundingBoxVisibility

(
  • layerId
)
private

Inherited from Map: src\js\RAMP\Modules\map.js:609

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

zoomToLayerScale

(
  • layerId
)

Inherited from Map: src\js\RAMP\Modules\map.js:707

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

Inherited from Map: src\js\RAMP\Modules\map.js:1078

The basemap layer

boundingBoxMapping

Object private

Inherited from Map: 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

Inherited from Map: src\js\RAMP\Modules\map.js:76

An Array of Esri/layers/FeatureLayer objects.

featureLayerStartIndex

Integer private

Inherited from Map: 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

Inherited from Map: src\js\RAMP\Modules\map.js:1113

Used for full extent in nav widget

getMap

Object

Inherited from Map: src\js\RAMP\Modules\map.js:751

Return the map control object

getMaxExtent

Object

Inherited from Map: src\js\RAMP\Modules\map.js:742

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

InitExtent

Esri/geometry/Extent private

Inherited from Map: src\js\RAMP\Modules\map.js:1104

The initial extent of the map

maxExtent

Esri/geometry/Extent private

Inherited from Map: src\js\RAMP\Modules\map.js:1122

The maximum extent of the map

url

String private

Inherited from Map: src\js\RAMP\Modules\map.js:1069

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

wmsLayers

Array private

Inherited from Map: src\js\RAMP\Modules\map.js:84

An Array of Esri/layer/WMSLayer objects.

Events

BaseMapSelector.BASEMAP_CHANGED

Provided by the UI module.

Defined in src\js\RAMP\Modules\eventManager.js:616

Fires whenever the basemap changes

Event Payload:

BaseMapSelector.TOGGLE [subscribed]

Provided by the UI module.

Defined in src\js\RAMP\Modules\eventManager.js:638

Changes the selected basemap

Event Payload:

  • evt Object

    the event object

    • id String

      the id of the basemap that is to be selected

BaseMapSelector.UI_COMPLETE

Provided by the UI module.

Defined in src\js\RAMP\Modules\eventManager.js:627

Fires after the basemap selector finished updating its UI (on page load)

Event Payload:

  • evt Object

    the event object

    • title String

      the title of the basemap that is selected