API Docs for: 0.0.8-0
Show:

FeatureClickHandler Class

Uses
Defined in: javascript\src\RAMP\Modules\featureClickHandler.js:10
Module: Map
Parent Module: RAMP

Feature click handler class.

The featureClickHandler uses Dojo/Topic to publish centralized global mouse event messages related to feature selection. Any function subscribes to the topic will be able handle the specifice event.

Methods

_getSymbolConfig

(
  • layerUrl
)
Esri/layer/symbology

Inherited from RAMP but overwritten in javascript\src\RAMP\Modules\ramp.js:96

Gets the defined symbology from a layer's web service

Parameters:

  • layerUrl String

    A URL to the feature layer service

Returns:

Esri/layer/symbology:

The defined symbology from the layer definition

getGraphicTitle

(
  • graphic
)

Inherited from GraphicExtension: javascript\src\RAMP\Modules\graphicExtension.js:98

Parameters:

  • graphic Object

    a graphic object or a feature object

Returns:

getLayerConfig

(
  • graphic
)
Esri/Graphic

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

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

Parameters:

  • graphic Object

    a graphic object or a feature object

Returns:

Esri/Graphic:

getOid

(
  • graphic
)

Inherited from GraphicExtension: javascript\src\RAMP\Modules\graphicExtension.js:59

Returns the oid of the given graphic object

Parameters:

getSymbolForFeature

(
  • feature
)
Icon

Inherited from RAMP: javascript\src\RAMP\Modules\ramp.js:116

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

Inherited from GraphicExtension: javascript\src\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: javascript\src\RAMP\Modules\ramp.js:55

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

onFeatureDeselect

()

Defined in javascript\src\RAMP\Modules\featureClickHandler.js:98

This function is called whenever the "Details" button is deselected (either by the user click on another "Details" button, clicking on another point, or by clicking on an already highlighted "Details" button, or clicking somewhere on the map where is no features present).

onFeatureMouseOut

(
  • evt
)

Defined in javascript\src\RAMP\Modules\featureClickHandler.js:123

This function is called whenever the user moves the mouse away from a feature being hovered over.

Parameters:

  • evt Object

    [description]

    • graphic Object

      ESRI graphic object that is moved away from

onFeatureMouseOver

(
  • evt
)

Defined in javascript\src\RAMP\Modules\featureClickHandler.js:111

This function is called whenever the user hovers over a feature on the map when another feature already has been selected.

Parameters:

  • evt Object

    [description]

    • graphic Object

      ESRI graphic object that is being hovered over

onFeatureSelect

(
  • evt
)

Defined in javascript\src\RAMP\Modules\featureClickHandler.js:48

This function is called whenever the feature on the map is clicked/selected by the user. Publish the "Gui/subPanelOpen" message to indicate a feature has been selected. Panel content and Panel event handler information is passed in as the additional object for the event handler.

Parameters: