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.
Item Index
Methods
Properties
Methods
_wrapFileCallInPromise
-
readMethod
Helper function for wrapping File API calls in Promise objects. Used for building a series of helpers which call different file read methods.
Parameters:
-
readMethod
Stringa string indicating the FileReader method to call
Returns:
a function which accepts a {File} object and returns a Promise
autoHyperlink
-
content
Wraps plain text urls and emails with tags.
Parameters:
-
content
Stringthe text you would like to search in.
getFeatureName
-
graphic
-
layerConfig
Given a feature object or a graphic object (or any object that has a getLayer method and an attributes field) return the attribute value for its designed "name" field
NOTE: all dependent functions should be written as nested functions inside the caller function, otherwise TmplEx templating library won't identify
Parameters:
-
graphic
Graphic -
layerConfig
Object
Returns:
imageUrl Url to the features symbology image
getGraphicIcon
-
graphic
-
layerConfig
Given a feature object or a graphic object (or any object that has a getLayer method and an attributes field) return the image URL for that feature/graphic object.
NOTE: all dependent functions should be written as nested functions inside the caller function, otherwise TmplEx templating library won't identify
Parameters:
-
graphic
Graphic -
layerConfig
Object
Returns:
imageUrl Url to the features symbology image
getLayerConfigWithId
-
id
Returns the feature layer config for the given id
Parameters:
-
id
Stringlayer id string
getObjectId
-
graphic
Given a feature object return the objectid for that item. This will likely fail on a non-feature object (e.g. a plain graphic)
NOTE: all dependent functions should be written as nested functions inside the caller function, otherwise TmplEx templating library won't identify
Parameters:
-
graphic
Graphic
Returns:
objectId
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:
-
feature
Object
Returns:
The default icon used to represent the feature layer
getSymbolForLayer
-
layerConfig
Gets an array of symbology images to display in the layer selector
Parameters:
-
layerConfig
ObjectA layer's config object
Returns:
The array of icon(s) to use in layer selector
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
plugins
Object
A registry of plugins for RAMP code to reference, these should be loaded and registered by bootstrapper.js