undefined

API Docs for: 5.4.1
Show:

LayoutController Class

Defined in: src/js/RAMP/Modules/gui.js:822
Module: UI
Parent Module: RAMP

Controls layout transition such as full-data and full-screen modes, opening and closing of the side panel, adjusts layout when resizing the browser window.

Methods

_toggleFullDataMode

(
  • [fullData]
)
private

Defined in src/js/RAMP/Modules/gui.js:1079

Toggles the full-data mode on and off.

Parameters:

  • [fullData] Boolean optional

    if true, switches to full-data mode; if false, switches to summary mode; if undefined, toggle mode based on the current state

adjustHeight

() private

Defined in src/js/RAMP/Modules/gui.js:981

Adjusts the height of the help section based on the height of the window.

closePanel

(
  • d
)
private

Defined in src/js/RAMP/Modules/gui.js:1049

Slide the SidePanel close

Parameters:

  • d Deferred

    A deferred to be resolved upon completion of the animation

getContainer

() JObject

Defined in src/js/RAMP/Modules/gui.js:1300

Returns the outer most div of this SidePanel.

Returns:

JObject:

The outer most div of this SidePanel

init

()

Defined in src/js/RAMP/Modules/gui.js:1155

Initializes layout controller.

isFullData

() Boolean

Defined in src/js/RAMP/Modules/gui.js:1242

Returns the state of the full-data mode.

Returns:

Boolean:

True is full-data mode on; false otherwise

layoutChange

() private

Defined in src/js/RAMP/Modules/gui.js:967

Fires an event when the layout of the page changes.

onFullScreenComplete

() private

Defined in src/js/RAMP/Modules/gui.js:993

Executed after full-screen mode transition is complete.

openPanel

(
  • d
)
private

Defined in src/js/RAMP/Modules/gui.js:1021

Slides the SidePanel open.

Parameters:

  • d Deferred

    A deferred to be resolved upon completion of the animation

optimizeLayout

() private

Defined in src/js/RAMP/Modules/gui.js:1121

Optimizes layout based on the window width

panelChange

(
  • visible
)
private

Defined in src/js/RAMP/Modules/gui.js:1008

Publishes PANEL_CHANGE event when the visibility of the SidePanel changes.

Parameters:

  • visible Boolean

    Indicates whether the SidePanel is visible or not

setupNoDataTimeLine

() private

Defined in src/js/RAMP/Modules/gui.js:1138

Setup noDataTimeLine for data tab animation

subPanelChange

(
  • visible
  • origin
  • container
  • isComplete
)

Defined in src/js/RAMP/Modules/gui.js:1262

Fires an event when the subpanel closes or opens.

Parameters:

  • visible Boolean

    indicates whether the subpanel is visible or not (the panel is considered invisible when it's being destroyed, starts closing)

  • origin String

    origin of the subpanel

  • container JObject

    subpanel container

  • isComplete Boolean

    indicates if subPanel transition has completed or just started

toggleDataTab

(
  • open
)

Defined in src/js/RAMP/Modules/gui.js:1228

Toggles the visibility of Data tab in the side panel

Parameters:

  • open Boolean

    true - show; false - hide;

toggleFullDataMode

(
  • [fullData]
)

Defined in src/js/RAMP/Modules/gui.js:1252

Toggles the full-data mode on and off.

Parameters:

  • [fullData] Boolean optional

    if true, switches to full-data mode; if false, switches to summary mode; if undefined, toggle mode based on the current state

toggleFullScreenMode

(
  • fullscreen
)

Defined in src/js/RAMP/Modules/gui.js:1218

Toggles the FullScreen mode of the application

Parameters:

  • fullscreen Boolean

    true - expand; false - collapse; undefined - toggle;

updatePanelWidth

() private

Defined in src/js/RAMP/Modules/gui.js:1111

Changes internal panel width reference based on the window width.

width

() Number

Defined in src/js/RAMP/Modules/gui.js:1310

Gets the width of this SidePanel.

Returns:

Number:

The width of this SidePanel