onPause( )

Adds an event handler that runs when playback is paused.

Description

An element can be paused by a user clicking the gallery or slideshow's pause button or by calling its pause() function

Notes:
When using onPause() on a gallery, make sure the gallery is one where the isPlayable capability is true.
If you change a gallery's type to one that doesn't support onPause(), your code may no longer function correctly.

Syntax

function onPause(handler: EventHandler): Gallery | Slideshow
handler: function EventHandler(event: Event): void

onPause Parameters

NAME

TYPE

DESCRIPTION

handler

EventHandler

The name of the function or the function expression to run when the element is paused.

Returns

The gallery or slideshow that triggered the event.

Return Type:

Gallery

Slideshow

EventHandler Parameters

NAME

TYPE

DESCRIPTION

event

Event

The event that occurred.

Returns

This function does not return anything.

Return Type:

void

Get the ID of the element that has been paused

Copy Code

1$w("#myElement").onPause( (event) => {
2  let targetId = event.target.id; // "myElement"
3});