API Docs for: 0.0.8-0
Show:

GUI Class

Uses
Defined in: javascript\src\RAMP\Modules\gui.js:12
Module: UI
Parent Module: RAMP

A class for handling most of the GUI on the page.

Methods

adjustHeight

() private

Defined in 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

Defined in javascript\src\RAMP\Modules\gui.js:899

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

adjustWidth

() private

Defined in javascript\src\RAMP\Modules\gui.js:959

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

adjutSubPanelDimensions

(
  • subPanel
)
private

Defined in 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

Defined in 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

Defined in 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

hideSubPanel

(
  • attr
  • speed
  • d
)
private

Defined in 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

Defined in javascript\src\RAMP\Modules\gui.js:871

Fires an event when the layout of the page changes.

load

(
  • id
  • req
  • load
)

Defined in 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

newPopup

(
  • popupAttr
)
private

Inherited from PopupManager: javascript\src\RAMP\Utils\popupManager.js:455

Create a new PopupBase object from the settings provided.

Parameters:

Returns:

popup

newSubPanel

(
  • attr
)
SubPanel private

Defined in javascript\src\RAMP\Modules\gui.js:853

Create a new SubPanel with the settings provided.

Parameters:

Returns:

SubPanel:

A newly created SubPanel

showSubPanel

(
  • attr
)
private

Defined in 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

Defined in 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

Defined in javascript\src\RAMP\Modules\gui.js:973

Animate the footer during full-screen transitions.

toggleFullScreenMode

(
  • fullscreen
)
private

Defined in javascript\src\RAMP\Modules\gui.js:1142

Toggles the FullScreen mode of the application

Parameters:

  • fullscreen Boolean

    true/undefined - expand; false - collapse

toggleSubPanelContainer

() private

Defined in 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

Defined in 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

Defined in 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

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

Published each time the layout changes.

gui.events.PANEL_CHANGE

Defined in 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]

Defined in 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]

Defined in 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

Defined in 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]

Defined in 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]

Defined in 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]

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

Opens the subpanel

Event Payload:

gui.events.TAB_DESELECTED

Defined in 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

Defined in 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]

Defined in 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

Defined in 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