API Docs for: 0.0.8-0
Show:

DatagridClickHandler Class

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

Datagridclick handler class.

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

adjustHeight

() private

Inherited from GUI: javascript\src\RAMP\Modules\gui.js:942

Adjust the height of the body of the page on initial load and every page resize.

adjustHelpDimensions

() private

Inherited from GUI: javascript\src\RAMP\Modules\gui.js:899

Adjusts dimensions of the help panel relative to the mapContent div.

adjustWidth

() private

Inherited from GUI: javascript\src\RAMP\Modules\gui.js:959

Adjusts the width of the slide out panel and the map section.

adjutSubPanelDimensions

(
  • subPanel
)
private

Inherited from GUI: javascript\src\RAMP\Modules\gui.js:911

Adjusts the dimensions and position of the SubPanel when layout of the page is changing.

Parameters:

  • subPanel SubPanel

    SubPanel whose dimensions and position need to be adjusted

captureSubPanel

(
  • attr
)
private

Inherited from GUI: javascript\src\RAMP\Modules\gui.js:1117

Finds a SubPanel with origin equal to the supplied consumeOrigin and

  • changes its origin to the supplied origin
  • moves the SubPanel in the DOM hierarchy and attaches it to the specified target

Parameters:

  • attr SubPanelSettings

    Settings for the SubPanel; only origin, consumeOrigin and target are required here

dockSubPanel

(
  • attr
)
private

Inherited from GUI: javascript\src\RAMP\Modules\gui.js:1100

Moves the SubPanel with the specified origin in the DOM hierarchy to the new specified target; if target is not specified, the SubPanel is attached to the SidePanel.

Parameters:

  • attr SubPanelSettings

    Settings for the SubPanel; only target and origin are required here

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

hideSubPanel

(
  • attr
  • speed
  • d
)
private

Inherited from GUI: javascript\src\RAMP\Modules\gui.js:1067

Closes the SubPanel whose origin is specified in the attr parameter.

Parameters:

  • attr SubPanelSettings

    only origin attribute is required here

  • speed Number

    Duration of the closing animation

  • d Deferred

    The deferred object to be resolved upon successful closing of the panel

layoutChange

() private

Inherited from GUI: javascript\src\RAMP\Modules\gui.js:871

Fires an event when the layout of the page changes.

load

(
  • id
  • req
  • load
)

Inherited from GUI: javascript\src\RAMP\Modules\gui.js:1206

Call load to initialize the GUI module.

Parameters:

  • id Number

    ID of this module

  • req ?

    ???

  • load Function

    The callback function

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

newSubPanel

(
  • attr
)
SubPanel private

Inherited from GUI: javascript\src\RAMP\Modules\gui.js:853

Create a new SubPanel with the settings provided.

Parameters:

Returns:

SubPanel:

A newly created SubPanel

onDetailDeselect

()

Defined in javascript\src\RAMP\Modules\datagridClickHandler.js:107

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 javascript\src\RAMP\Modules\datagridClickHandler.js:60

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 javascript\src\RAMP\Modules\datagridClickHandler.js:167

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

onZoomCancel

()

Defined in javascript\src\RAMP\Modules\datagridClickHandler.js:182

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 javascript\src\RAMP\Modules\datagridClickHandler.js:46

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

onZoomTo

(
  • currentExtent
  • zoomToGraphic
)

Defined in javascript\src\RAMP\Modules\datagridClickHandler.js:120

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

showSubPanel

(
  • attr
)
private

Inherited from GUI: javascript\src\RAMP\Modules\gui.js:1008

Creates and opens a new SubPanel with given settings. If the SubPanel with the requested origin is already present, updates its content.

Parameters:

subPanelChange

(
  • visible
  • origin
  • container
)
private

Inherited from GUI: javascript\src\RAMP\Modules\gui.js:881

Fires an even when the subpanel closes or opens.

Parameters:

  • visible Boolean

    indicates whether the panel is visible or not

  • origin String

    origin of the subpanel

  • container JObject

    subpanel container

toggleFooter

() private

Inherited from GUI: javascript\src\RAMP\Modules\gui.js:973

Animate the footer during full-screen transitions.

toggleFullScreenMode

(
  • fullscreen
)
private

Inherited from GUI: javascript\src\RAMP\Modules\gui.js:1142

Toggles the FullScreen mode of the application

