Back to Website
Show / Hide Table of Contents

Interface ICommandManager

Package: @aurigma/design-atoms-interfaces

Methods

execute(name, args)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

Declaration
execute?(name: ItemsCommand.alignItems, args: IAlignItemsCommandArgs<TPrintArea, TSafetyLine, TItem>, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
alignItems name
IAlignItemsCommandArgs<TPrintArea, TSafetyLine, TItem> 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
groupAlign name
IGroupAlignCommandArgs args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

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

execute(name, args)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

Declaration
execute?(name: ItemsCommand.placeholderContentRotate, args: IPlaceholderContentRotateCommandArgs<TItem>, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
placeholderContentRotate name
IPlaceholderContentRotateCommandArgs<TItem> 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.insertItemsIntoArea, args: IInsertItemsIntoAreaCommandArgs<TItem>, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
insertItemsIntoArea name
IInsertItemsIntoAreaCommandArgs<TItem> args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

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.placeItemsToArea, args: IPlaceItemsToAreaCommandArgs<TItem, TRectangleF>, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
placeItemsToArea name
IPlaceItemsToAreaCommandArgs<TItem, TRectangleF> args
HistoryUpdateMode historyUpdateMode
Returns
Type Description
Promise<void>

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args)

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

execute(name, args, historyUpdateMode)

Declaration
execute?(name: ItemsCommand.distributeItems, args: IDistributeItemsCommandArgs<TItem>, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
Parameters
Type Name Description
distributeItems name
IDistributeItemsCommandArgs<TItem> 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: SelectionCommand.selectItems, args: ISelectItemsCommandArgs<TItem>): Promise<void>;
Parameters
Type Name Description
selectItems name
ISelectItemsCommandArgs<TItem> args
Returns
Type Description
Promise<void>

execute(name)

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

execute(name)

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

execute(name, args)

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

execute(name)

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

execute(name, args)

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

execute(name, args)

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

execute(name)

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

execute(name, args)

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

execute(name, args)

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

execute(name, args, historyUpdateMode)

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

execute(name, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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

execute(name, args, historyUpdateMode)

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