Back to Website
Show / Hide Table of Contents

Class CommandManager

Package: @aurigma/design-atoms

Constructors

(constructor)(_history, _productHandler, _productThemeManager, _variableItemHelper, _eventManager, _canvas, _itemsDataApplier)

Constructs a new instance of the CommandManager class

Declaration
constructor(_history: History, _productHandler: ProductHandler, _productThemeManager: ProductThemeManager, _variableItemHelper: VariableItemHelper, _eventManager: EventManager, _canvas: Canvas, _itemsDataApplier: ItemsDataApplier);
Parameters
Type Name Description
History_2 _history
ProductHandler _productHandler
ProductThemeManager _productThemeManager
VariableItemHelper _variableItemHelper
EventManager _eventManager
Canvas _canvas
ItemsDataApplier _itemsDataApplier

Properties

configuration

Declaration
configuration: IViewerConfiguration;
Property Value
Type Description
IViewerConfiguration

Methods

_log(name, args)

Declaration
protected _log(name: string, args?: any): void;
Parameters
Type Name Description
string name
any args
Returns
Type Description
void

execute(name, args)

Declaration
execute(name: SurfaceSwitchCommand.switchToSurface, args: ISwitchToSurfaceParams): Promise<void>;
Parameters
Type Name Description
switchToSurface name
ISwitchToSurfaceParams args
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ProductCommand.applyProductTheme, args: IApplyProductThemeCmdArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ProductCommand.applyProductTheme name
IApplyProductThemeCmdArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ProductCommand.resize, args: IResizeArgs | IExternalResizeArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ProductCommand.resize name
IResizeArgs | IExternalResizeArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: SurfaceCommand.addItems, args: IAddItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
SurfaceCommand.addItems name
IAddItemsCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: SurfaceCommand.setBleed, args: ISetBleedCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
SurfaceCommand.setBleed name
ISetBleedCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: SurfaceCommand.setSlug, args: ISetSlugCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
SurfaceCommand.setSlug name
ISetSlugCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.deleteItems, args: IDeleteItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.deleteItems name
IDeleteItemsCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.cloneItems, args: ICloneItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.cloneItems name
ICloneItemsCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.addContent, args: IAddContentCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.addContent name
IAddContentCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.alignItems, args: IAlignItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.alignItems name
IAlignItemsCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.groupAlign, args: IGroupAlignCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.groupAlign name
IGroupAlignCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args)

Declaration
execute(name: SurfaceSwitchCommand.getNextSurface, args?: IGetNextSurfaceCmdName): Promise<Surface>;
Parameters
Type Name Description
getNextSurface name
IGetNextSurfaceCmdName args
Returns
Type Description
Promise<Surface>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.bringItems, args: IBringItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.bringItems name
IBringItemsCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.moveItem, args: IMoveItemCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.moveItem name
IMoveItemCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.createItem, args: ICreateItemCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<Item>;
Parameters
Type Name Description
ItemsCommand.createItem name
ICreateItemCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<Item>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.editItems, args: IEditItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.editItems name
IEditItemsCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.setImageMetadata, args: ISetImageMetadataCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.setImageMetadata name
ISetImageMetadataCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.setImageItem, args: ISetImageItemCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.setImageItem name
ISetImageItemCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.placeholderContentScale, args: IPlaceholderContentScaleCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.placeholderContentScale name
IPlaceholderContentScaleCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.placeholderContentReset, args?: IPlaceholderContentResetCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.placeholderContentReset name
IPlaceholderContentResetCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.changeBarcodeFormat, args: IChangeBarcodeFormatCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.changeBarcodeFormat name
IChangeBarcodeFormatCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.changeColumnCount, args: IChangeColumnCountCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.changeColumnCount name
IChangeColumnCountCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name)