Parameters:

  • fullscreen Boolean

    true/undefined - expand; false - collapse

toggleSubPanelContainer

() private

Inherited from GUI: javascript\src\RAMP\Modules\gui.js:986

Adjust the SubPanels to the full-screen mode of the page.

Events

gui.events.FULLSCREEN_CHANGE

Inherited from GUI: javascript\src\RAMP\Modules\eventManager.js:185

Published each time fullscreen is toggled

Event Payload:

  • evt Object

    the event Object

    • fullscreen Boolean

      true if fullscreen is on, false if fullscreen is off.

gui.events.HELP_PANEL_CHANGE

Inherited from GUI: javascript\src\RAMP\Modules\eventManager.js:175

Published each time the help panel opens or closes.

Event Payload:

  • evt Object

    the event Object

  • visible Boolean

    true if the help panel is opened, false if the help panel is closed

gui.events.LAYOUT_CHANGE

Inherited from GUI: javascript\src\RAMP\Modules\eventManager.js:195

Published each time the layout changes.

gui.events.PANEL_CHANGE

Inherited from GUI: javascript\src\RAMP\Modules\eventManager.js:165

Published each time the panel opens/closes

Event Payload:

  • evt Object

    the event Object

    • visible Boolean

      true if the panel is opened, false otherwise

gui.events.PANEL_TOGGLE [subscribed]

Inherited from GUI: javascript\src\RAMP\Modules\eventManager.js:204

Toggles the main panel (i.e. collapses it if was expanded, and expands it if it was collapsed)

gui.events.SUBPANEL_CAPTURE [subscribed]

Inherited from GUI: javascript\src\RAMP\Modules\eventManager.js:240

Attaches subPanel node to the module that calls it in the DOM hierarchy

Event Payload:

gui.events.SUBPANEL_CHANGE

Inherited from GUI: javascript\src\RAMP\Modules\eventManager.js:153

Published each time the subpanel opens/closes

Event Payload:

  • evt Object

    the event Object

    • visible Boolean

      true if the subpanel is opened, false otherwise

    • origin String
    • container JObject

      jQuery reference to the sub-panel container

gui.events.SUBPANEL_CLOSE [subscribed]

Inherited from GUI: javascript\src\RAMP\Modules\eventManager.js:221

Closes the sub panel

Event Payload:

  • origin String

    the name of the module that requested to close the subPanel (e.g. "filterManager")

gui.events.SUBPANEL_DOCK [subscribed]

Inherited from GUI: javascript\src\RAMP\Modules\eventManager.js:230

Moves the panel up DOM hierarchy next to the sidePanel, or to other target

Event Payload:

  • origin String

    the name of the module that requested to dock the subPanel (e.g. "filterManager")

  • target JNode

    where to move the subPanel; if not supplied; sidePanel is used

gui.events.SUBPANEL_OPEN [subscribed]

Inherited from GUI: javascript\src\RAMP\Modules\eventManager.js:212

Opens the subpanel

Event Payload:

gui.events.TAB_DESELECTED

Inherited from GUI: javascript\src\RAMP\Modules\eventManager.js:131

Fires whenever a tab has been deselected in the main panel

Event Payload:

  • evt Object

    the event Object

    • id String

      the id of the deselected tab

    • tabName String

      the name of the deselected tab

gui.events.TAB_SELECTED

Inherited from GUI: javascript\src\RAMP\Modules\eventManager.js:142

Fires whenever a tab has been selected in the main panel

Event Payload:

  • evt Object

    the event Object

    • id String

      the id of the selected tab

    • tabName String

      the name of the selected tab

gui.events.TOGGLE_FULLSCREEN [subscribed]

Inherited from GUI: javascript\src\RAMP\Modules\eventManager.js:249

Toggles the fullscreen

Event Payload:

  • evt Object

    the event Object

    • expand Boolean

      true if we should go into fullscreen mode, false if we wish to collapse to normal mode. If undefined, it toggles the fullscreen (i.e. make it fullscreen if it was not, make it collapse to regard mode if it was fullscreen).

gui/add-layer-panel-change

Inherited from GUI: javascript\src\RAMP\Modules\eventManager.js:261

Published each time the Add Layer panel opens or closes.

Event Payload:

  • evt Object

    the event Object

  • visible Boolean

    true if the AddLayer panel is opened, false if the AddLayer panel is closed