Reusable Accessible Mapping Platform

API Docs for: 2.0.0
Show:

TmplHelper Class

Uses
Defined in: src\js\RAMP\Utils\tmplHelper.js:11
Module: TmplUtil
Parent Module: Utils

A set of functions used to support and standardize the use of templating

Methods

_getSymbolConfig

(
  • layerUrl
  • wmsName
)
Esri/layer/symbology

Inherited from RAMP: src\js\RAMP\Modules\ramp.js:103

Gets the defined symbology from a layer's web service

Parameters:

  • layerUrl String

    A URL to the feature layer service

  • wmsName String

    WMS Layer name. Optional. Should only be provided if attempting to get a WMS layer.

Returns:

Esri/layer/symbology:

The defined symbology from the layer definition

getFeatureName

(
  • graphic
  • layerConfig
)
String

Inherited from TmplUtil: src\js\RAMP\Utils\tmplUtil.js:49

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:

String:

imageUrl Url to the features symbology image

getGraphicIcon

(
  • graphic
  • layerConfig
)
String

Inherited from TmplUtil: src\js\RAMP\Utils\tmplUtil.js:22

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:

String:

imageUrl Url to the features symbology image

getLayerConfig

(
  • url
  • wmsName
)

Inherited from RAMP: src\js\RAMP\Modules\ramp.js:64

Returns the feature layer config for the given url

Parameters:

  • url String
  • wmsName String

    WMS Layer name. Optional. Should only be provided if attempting to get a WMS layer.

getObjectId

(
  • graphic
)
Integer

Inherited from TmplUtil: src\js\RAMP\Utils\tmplUtil.js:64

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:

Integer:

objectId

getSymbolForFeature

(
  • feature
)
Icon

Inherited from RAMP: src\js\RAMP\Modules\ramp.js:126

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

getSymbolForLayer

(
  • layer
  • wmsName
)
Icon

Inherited from RAMP: src\js\RAMP\Modules\ramp.js:114

Gets the default symbology icon from a layer's web service

Parameters:

  • layer Object

    A feature layer

  • wmsName String

    WMS Layer name. Optional. Should only be provided if attempting to get a WMS layer.

Returns:

Icon:

The default icon from the layer's symbology

loadStrings

()

Inherited from RAMP: src\js\RAMP\Modules\ramp.js:55

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

Properties

getConfigUrl

Object

Inherited from GlobalStorage: src\js\RAMP\Modules\globalStorage.js:23

Returns 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