Reusable Accessible Mapping Platform

API Docs for: 4.0.0
Show:

DatagridClickHandler Class

Uses
Defined in: src\js\RAMP\Modules\datagridClickHandler.js:10
Module: Datagrid
Parent Module: RAMP

Datagridclick handler class.

Methods

_getSymbolConfig

(
  • layerUrl
  • wmsName
)
Esri/layer/symbology

Inherited from RAMP: src\js\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

  • 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
)

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

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

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:123

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:107

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: 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

onDetailDeselect

()

Defined in src\js\RAMP\Modules\datagridClickHandler.js:135

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).

onDetailSelect

(
  • buttonNode
  • selectedGraphic
)

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

This function is called whenever the "Details" button is clicked in the datagrid.

Parameters:

  • buttonNode JObject

    the "Details" button node

  • selectedGraphic Object

    {esri/Graphic} the graphic object associated with the entry in the datagrid

onZoomBack

()

Defined in src\js\RAMP\Modules\datagridClickHandler.js:202

This function is called whenever the user clicks on the "Zoom Back" button.

onZoomCancel

()

Defined in src\js\RAMP\Modules\datagridClickHandler.js:217

This function is called whenever the user deselects the "Zoom To" button (either by the user clicking on another point on the map, or by clicking on another "Zoom To" button)

onZoomCancel

()

Defined in src\js\RAMP\Modules\datagridClickHandler.js:45

Publishes new events when zoomCancel event happens. Following events are published: highlighter/zoomlight-hide datagrid/zoomlightrow-hide

onZoomTo

(
  • currentExtent
  • zoomToGraphic
)

Defined in src\js\RAMP\Modules\datagridClickHandler.js:154

This function is called whenever the user clicks on the "Zoom To" button.

Parameters:

  • currentExtent Esri/geometry/Extent

    the current extent of the map

  • zoomToGraphic Object

    graphic object of the feature to zoom to

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