Reusable Accessible Mapping Platform

API Docs for: 5.0.0
Show:

FeatureClickHandler Class

Uses
Defined in: src\js\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 specific event.

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
)

Inherited from GraphicExtension: 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:

getOid

(
  • graphic
)

Inherited from GraphicExtension: src\js\RAMP\Modules\graphicExtension.js:48

Returns the oid of the given graphic object

Parameters:

  • graphic Esri/Graphic

getTextContent

(
  • graphic
)
Object private

Inherited from GraphicExtension: 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

onFeatureDeselect

()

Defined in src\js\RAMP\Modules\featureClickHandler.js:97

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 src\js\RAMP\Modules\featureClickHandler.js:122

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 src\js\RAMP\Modules\featureClickHandler.js:110

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 src\js\RAMP\Modules\featureClickHandler.js:47

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: