Reusable Accessible Mapping Platform

API Docs for: 5.2.0
Show:

PopupBaseSettings Class

A class holding properties of the popup.

Properties

activeClass

String

The CSS class to be applied to the handle of the popup when the popup opens.

Default: random guid

closeHandler

Function

The function to execute when the popup closes. If the function is not supplied, openHandler is used instead.

Default: null

containerSelector

String

Selector for the container housing both actual handle and actual target for one popup instance. Used to select the actual target that is relative to currently active handle.

Default: null

handle

JQuery

The initially supplied handle to the PopupManager; a JQuery to listen to events on.

Default: null

handleSelector

String

The initially supplied handle selector to be used in conjunction with handle when listening to events. Useful if the real handle doesn't exist yet.

Default: null

openHandler

Function

The function to execute when the popup opens.

Default: null

openOnly

Boolean

Indicates whether the popup should react on the closing event as well. The closing event is considered an event on the handle of the popup which is open.

Default: false

resetFocusOnClose

Boolean

Indicates whether focus should be reset to the handle of the popup when the popup is closed by the internal close button if present.

Default: false

reverseEvent

String

The name of the event or events separated by a comma to trigger the closing of the popup.

Default: null

setClassBefore

String

Indicates whether activeClass should be applied before openHandler function completes or after.

Default: null

target

JQuery

The initially supplied target node of the popup.

Default: null

targetSelector

String

The initially supplied target selector to be used in conjunction with target. Useful when the target of the popup doesn't exist yet.

Default: null

timeout

Number

The delay before closing the popup; used with "hoverIntent" event type.

Default: 0

useAria

Boolean

Indicates whether to apply aria-* attributes to DOM nodes.

Default: true