Declaration
execute(name: SurfaceSwitchCommand.switchToNextSurface): Promise<void>;
Parameters
Type Name Description
switchToNextSurface name
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.placeholderContentRotate, args: IPlaceholderContentRotateCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.placeholderContentRotate name
IPlaceholderContentRotateCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.insertItemsIntoArea, args: IInsertItemsIntoAreaCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.insertItemsIntoArea name
IInsertItemsIntoAreaCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.changeLayout, args: IChangeLayoutCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.changeLayout name
IChangeLayoutCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.groupItems, args: IGroupItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.groupItems name
IGroupItemsCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.ungroupItems, args: IUngroupItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.ungroupItems name
IUngroupItemsCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.replaceGroupItemContent, args: IReplaceGroupItemContentCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.replaceGroupItemContent name
IReplaceGroupItemContentCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.changeClipartItemColor, args: IChangeClipartItemColorArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.changeClipartItemColor name
IChangeClipartItemColorArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.translateItems, args: ITranslateItemCommandArgs | IExternalTranslateItemCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.translateItems name
ITranslateItemCommandArgs | IExternalTranslateItemCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.convertGroupIntoLayout, args: IConvertGroupIntoLayoutArgs, historyUpdateMode?: HistoryUpdateMode): Promise<LayoutItem[]>;
Parameters
Type Name Description
ItemsCommand.convertGroupIntoLayout name
IConvertGroupIntoLayoutArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<LayoutItem[]>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.convertLayoutIntoGroup, args: IConvertLayoutIntoGroupArgs, historyUpdateMode?: HistoryUpdateMode): Promise<GroupItem[]>;
Parameters
Type Name Description
ItemsCommand.convertLayoutIntoGroup name
IConvertLayoutIntoGroupArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<GroupItem[]>

execute(name)

Declaration
execute(name: SurfaceSwitchCommand.switchSurfaceForward): Promise<void>;
Parameters
Type Name Description
switchSurfaceForward name
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.convertItemToPlaceholder, args: IConvertItemToPlaceholderCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<PlaceholderItem>;
Parameters
Type Name Description
ItemsCommand.convertItemToPlaceholder name
IConvertItemToPlaceholderCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<PlaceholderItem>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.convertPlaceholderToItem, args: IConvertPlaceholderToItemCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<Item>;
Parameters
Type Name Description
ItemsCommand.convertPlaceholderToItem name
IConvertPlaceholderToItemCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<Item>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.placeItemsToArea, args: IPlaceItemsToAreaCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.placeItemsToArea name
IPlaceItemsToAreaCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.convertTextItem, args: IConvertTextItemCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<PlainTextItem>;
Parameters
Type Name Description
ItemsCommand.convertTextItem name
IConvertTextItemCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<PlainTextItem>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.transformItems, args: ITransformItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.transformItems name
ITransformItemsCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.rotateItems, args: IRotateItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.rotateItems name
IRotateItemsCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.fixUnsupportedText, args: IFixUnsupportedTextCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<BaseTextItem>;
Parameters
Type Name Description
ItemsCommand.fixUnsupportedText name
IFixUnsupportedTextCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<BaseTextItem>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.replaceItemCommand, args: IReplaceItemCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.replaceItemCommand name
IReplaceItemCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.newTranslateItems, args: INewTranslateItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.newTranslateItems name
INewTranslateItemsCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.resizeItems, args: IResizeItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.resizeItems name
IResizeItemsCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name)

Declaration
execute(name: SurfaceSwitchCommand.switchSurfaceBackward): Promise<void>;
Parameters
Type Name Description
switchSurfaceBackward name
Returns
Type Description
Promise<void>

execute(name, args)

Declaration
execute(name: ItemsCommand.editPlaceholder, args: IEditPlaceholderCommandArgs): Promise<void>;
Parameters
Type Name Description
ItemsCommand.editPlaceholder name
IEditPlaceholderCommandArgs args
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ItemsCommand.distributeItems, args: IDistributeItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
ItemsCommand.distributeItems name
IDistributeItemsCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args)

Declaration
execute(name: SelectionCommand.selectItems, args: ISelectItemsCommandArgs): Promise<void>;
Parameters
Type Name Description
SelectionCommand.selectItems name
ISelectItemsCommandArgs args
Returns
Type Description
Promise<void>

