API Docs for: 0.0.8-0
Show:

Maptips Class

Uses
Defined in: javascript\src\RAMP\Modules\maptips.js:11
Module: Maptips
Parent Module: Map

Maptips class.

The map tip module provides functions to create a small popup window as the mouse hovers over a feature on the map (point, polygon, line, etc.). NOTE: This module uses global config object. featureLayers->mapTipSettings

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

checkMaptipPosition

(
  • target
  • graphic
)
private

Defined in javascript\src\RAMP\Modules\maptips.js:95

Checks if the maptip is hidden by the sub-panel and publishes a center-at event to pan the map, moving maptip into view.

Parameters:

  • target JObject

    a node to which the tooltip will be attached

  • graphic Object

    [description]

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

getLayerConfig

(
  • url
)

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

Returns the feature layer config for the given url

Parameters:

getMaptipContent

(
  • graphic
  • interactive
)
private

Defined in javascript\src\RAMP\Modules\maptips.js:124

Generates content for a maptip.

Parameters:

  • graphic Object

    map graphic the tip is describing

  • interactive String

    indicates whether the maptip should have a close button

getSubPanelLeftOffset

() Number private

Defined in javascript\src\RAMP\Modules\maptips.js:67

Returns the position of the sub-panel relative to the leftmost edge of the screen.

Returns:

Number:

position of hte sub-panel relative to the leftmost edge of the screen

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

getToolTipOffset

() Number private

Defined in javascript\src\RAMP\Modules\maptips.js:78

Returns the position of the maptip relative to the leftmost edge of the screen.

Returns:

Number:

the position of the maptip relative to the leftmost edge of the screen

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

init

()

Defined in javascript\src\RAMP\Modules\maptips.js:258

Calls the event handling initialization function

initListeners

() private

Defined in javascript\src\RAMP\Modules\maptips.js:205

Initialize event listeners for the maptip events

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

showMapTip

(
  • target
  • graphic
  • interactive
)
private

Defined in javascript\src\RAMP\Modules\maptips.js:153

Creates a maptip on the map.

Parameters:

  • target JObject

    a node the user hovered over

  • graphic Object

    the graphic belonging to the target

  • interactive Boolean

    indicates whether the maptip should have a close button

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.

Attributes

getConfigUrl

readonly

Inherited from GlobalStorage: javascript\src\RAMP\Modules\globalStorage.js:22

Returns 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

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

maptips.events.EXTENT_CHANGE [subscribed]

Provided by the UI module.

Defined in javascript\src\RAMP\Modules\eventManager.js:358

Is fired when an interactive maptip is shown and Maptip detects if the maptip is hidden behind the SubPanel and extent change is needed. Sets the scroll payload attribute to true if the extent change is not needed and the Datagrid should scroll to the currently highlighted row.

Event Payload:

  • scroll Boolean

    indicates if the Datagrid should scroll to the currenlty highlighted row

maptips.events.REPOSITION_INTERACTIVE [subscribed]

Provided by the UI module.

Defined in javascript\src\RAMP\Modules\eventManager.js:368

Repositions the interactive tooltip that is already displayed when the user pans or zooms the map, or the map is otherwise adjusted. If the tooltip is hidden from the view by the SubPanel or the edge of the map container, it is hidden from the page.

Event Payload:

  • offset Number

    New tooltip offset relative to the shape it's attached too; when zooming, the shape changes its size and the offset needs to be recalculated to keep the tooltip in relative center

maptips.events.SHOW [subscribed]

Provided by the UI module.

Defined in javascript\src\RAMP\Modules\eventManager.js:336

Displays a simple, temporary maptip, positioning it over the target jObject; the content of the maptip is build from the contents of the graphic object and the mapTip template specified in the config object.

Event Payload:

  • target JObject

    a node/svg object the user hovered over

  • graphic Object

    ESRI graphic object belonging to the target

maptips.events.SHOW_INTERACTIVE [subscribed]

Provided by the UI module.

Defined in javascript\src\RAMP\Modules\eventManager.js:347

Displays an permanent, interactive maptip with a close button, positioning it over the target jObject; the content of the maptip is build from the contents of the graphic object and the mapTip template specified in the config object. The maptip will not be shown if it's covered by the open SubPanel.

Event Payload:

  • target JObject

    a node/svg object the user hovered over

  • graphic Object

    ESRI graphic object belonging to the target