Reusable Accessible Mapping Platform

API Docs for: 5.0.0
Show:

TmplUtil Class

Defined in: src\js\RAMP\Utils\tmplUtil.js:9
Module: Utils

A set of functions that can be accessed within templates

Methods

getFeatureName

(
  • graphic
  • layerConfig
)
String

Defined in src\js\RAMP\Utils\tmplUtil.js:109

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

Defined in 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

getObjectId

(
  • graphic
)
Integer

Defined in src\js\RAMP\Utils\tmplUtil.js:124

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

getSymbolForLayer

(
  • layerConfig
)
Icon

Defined in src\js\RAMP\Utils\tmplUtil.js:244

Gets an array of symbology images to display in the layer selector

Parameters:

  • layerConfig Object

    A layer's config object

Returns:

Icon:

The array of icon(s) to use in layer selector