cc-everywhere

Class: EditorWorkflow

Extends

Implements

Constructors

Constructor

new EditorWorkflow(actionManager, context): EditorWorkflow;

Parameters

Parameter
Type
actionManager
ActionManager
context
SDKContext

Returns

EditorWorkflow

Inherited from

BaseWorkflow.constructor

Methods

create()

create(
   docConfig?, 
   appConfig?, 
   exportConfig?, 
   containerConfig?): void;

Start the editor workflow with an empty canvas

Parameters

Parameter
Type
Description
docConfig?
CreateDocConfig
pass a custom canvas size
appConfig?
BaseEditorAppConfig
properties to configure the Editor
exportConfig?
ExportOptions
properties to configure the export options
containerConfig?
ContainerConfig
properties to configure the SDK container

Returns

void

Implementation of

EditorWorkflow.create

createWithAsset()

createWithAsset(
   docConfig, 
   appConfig?, 
   exportConfig?, 
   containerConfig?): void;

Start the editor workflow by passing an image asset

Parameters

Parameter
Type
Description
docConfig
CreateWithAssetDocConfig
pass an image asset as base64
appConfig?
BaseEditorAppConfig
properties to configure the Editor
exportConfig?
ExportOptions
properties to configure the export options
containerConfig?
ContainerConfig
properties to configure the SDK container

Returns

void

Implementation of

EditorWorkflow.createWithAsset

createWithTemplate()

createWithTemplate(
   docConfig, 
   appConfig?, 
   exportConfig?, 
   containerConfig?): void;

Start the editor workflow by passing an Express Template ID

Parameters

Parameter
Type
Description
docConfig
CreateWithTemplateDocConfig
pass a template ID
appConfig?
BaseEditorAppConfig
properties to configure the Editor
exportConfig?
ExportOptions
properties to configure the export options
containerConfig?
ContainerConfig
properties to configure the SDK container

Returns

void

Implementation of

EditorWorkflow.createWithTemplate

edit()

edit(
   docConfig, 
   appConfig?, 
   exportConfig?, 
   containerConfig?): void;

Start the editor workflow by passing an Express Document ID

Parameters

Parameter
Type
Description
docConfig
EditDocConfig
pass an Express Document ID
appConfig?
BaseEditorAppConfig
properties to configure the Editor
exportConfig?
ExportOptions
properties to configure the export options
containerConfig?
ContainerConfig
properties to configure the SDK container

Returns

void

Implementation of

EditorWorkflow.edit