CommandManager

Classes

CommandManager

Implements

• ICommandManager
• IExternalCommandManager

Constructors

Constructor

new CommandManager(
   history, 
   productHandler, 
   productThemeManager, 
   variableItemHelper, 
   eventManager, 
   canvas, 
   itemsDataApplier): CommandManager;

Parameters

Parameter	Type
history	History
productHandler	ProductHandler
productThemeManager	ProductThemeManager
variableItemHelper	VariableItemHelper
eventManager	EventManager
canvas	Canvas
itemsDataApplier	ItemsDataApplier

Returns

CommandManager

Properties

configuration

configuration: IViewerConfiguration;

Methods

execute()

Call Signature

execute(name, args): Promise<void>;

Parameters

Parameter	Type
name	switchToSurface
args	ISwitchToSurfaceParams

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(name, args?): Promise<Surface>;

Parameters

Parameter	Type
name	getNextSurface
args?	IGetNextSurfaceCmdName

Returns

Promise<Surface>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(name): Promise<void>;

Parameters

Parameter	Type
name	switchToNextSurface

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(name): Promise<void>;

Parameters

Parameter	Type
name	switchSurfaceForward

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(name): Promise<void>;

Parameters

Parameter	Type
name	switchSurfaceBackward

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<number>;

Parameters

Parameter	Type
name	rotateProduct
args	IRotateProductCmdArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<number>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(name, historyUpdateMode?): Promise<BaseTextItem[]>;

Parameters

Parameter	Type
name	replaceInterpolationPlaceholders
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<BaseTextItem[]>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<Item[]>;

Parameters

Parameter	Type
name	changeBackground
args	IChangeBgArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<Item[]>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<Item[]>;

Parameters

Parameter	Type
name	fillPlaceholders
args	IFillPlaceholdersCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<Item[]>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	applyProductTheme
args	IApplyProductThemeCmdArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	resize
args	| IResizeArgs | IExternalResizeArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	removeSurface
args	IRemoveSurfaceCommandsArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	addSurfaces
args	IAddSurfaceCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	updateSurfaces
args	IUpdateSurfaceOptions<Product>
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	addItems
args	IAddItemsCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	setBleed
args	ISetBleedCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	setSlug
args	ISetSlugCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	deleteItems
args	IDeleteItemsCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	cloneItems
args	ICloneItemsCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	addContent
args	IAddContentCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	alignItems
args	IAlignItemsCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	groupAlign
args	IGroupAlignCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	bringItems
args	IBringItemsCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	moveItem
args	IMoveItemCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<Item>;

Parameters

Parameter	Type
name	createItem
args	ICreateItemCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<Item>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	editItems
args	IEditItemsCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	setImageMetadata
args	ISetImageMetadataCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	setImageItem
args	ISetImageItemCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	placeholderContentScale
args	IPlaceholderContentScaleCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args?, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	placeholderContentReset
args?	IPlaceholderContentResetCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	changeBarcodeFormat
args	IChangeBarcodeFormatCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	changeColumnCount
args	IChangeColumnCountCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	placeholderContentRotate
args	IPlaceholderContentRotateCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	insertItemsIntoArea
args	IInsertItemsIntoAreaCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	changeLayout
args	IChangeLayoutCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	groupItems
args	IGroupItemsCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	ungroupItems
args	IUngroupItemsCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	replaceGroupItemContent
args	IReplaceGroupItemContentCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	changeClipartItemColor
args	IChangeClipartItemColorArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	translateItems
args	| ITranslateItemCommandArgs | IExternalTranslateItemCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<LayoutItem[]>;

Parameters

Parameter	Type
name	convertGroupIntoLayout
args	IConvertGroupIntoLayoutArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<LayoutItem[]>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<GroupItem[]>;

Parameters

Parameter	Type
name	convertLayoutIntoGroup
args	IConvertLayoutIntoGroupArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<GroupItem[]>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<PlaceholderItem>;

Parameters

Parameter	Type
name	convertItemToPlaceholder
args	IConvertItemToPlaceholderCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<PlaceholderItem>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<Item>;

Parameters

Parameter	Type
name	convertPlaceholderToItem
args	IConvertPlaceholderToItemCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<Item>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	placeItemsToArea
args	IPlaceItemsToAreaCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<PlainTextItem>;

Parameters

Parameter	Type
name	convertTextItem
args	IConvertTextItemCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<PlainTextItem>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	transformItems
args	ITransformItemsCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	rotateItems
args	IRotateItemsCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<BaseTextItem>;

Parameters

Parameter	Type
name	fixUnsupportedText
args	IFixUnsupportedTextCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<BaseTextItem>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	replaceItemCommand
args	IReplaceItemCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	newTranslateItems
args	INewTranslateItemsCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	resizeItems
args	IResizeItemsCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(name, args): Promise<void>;

Parameters

Parameter	Type
name	editPlaceholder
args	IEditPlaceholderCommandArgs

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	distributeItems
args	IDistributeItemsCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(name, args): Promise<void>;

Parameters

Parameter	Type
name	selectItems
args	ISelectItemsCommandArgs

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(name): Promise<void>;

Parameters

Parameter	Type
name	selectFirst

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(name): Promise<void>;

Parameters

Parameter	Type
name	clearSelection

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(name, args): Promise<void>;

Parameters

Parameter	Type
name	selectItemsByRect
args	ISelectItemsByRectArgs

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(name): Promise<void>;

Parameters

Parameter	Type
name	selectAll

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(name, args): Promise<void>;

Parameters

Parameter	Type
name	zoomToItems
args	IZoomToItemsCommandArgs

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(name, args): Promise<void>;

Parameters

Parameter	Type
name	zoomToSafetyLine
args	IZoomToSafetyLineCommandArgs

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(name): Promise<void>;

Parameters

Parameter	Type
name	zoomToSelection

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(name, args): Promise<void>;

Parameters

Parameter	Type
name	setZoom
args	ISetZoomCommandArgs

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(name, args): Promise<void>;

Parameters

Parameter	Type
name	moveViewPort
args	IMoveViewportCommandArgs

Returns

Promise<void>

Implementation of

IExternalCommandManager.execute

Call Signature

execute(name, args): Promise<Color>;

Parameters

Parameter	Type
name	parseColor
args	IParseColorCommandArgs

Returns

Promise<Color>

Implementation of

IExternalCommandManager.execute

Interfaces

IExternalCommandManager

Methods

execute()?

Call Signature

optional execute(
   name, 
   args, 
historyUpdateMode?): Promise<void>;

Parameters

Parameter	Type
name	translateItems
args	IExternalTranslateItemCommandArgs
historyUpdateMode?	HistoryUpdateMode

Returns

Promise<void>

Call Signature

optional execute(
   name, 
   args, 
   historyUpdateMode?): any;

Parameters

Parameter	Type
name	resize
args	IExternalResizeArgs
historyUpdateMode?	HistoryUpdateMode

Returns

any