Reusable Accessible Mapping Platform

API Docs for: 5.2.0
Show:

RAMP Class

Uses
Defined in: src\js\RAMP\RAMP-starter.js:26
Module: RAMP

RAMP global class. A general globally available class to hold any RAMP global data. Currently houses any plugins which are not loaded via AMD.

Methods

getLayerConfigWithId

(
  • id
)

Defined in src\js\RAMP\Modules\ramp.js:68

Returns the feature layer config for the given id

Parameters:

getServiceURL

(
  • rampService
  • mapID
  • language
)

Defined in src\js\RAMP\Modules\ramp.js:97

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.

Parameters:

  • rampService String

    The base URL for a web service that provide's valid map JSON configuration data

  • mapID Number

    a unique identifier for a group of map configuration

  • language String

    culture code either 'en' or 'fr'

getSymbolForFeature

(
  • feature
)
Icon

Defined in src\js\RAMP\Modules\ramp.js:81

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:

Returns:

Icon:

The default icon used to represent the feature layer

loadStrings

()

Defined in src\js\RAMP\Modules\ramp.js:59

Updates some of the Strings on the HTML page using the config string resources

Properties

config

Object

Defined in src\js\RAMP\RAMP-starter.js:41

The RAMP application config, it should be treated as read only by all modules other than globalStorage and bootstrapper

configServiceURL

String

Defined in src\js\RAMP\RAMP-starter.js:33

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

flags

Object

Defined in src\js\RAMP\RAMP-starter.js:73

Store global flags. Should only contain boolean entries.

plugins

Object

Defined in src\js\RAMP\RAMP-starter.js:49

A registry of plugins for RAMP code to reference, these should be loaded and registered by bootstrapper.js

scripts

Array

Defined in src\js\RAMP\RAMP-starter.js:81

Scripts to be loaded after dojo config is prepared. Loaded in order (works around an IE9 issue).

state

Object

Defined in src\js\RAMP\RAMP-starter.js:59

A temporary solution to state management. Will be changed