Reusable Accessible Mapping Platform

API Docs for: 5.3.1
Show:

RAMP Class

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
)

Returns the feature layer config for the given id

Parameters:

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.

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

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

()

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

Properties

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

flags

Object

Store global flags. Should only contain boolean entries.

plugins

Object

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

scripts

Array

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

state

Object

A temporary solution to state management. Will be changed