Reusable Accessible Mapping Platform

API Docs for: 2.0.0
Show:

SidePanel Class

Module: UI
Parent Module: RAMP

Methods

closePanel

(
  • d
)
private

Defined in src\js\RAMP\Modules\gui.js:880

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:1039

Returns the outer most div of this SidePanel.

Returns:

JObject:

The outer most div of this SidePanel

openPanel

(
  • d
)
private

Defined in src\js\RAMP\Modules\gui.js:856

Slides the SidePanel open.

Parameters:

  • d Deferred

    A deferred to be resolved upon completion of the animation

panelChange

(
  • visible
)
private

Defined in src\js\RAMP\Modules\gui.js:842

Publishes PANEL_CHANGE event when the visibility of the SidePanel changes.

Parameters:

  • visible Boolean

    Indicates whether the SidePanel is visible or not

subPanelChange

(
  • visible
  • origin
  • container
  • isComplete
)
private

Defined in src\js\RAMP\Modules\gui.js:1000

Fires an event 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

  • isComplete Boolean

    indicates if subPanel transition has completed or just started

toggleFullScreenMode

(
  • fullscreen
)
private

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

Toggles the FullScreen mode of the application

Parameters:

  • fullscreen Boolean

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

width

() Number

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

Gets the width of this SidePanel.

Returns:

Number:

The width of this SidePanel