EventBus

Interface: EventBus

The image viewer event bus. 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".

Examples

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

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

Methods

dispatch()

dispatch(eventName, data): void;

Use the dispatch method to raise an event.

Parameters

eventName

EventBusEventName

data

any

Returns

void

on()

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

Listen an event bus event.

Parameters

Returns

void

off()

off(eventName, listener): void;

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

Parameters

eventName

EventBusEventName

listener

EventBusEventListener

Returns

void