Interface ISetMockupOptions

A structure defining options for managing history and surface size when changing mockups.

Package: @aurigma/design-editor-iframe

Remarks

Product.setMockups() uses this structure.

Examples

options: {
    updateRevertData: false,
    addToHistory: false,
    updateSurfaceSize: true,
    resetHistory: true
}

Properties

addToHistory

If true, adds a new user action to the history to allow your users to revert new mockups by using the **Undo** button. If false, will not add a single action to the history, because of that the mockup can be reverted together with the following user action. The default value is true.

Declaration

addToHistory?: boolean;

Property Value

Type	Description
boolean	If true, adds a new user action to the history to allow your users to revert new mockups by using the **Undo** button. If false, will not add a single action to the history, because of that the mockup can be reverted together with the following user action. The default value is true.

resetHistory

If true, resets the history of user actions after changing the mockups. The default value is false.

Declaration

resetHistory?: boolean;

Property Value

Type	Description
boolean	If true, resets the history of user actions after changing the mockups. The default value is false.

updateRevertData

If true, the new mockup is stored as one to restore when the product is reverted. Otherwise, the previously stored mockup is restored on a product revert. The default value is true.

Declaration

updateRevertData?: boolean;

Property Value

Type	Description
boolean	If true, the new mockup is stored as one to restore when the product is reverted. Otherwise, the previously stored mockup is restored on a product revert. The default value is true.

updateSurfaceSize

If true, changes the surface size to match the new mockup. If false, the surface size remains unchanged. The default value is false.

Declaration

updateSurfaceSize?: boolean;

Property Value

Type	Description
boolean	If true, changes the surface size to match the new mockup. If false, the surface size remains unchanged. The default value is false.