Document Solutions Image Viewer - v8.0.0 / EventBus

Class: EventBus

The image viewer event bus.

Description

Use the event bus to listen and receive certain specific "events". Available events are: "before-open", "after-open", "before-close", "after-close", "zoom-changed", "frame-index-changed", "animation-started", "animation-stopped".

Example

// Liisten frame index changes:
viewer.eventBus.on("frame-index-changed", function(args) { console.log("Image frame changed", args); });

Example

// Listen "after-open" event once:
viewer.eventBus.on("after-open", function(args) { console.log("Image opened", args); }, { once: true });

Implements

• IEventBus

Table of contents

Constructors

• constructor

Methods

• on
• off
• offAll
• dispatch

Constructors

constructor

• new EventBus()

Class constructor.

Methods

on

▸ on(eventName, listener, options?): void

Listen eventbus event.

Parameters

Returns

void

Implementation of

IEventBus.on

off

▸ off(eventName, listener): void

Remove event listener specified by the listener argument for the event specified by the eventName argument.

Parameters

Returns

void

Implementation of

IEventBus.off

offAll

▸ offAll(eventName): void

Remove all event listeners for the event specified by the eventName argument.

Parameters

Returns

void

dispatch

▸ dispatch(eventName, data): void

Use the dispatch method to raise an event.

Parameters

Returns

void

Implementation of

IEventBus.dispatch