Reusable Accessible Mapping Platform

API Docs for: 5.3.2
Show:

PopupBase Class

Defined in: src/js/RAMP/Utils/popupManager.js:161
Module: Utils

An abstract representation of the popup definition that potentially references many Popup instances. Handle and target properties might use selectors.

Methods

_getActualHandle

(
  • [selector]
)
private

Defined in src/js/RAMP/Utils/popupManager.js:178

Finds and returns actual DOM nodes of popup handles, one or more. Used selector

Parameters:

Returns:

result An array of one or more jQuery objects that works as popup handles

_spawnPopups

(
  • [selector]
)
#crossLink "Popup" private

Defined in src/js/RAMP/Utils/popupManager.js:198

Finds and returns an array of Popup objects, one or more, identified in the PopupBase.

Parameters:

Returns:

#crossLink "Popup":

popups An array of one or more }{{/crossLink}} objects

close

(
  • [selector]
)

Defined in src/js/RAMP/Utils/popupManager.js:292

Closes all the popups described by this PopupBase instance.

Parameters:

isOpen

(
  • [selector]
  • [condition]
)

Defined in src/js/RAMP/Utils/popupManager.js:246

Checks if any of the popups described by this PopupBase is closed.

Parameters:

  • [selector] JQuery optional

    A JQuery of the actual handle.

  • [condition] String optional

    can be all or any; if all, returns true if all the described popups are open; if any; if at least one is open.

Returns:

result True if any of the described popups are open; false otherwise

open

(
  • [selector]
)

Defined in src/js/RAMP/Utils/popupManager.js:280

Opens all the popups described by this PopupBase instance.

Parameters:

setTargetAttr

(
  • [visible]
)

Defined in src/js/RAMP/Utils/popupManager.js:317

Sets the appropriate aria-* attributes to the popup nodes according to the supplied visible parameter or with the internal state of the popup.

Parameters:

  • [visible] Boolean optional

    Indicating the internal state of the popup

toggle

(
  • [selector]
  • [state]
)

Defined in src/js/RAMP/Utils/popupManager.js:304

Toggles all the popups described by this PopupBase instance.

Parameters:

  • [selector] JQuery optional

    A JQuery of the actual handle. Generally, selector is not needed if popup manages only one handle/target pair.

  • [state] Boolean optional

    Indicates if the popup should be toggled on or off. true - open; false - close;

Properties

_attr

PopupBaseSettings private

Defined in src/js/RAMP/Utils/popupManager.js:168

Properties object of the PopupBase.