Methods may be called on the Pulse instance to perform a variety of functions. You have access to all of the methods listed below.

Playback

.next()

Loads the next item in queue.

Returns

Nothing

.play()

Begins automatic slideshow playback.

Returns

Nothing

.pause()

Stops automatic slideshow playback if currently playing.

Returns

Nothing

.previous()

Loads the previous item in queue.

Returns

Nothing

.restart()

Restarts the slideshow by requesting the first item.

Returns

Nothing

.toggle()

Toggles automatic slideshow playback.

Returns

Nothing

Fullscreen

.toggleFullscreen()

Enters and exits full screen mode.

Returns

Nothing

Data

.getItem()

Returns data about the current item in view.

Returns

(Object) Returns the content and dom event objects (same data the item event broadcasts).

.getNextItem()

Returns data about the next item in queue.

Returns

(Object) Returns the content and dom event objects (same data the item event broadcasts).

.loadItem(id)

Displays an item assigned a particular id.

Returns

Nothing