Reusable Accessible Mapping Platform

API Docs for: 2.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

_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

getGraphicTitle

(
  • graphic
)

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

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

Parameters:

  • graphic Esri/Graphic

    a graphic object or a feature object

Returns:

getLayerConfig

(
  • graphic
)
Esri/Graphic

Inherited from RAMP but overwritten in src\js\RAMP\Modules\graphicExtension.js:48

Given a graphic object, returns the config object associated with the graphic's layer.

Parameters:

  • graphic Esri/Graphic

    a graphic object or a feature object

Returns:

Esri/Graphic:

getOid

(
  • graphic
)

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

Returns the oid of the given graphic object

Parameters:

  • graphic Esri/Graphic

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

getTextContent

(
  • graphic
)
Object private

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

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