execute(name)

Declaration
execute(name: SelectionCommand.selectFirst): Promise<void>;
Parameters
Type Name Description
SelectionCommand.selectFirst name
Returns
Type Description
Promise<void>

execute(name)

Declaration
execute(name: SelectionCommand.clearSelection): Promise<void>;
Parameters
Type Name Description
SelectionCommand.clearSelection name
Returns
Type Description
Promise<void>

execute(name, args)

Declaration
execute(name: SelectionCommand.selectItemsByRect, args: ISelectItemsByRectArgs): Promise<void>;
Parameters
Type Name Description
SelectionCommand.selectItemsByRect name
ISelectItemsByRectArgs args
Returns
Type Description
Promise<void>

execute(name)

Declaration
execute(name: SelectionCommand.selectAll): Promise<void>;
Parameters
Type Name Description
SelectionCommand.selectAll name
Returns
Type Description
Promise<void>

execute(name, args)

Declaration
execute(name: ZoomCommand.zoomToItems, args: IZoomToItemsCommandArgs): Promise<void>;
Parameters
Type Name Description
ZoomCommand.zoomToItems name
IZoomToItemsCommandArgs args
Returns
Type Description
Promise<void>

execute(name, args)

Declaration
execute(name: ZoomCommand.zoomToSafetyLine, args: IZoomToSafetyLineCommandArgs): Promise<void>;
Parameters
Type Name Description
ZoomCommand.zoomToSafetyLine name
IZoomToSafetyLineCommandArgs args
Returns
Type Description
Promise<void>

execute(name)

Declaration
execute(name: ZoomCommand.zoomToSelection): Promise<void>;
Parameters
Type Name Description
ZoomCommand.zoomToSelection name
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ProductCommand.rotateProduct, args: IRotateProductCmdArgs, historyUpdateMode?: HistoryUpdateMode): Promise<number>;
Parameters
Type Name Description
ProductCommand.rotateProduct name
IRotateProductCmdArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<number>

execute(name, args)

Declaration
execute(name: ZoomCommand.setZoom, args: ISetZoomCommandArgs): Promise<void>;
Parameters
Type Name Description
ZoomCommand.setZoom name
ISetZoomCommandArgs args
Returns
Type Description
Promise<void>

execute(name, args)

Declaration
execute(name: ViewerCommand.moveViewPort, args: IMoveViewportCommandArgs): Promise<void>;
Parameters
Type Name Description
ViewerCommand.moveViewPort name
IMoveViewportCommandArgs args
Returns
Type Description
Promise<void>

execute(name, args)

Declaration
execute(name: ColorCommand.parseColor, args: IParseColorCommandArgs): Promise<Color>;
Parameters
Type Name Description
ColorCommand.parseColor name
IParseColorCommandArgs args
Returns
Type Description
Promise<Color>

execute(name, historyUpdateMode)

Declaration
execute(name: ProductCommand.replaceInterpolationPlaceholders, historyUpdateMode?: HistoryUpdateMode): Promise<BaseTextItem[]>;
Parameters
Type Name Description
ProductCommand.replaceInterpolationPlaceholders name
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<BaseTextItem[]>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ProductCommand.changeBackground, args: IChangeBgArgs, historyUpdateMode?: HistoryUpdateMode): Promise<Item[]>;
Parameters
Type Name Description
ProductCommand.changeBackground name
IChangeBgArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<Item[]>

execute(name, args, historyUpdateMode)

Declaration
execute(name: ProductCommand.fillPlaceholders, args: IFillPlaceholdersCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<Item[]>;
Parameters
Type Name Description
ProductCommand.fillPlaceholders name
IFillPlaceholdersCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<Item[]>
Was this page helpful?
Thanks for your feedback!
Back to top Copyright © 2001–2025 Aurigma, Inc. All rights reserved.
Loading...
    Thank for your vote
    Your opinion is important to us. To provide details, send feedback.
    Send feedback