Events

This section describes events fired by this widget.

See Also

contentReady

Raised when the widget's content is ready.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Main article: onContentReady.

See Also

disposing

Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget instance.

element:

jQuery

The widget's container.

model:

Object

The model data. Available only if you use Knockout.

Main article: onDisposing

See Also

hidden

Fires after the overlay is hidden.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Instead, you can use the onHidden option to handle the event.

See Also
Show Example:
AngularJS
Knockout
jQuery

hiding

Fires before hiding the overlay.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

cancel:

Boolean

Indicates whether to cancel hiding the overlay.

Instead, you can use the onHiding option to handle the event.

See Also
Show Example:
AngularJS
Knockout
jQuery

initialized

Raised only once, after the widget is initialized.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

jQuery

The widget's container.

Main article: onInitialized

See Also

optionChanged

Raised after an option of the widget is changed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

name:

String

A short name of the option whose value has been changed.

fullName:

String

A full name of the option whose value has been changed; contains a full hierarchy of the option.

value: any

A new value for the option.

element:

jQuery

The widget's container.

model:

Object

The model data. Available only if you use Knockout.

Main article: onOptionChanged

See Also

showing

Fires before showing the overlay.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Instead, you can use the onShowing option to handle the event.

See Also
Show Example:
AngularJS
Knockout
jQuery

shown

Fires after the overlay is shown.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

element:

jQuery

An HTML element of the widget.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Instead, you can use the onShown option to handle the event.

See Also
Show Example:
AngularJS
Knockout
jQuery