@mescius/dsimageviewer/typings/ImageViewer/Models/EventArgs.d.ts

Document Solutions Image Viewer

import { GcImageViewer } from "../GcImageViewer";
import { OpenParameters } from "./Types";
/**
 * Event name.
 **/
export declare type EventName = "ErrorEvent" | "BeforeOpenEvent" | "AfterOpenEvent" | "ThemeChangedEvent" | "ImagePaint";
/**
 * Base type for event arguments.
 **/
export declare type EventArgs = {
    /**
     * Event name.
     **/
    eventName?: EventName;
    /**
     * Event source.
     **/
    source?: GcImageViewer;
};
/**
 * Base type for cancelable event arguments.
 **/
export declare type CancelEventArgs = {
    /**
     * Indicates whether the event should be canceled.
     **/
    cancel?: boolean;
} & EventArgs;
/**
 * Error event arguments.
 **/
export declare type ErrorEventArgs = {
    /**
     * Message.
     **/
    readonly message: string;
    /**
     * Event type
     **/
    readonly type: 'open' | string;
    /**
     * Exception object.
     **/
    readonly exception?: any;
} & EventArgs;
/**
 * Before open event arguments.
 **/
export declare type BeforeOpenEventArgs = {
    /**
     * Payload data.
     **/
    readonly payload: Uint8Array | string;
    /**
     * Payload data type.
     **/
    readonly type: 'binary' | 'url';
    /**
     * Open parameters.
     **/
    openParameters: OpenParameters;
} & EventArgs;
/**
 * After open event arguments.
 **/
export declare type AfterOpenEventArgs = {} & EventArgs;
/**
 * Theme changed event arguments.
 * @ignore exclude from docs
 **/
export declare type ThemeChangedEventArgs = {
    /**
     * Theme name.
     **/
    readonly theme: string;
} & EventArgs;
/**
 * Image paint event arguments.
 **/
export declare type ImagePaintEventArgs = {
    /**
     * Destination DOM element.
     **/
    readonly paneElement: HTMLElement;
} & EventArgs;