Reusable Accessible Mapping Platform

API Docs for: 5.0.0
Show:

GraphicExtension Class

Uses
Defined in: src\js\RAMP\Modules\graphicExtension.js:12
Module: Map
Parent Module: RAMP

GraphicExtension class containing helper functions for graphic objects. Note this class requires the config object.

Methods

_wrapFileCallInPromise

(
  • readMethod
)
Function private

Inherited from Util: src\js\RAMP\Utils\util.js:33

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 String

    a string indicating the FileReader method to call

Returns:

Function:

a function which accepts a {File} object and returns a Promise

getGraphicTitle

(
  • graphic
)

Defined in src\js\RAMP\Modules\graphicExtension.js:87

Returns the content of the name field of the provided graphic object

Parameters:

  • graphic Esri/Graphic

    a graphic object or a feature object

Returns:

getLayerConfigWithId

(
  • id
)

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

Returns the feature layer config for the given id

Parameters:

getOid

(
  • graphic
)

Defined in src\js\RAMP\Modules\graphicExtension.js:48

Returns the oid of the given graphic object

Parameters:

  • graphic Esri/Graphic

getServiceURL

(
  • rampService
  • mapID
  • language
)

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

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

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

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

getTextContent

(
  • graphic
)
Object private

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

Get popup content for a graphic (i.e. a point) This logic is customized per project

Parameters:

Returns:

Object:

found graphic object

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

config

Object

Inherited from RAMP: src\js\RAMP\RAMP-starter.js:40

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

configServiceURL

String

Inherited from RAMP: src\js\RAMP\RAMP-starter.js:32

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

Inherited from RAMP: src\js\RAMP\RAMP-starter.js:48

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

state

Object

Inherited from RAMP: src\js\RAMP\RAMP-starter.js:58

A temporary solution to state management. Will be changed