in src/viewer/Viewer.ts [937:1256]
public on(
type: "fov",
handler: (event: ViewerStateEvent) => void)
: void;
/**
* Fired immediately after all necessary resources
* have been downloaded and the first visually complete
* rendering of the viewer has occurred.
*
* This event is only fired for viewer configurations where
* the WebGL context is created, i.e. not when using the
* fallback functionality only.
*
* @event load
* @example
* @example
* ```js
* // Set an event listener
* viewer.on('load', function(event) {
* console.log('A load event has occured');
* });
* ```
*/
public on(
type: "load",
handler: (event: ViewerLoadEvent) => void)
: void;
/**
* Fired when a pointing device (usually a mouse) is pressed
* within the viewer.
*
* @event mousedown
* @example
* ```js
* // Initialize the viewer
* var viewer = new Viewer({ // viewer options });
* // Set an event listener
* viewer.on("mousedown", function() {
* console.log("A mousedown event has occurred.");
* });
* ```
*/
public on(
type: "mousedown",
handler: (event: ViewerMouseEvent) => void)
: void;
/**
* Fired when a pointing device (usually a mouse)
* is moved within the viewer.
*
* @event mousemove
* @example
* ```js
* // Initialize the viewer
* var viewer = new Viewer({ // viewer options });
* // Set an event listener
* viewer.on("mousemove", function() {
* console.log("A mousemove event has occurred.");
* });
* ```
*/
public on(
type: "mousemove",
handler: (event: ViewerMouseEvent) => void)
: void;
/**
* Fired when a pointing device (usually a mouse)
* leaves the viewer's canvas.
*
* @event mouseout
* @example
* ```js
* // Initialize the viewer
* var viewer = new Viewer({ // viewer options });
* // Set an event listener
* viewer.on("mouseout", function() {
* console.log("A mouseout event has occurred.");
* });
* ```
*/
public on(
type: "mouseout",
handler: (event: ViewerMouseEvent) => void)
: void;
/**
* Fired when a pointing device (usually a mouse)
* is moved onto the viewer's canvas.
*
* @event mouseover
* @example
* ```js
* // Initialize the viewer
* var viewer = new Viewer({ // viewer options });
* // Set an event listener
* viewer.on("mouseover", function() {
* console.log("A mouseover event has occurred.");
* });
* ```
*/
public on(
type: "mouseover",
handler: (event: ViewerMouseEvent) => void)
: void;
/**
* Fired when a pointing device (usually a mouse)
* is released within the viewer.
*
* @event mouseup
* @example
* ```js
* // Initialize the viewer
* var viewer = new Viewer({ // viewer options });
* // Set an event listener
* viewer.on("mouseup", function() {
* console.log("A mouseup event has occurred.");
* });
* ```
*/
public on(
type: "mouseup",
handler: (event: ViewerMouseEvent) => void)
: void;
/**
* Fired when the viewer motion stops and it is in a fixed
* position with a fixed point of view.
*
* @event moveend
* @example
* ```js
* // Initialize the viewer
* var viewer = new Viewer({ // viewer options });
* // Set an event listener
* viewer.on("moveend", function() {
* console.log("A moveend event has occurred.");
* });
* ```
*/
public on(
type: "moveend",
handler: (event: ViewerStateEvent) => void)
: void;
/**
* Fired when the motion from one view to another start,
* either by changing the position (e.g. when changing image)
* or when changing point of view
* (e.g. by interaction such as pan and zoom).
*
* @event movestart
* @example
* ```js
* // Initialize the viewer
* var viewer = new Viewer({ // viewer options });
* // Set an event listener
* viewer.on("movestart", function() {
* console.log("A movestart event has occurred.");
* });
* ```
*/
public on(
type: "movestart",
handler: (event: ViewerStateEvent) => void)
: void;
/**
* Fired when the navigable state of the viewer changes.
*
* @event navigable
* @example
* ```js
* // Initialize the viewer
* var viewer = new Viewer({ // viewer options });
* // Set an event listener
* viewer.on("navigable", function() {
* console.log("A navigable event has occurred.");
* });
* ```
*/
public on(
type: "navigable",
handler: (event: ViewerNavigableEvent) => void)
: void;
/**
* Fired every time the viewer navigates to a new image.
*
* @event image
* @example
* ```js
* // Initialize the viewer
* var viewer = new Viewer({ // viewer options });
* // Set an event listener
* viewer.on("image", function() {
* console.log("A image event has occurred.");
* });
* ```
*/
public on(
type: "image",
handler: (event: ViewerImageEvent) => void)
: void;
/**
* Fired when the viewer's position changes.
*
* @description The viewer's position changes when transitioning
* between images.
*
* @event position
* @example
* ```js
* // Initialize the viewer
* var viewer = new Viewer({ // viewer options });
* // Set an event listener
* viewer.on("position", function() {
* console.log("A position event has occurred.");
* });
* ```
*/
public on(
type: "position",
handler: (event: ViewerStateEvent) => void)
: void;
/**
* Fired when the viewer's point of view changes. The
* point of view changes when the bearing, or tilt changes.
*
* @event pov
* @example
* ```js
* // Initialize the viewer
* var viewer = new Viewer({ // viewer options });
* // Set an event listener
* viewer.on("pov", function() {
* console.log("A pov event has occurred.");
* });
* ```
*/
public on(
type: "pov",
handler: (event: ViewerStateEvent) => void)
: void;
/**
* Fired when the viewer's reference position changes.
*
* The reference position specifies the origin in
* the viewer's topocentric coordinate system.
*
* @event reference
* @example
* ```js
* // Initialize the viewer
* var viewer = new Viewer({ // viewer options });
* // Set an event listener
* viewer.on("reference", function(reference) {
* console.log("A reference event has occurred.");
* });
* ```
*/
public on(
type: "reference",
handler: (event: ViewerReferenceEvent) => void)
: void;
/**
* Fired when the viewer is removed. After this event is emitted
* you must not call any methods on the viewer.
*
* @event remove
* @example
* ```js
* // Initialize the viewer
* var viewer = new Viewer({ // viewer options });
* // Set an event listener
* viewer.on("remove", function() {
* console.log("A remove event has occurred.");
* });
* ```
*/
public on(
type: "remove",
handler: (event: ViewerStateEvent) => void)
: void;
/**
* Fired every time the sequence edges of the current image changes.
*
* @event sequenceedges
* @example
* ```js
* // Initialize the viewer
* var viewer = new Viewer({ // viewer options });
* // Set an event listener
* viewer.on("sequenceedges", function() {
* console.log("A sequenceedges event has occurred.");
* });
* ```
*/
public on(
type: "sequenceedges",
handler: (event: ViewerNavigationEdgeEvent) => void)
: void;
/**
* Fired every time the spatial edges of the current image changes.
*
* @event spatialedges
* @example
* ```js
* // Initialize the viewer
* var viewer = new Viewer({ // viewer options });
* // Set an event listener
* viewer.on("spatialedges", function() {
* console.log("A spatialedges event has occurred.");
* });
* ```
*/
public on(
type: "spatialedges",
handler: (event: ViewerNavigationEdgeEvent) => void)
: void;
public on<T>(
type: ViewerEventType,
handler: (event: T) => void)
: void {
super.on(type, handler);
}