Event types related to the editor. Used for registering to events. See Register for more information.

Enumeration Members

AddToBasket: "AddToBasket"

Called instead of the add to basket action. This is only used if adding to basket is disabled, but the attempt has been made - see AddToBasket.

AfterClosePreview: "ClosePreview"

Called after the view switched back from the preview.

  • event data: null
  • cannot be cancelled
AfterEditorCanvasChanged: "Editor.CanvasChanged"

Called after the canvas has been changed.

AfterEditorOutputTypeChanged: "Editor.OutputTypeChanged"

Called after the output type has been changed.

AfterEditorStockChanged: "Editor.StockChanged"

Called after the stock has been changed.

AfterLayoutChanged: "LayoutChanged"

Called after the layout has been changed.

AfterOpenPreview: "OpenPreview"

Called after the view switched to the preview.

  • event data: null
  • cannot be cancelled
AfterToggleFullScreen: "ToggleFullScreen"

Called after the view is switched between normal and fullscreen mode.

  • event data: null
  • cannot be cancelled
BatchDataSaved: "BatchDataSaved"

Called when the batch data has been saved server side.

  • event data: null
  • cannot be cancelled
BeforeAddToBasket: "AddToBasketPreSave"

Called before attempting to add the item to the cart.

  • event data: null
  • can be cancelled
BeforeClosePreview: "Before.ClosePreview"

Called before the view switched back from the preview.

  • event data: null
  • can be cancelled
BeforeEditorCanvasChanged: "Before.Editor.CanvasChanged"

Called before the canvas is changed.

BeforeEditorOutputTypeChanged: "Before.Editor.OutputTypeChanged"

Called before the output type is changed.

BeforeEditorStockChanged: "Before.Editor.StockChanged"

Called before the stock is changed.

BeforeLayoutChanged: "Before.LayoutChanged"

Called before the layout is changed.

BeforeOpenPreview: "Before.OpenPreview"

Called before the view switched to the preview.

  • event data: null
  • can be cancelled
BeforePageAdded: "Before.PageAdded"

Called before a page is added.

  • event data: PageEventData - this is the id after which the new page is to be added
  • can be cancelled
BeforePageChanged: "Before.PageChanged"

Called before a page change is performed.

BeforePageDeleted: "Before.PageDeleted"

Called before a page will be deleted.

BeforePageMoved: "Before.PageMoved"

Called before a page is moved.

BeforeSaveAsProject: "SaveAsProjectPreSave"

Called before attempting to save the project.

  • event data: null
  • can be cancelled
BeforeSaveEmbedded: "SaveEmbeddedPreSave"

Called before performing an embedded save. Embedded saves are used for iFrame implementations.

  • event data: null
  • can be cancelled
BeforeToggleFullScreen: "Before.ToggleFullScreen"

Called before the view is switched between normal and fullscreen mode.

  • event data: null
  • can be cancelled
EditorExternalDataUpdate: "Editor.ExternalDataUpdate"

Used in an iFrame context only. Can be used to receive data from the hosting application. Generally used to share and exchange data, like options selected for the product or information about the user.

  • event data: unknown (as it can be anything coming from the outside)
  • cannot be cancelled
EditorLoaded: "Editor.Loaded"

Called when the editor is fully loaded and ready to be used.

  • event data: null
  • cannot be cancelled
FabricModified: "Fabric.Modified"

Called when modifications are made to the fabric.js canvas.

  • event data: null
  • cannot be cancelled
FieldTextFlowFinished: "Field.TextFlowFinished"

Called when the text flow operation finished.

MappingSaved: "MappingSaved"

Called when the batch mapping has been saved server side.

  • event data: null
  • cannot be cancelled
PageAdded: "PageAdded"

Called after a page has been added.

  • event data: PageEventData - this is the id of the newly added page
  • cannot be cancelled
PageChanged: "PageChanged"

Called after the page has changed

PageDeleted: "PageDeleted"

Called after a page has been deleted.

PageMoved: "PageMoved"

Called after a page has been moved.

PageSetFill: "Page.SetFill"

Called when the background of a page is set

SaveAsProject: "SaveAsProject"

Called instead of the save as project action. This is only used if saving as project is disabled, but the attempt has been made - see SaveAsProject. If saving as project would not be disabled, the editor will save and exit, so the script would not receive that event.

  • event data: null
  • cannot be cancelled
UpdateViewPort: "Editor.UpdateViewPort"

Called after the view port in the editor has been updated.

  • event data: null
  • cannot be cancelled
UploadFailed: "Upload.Failed"

Called when the current upload failed.

  • event data: null
  • cannot be cancelled
UploadFinalized: "Upload.Finalized"

Called when the upload has been finalized and upload is not performed anymore.

  • event data: null
  • cannot be cancelled
UploadFinished: "Upload.Finished"

Called when the upload has been finished.

UploadProcessStop: "Upload.Process.Stop"

Called when the current upload stops.

  • event data: null
  • cannot be cancelled
UploadStarted: "Upload.Started"

Called when the upload has been started already

Generated using TypeDoc