API Docs for: 0.0.8-0
Show:

SidePanel Class

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

SidePanel Class

Constructor

SidePanel

()

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

Methods

closePanel

(
  • d
)
private

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

Slide the SidePanel close

Parameters:

  • d Deferred

    A deferred to be resolved upon completion of the animation

getContainer

() JObject

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

Retunrs the outter most div of this SidePanel.

Returns:

JObject:

The outter most div of this SidePanel

getPanelWidthDefault

() Number private

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

Return the default width of the SidePanel.

Returns:

Number:

The default width of the SidePanel

init

()

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

Initialize a newly create SidePanel.

openPanel

(
  • d
)
private

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

Slides the SidePanel open.

Parameters:

  • d Deferred

    A deferred to be resolved upon completion of the animation

panelChange

(
  • visible
)
private

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

Publishes PANEL_CHANGE event when the visibility of the SidePanel changes.

Parameters:

  • visible Boolean

    Indicates whether the SidePanel is visible or not

width

() Number

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

Gets the width of this SidePanel.

Returns:

Number:

The width of this SidePanel