@aurigma/design-editor-iframe/GlobalEvents.d.ts

Using this module you can embed Design Editor (a part of Customer's Canvas) to your page through the IFrame API.

/**
 * Events enumeration.
 * @internal
 */
export declare enum GlobalEvents {
    /**
     * Fires when the editor is opened in a modal window.
     */
    ModalOpen = 0,
    /**
     * Fires when the editor is closed in a modal window.
     */
    ModalClose = 1,
    /**
     * Fires when the editor is switched to the full screen mode.
     */
    FullScreen = 2,
    /**
     * Fires when the editor is switched to the full window mode.
     */
    FullWindow = 3,
    /**
     * Fires when the editor is switched to the original size mode.
     */
    OriginalSize = 4,
    /**
     * Fires when the Image Manager opens.
     */
    AssetManagerOpened = 5,
    /**
     * Fires when the Image Manager closes.
     */
    AssetManagerClosed = 6,
    /**
     * Fires when a user reverts a product in the editor.
     */
    RevertProduct = 7,
    /**
     * Fires when a user changes visibility of the Object Inspector.
     */
    ObjectInspectorVisibilityChange = 8,
    /**
     * Fires when a user switches surfaces.
     */
    OnSurfaceChanged = 9,
    /**
     * Fires when the Redo button gets enabled in the editor.
     */
    CanRedoChanged = 10,
    /**
     * Fires when the Undo button gets enabled in the editor.
     */
    CanUndoChanged = 11,
    /**
     * Fires when a user resizes images.
     */
    OnImageDpiChanged = 12,
    /**
     * Fires when a dialog box opens.
     * <i>Deprecated. Instead, you can subscribe to {@link GlobalEvents.UIElementStateChange} with the `TextPopup` argument.</i>
     *
     * @deprecated Instead, subscribe to `UIElementStateChange` with the `TextPopup` argument.
     */
    PopupOpen = 13,
    /**
     * Fires when the size of a print area changes, for example, after using {@link Surface.setPrintAreas|`setPrintAreas()`}.
     */
    PrintAreaBoundsChanged = 14,
    /**
     * Fires when a user clicks the Undo button.
     */
    UndoProduct = 15,
    /**
     * Fires when a user clicks the Redo button.
     */
    RedoProduct = 16,
    /**
     * Fires when a UI element is opened or closed in the editor. The current implementation only supports the `TextPopup`, `BottomToolbar.Zoom`, and `BottomToolbar.Settings` controls.
     */
    UIElementStateChange = 17,
    /**
     * Fires when custom button is clicked.
     */
    CustomButtonClicked = 18
}
/**
 * Arguments of the `UIElementStateChange` event.
 * @example You can pass these arguments as follows:
 * ``` json
 * {
 *    "element": "BottomToolbar.Zoom",
 *    "isOpen": true
 * }
 * ```
 * @public
 */
export declare class UIElementStateChangeEventArgs {
    /** A UI element that opens or closes. The current implementation only supports the `TextPopup`, `BottomToolbar.Zoom`, and `BottomToolbar.Settings` controls. */
    element: string;
    /** Whether the UI element is opened.
     *
     * @remarks
     * If `true`, the element has been opened. If `false`, the element has been closed.
     *
     * @defaultValue `false`
     */
    isOpen?: boolean;
    /**
     * @param element - UI element that opens or closes. The current implementation only supports the `TextPopup`, `BottomToolbar.Zoom`, and `BottomToolbar.Settings` controls.
     * @param isOpen - If `true`, the element has been opened. If `false`, the element has been closed.
     */
    constructor(element: string, isOpen?: boolean);
}
/**
 * Screen modes enumeration.
 * @public
 */
export declare enum WindowMode {
    /**
     * Full screen mode.
     */
    FullScreen = 0,
    /**
     * Full window mode.
     */
    FullWindow = 1,
    /**
     * Original size mode.
     */
    OriginalSize = 2
}