@aurigma/design-atoms/Commands/CommandManager.d.ts

Design Atoms is a part of Customer's Canvas SDK which allows for manipulating individual design elements through your code.

import { History } from "../History";
import { ISwitchToSurfaceParams, IGetNextSurfaceCmdName, SurfaceSwitchCommand } from "../Services/SurfaceManager";
import { IRotateProductCmdArgs } from "./ProductCommand/RotateProductCommand";
import { IChangeBgArgs } from "./ProductCommand/ChangeBackgroundCommand";
import { IAddItemsCommandArgs } from "./SurfaceCommands/AddItemsCommand";
import { IDeleteItemsCommandArgs } from "./ItemsCommands/DeleteItemsCommand";
import { ISelectItemsCommandArgs } from "./SelectionCommand/SelectItemsCommand";
import { ICloneItemsCommandArgs } from "./ItemsCommands/CloneItemsCommand";
import { Surface } from "@aurigma/design-atoms-model/Product";
import { BaseTextItem, GroupItem, Item, LayoutItem, PlaceholderItem, PlainTextItem } from "@aurigma/design-atoms-model/Product/Items";
import { IApplyProductThemeCmdArgs } from "./ProductCommand/ApplyProductThemeCommand";
import { IAddContentCommandArgs } from "./ItemsCommands/AddContentCommand";
import { IAlignItemsCommandArgs } from "./ItemsCommands/AlignItemsCommand";
import { IBringItemsCommandArgs } from "./ItemsCommands/BringItemsCommand";
import { IMoveItemCommandArgs } from "./ItemsCommands/MoveItemCommand";
import { IDistributeItemsCommandArgs } from "./ItemsCommands/DistributeItemsCommand";
import { HistoryUpdateMode } from "./ModelUpdateCommand";
import { ProductHandler } from "../Services/ProductHandler";
import { ProductThemeManager } from "../Services/ProductTheme/ProductThemeManager";
import { VariableItemHelper } from "../Services/VariableItemHelper";
import { EventManager } from "../Services/EventManager";
import { Canvas } from "../Canvas";
import { IViewerConfiguration } from "../Viewer/Interfaces";
import { ICreateItemCommandArgs } from "./ItemsCommands/CreateItemCommand";
import { ItemsDataApplier } from "../Services/ItemsDataApplier";
import { IEditItemsCommandArgs } from "./ItemsCommands/EditItemsCommand";
import { ISetImageMetadataCommandArgs } from "./ItemsCommands/SetImageMetadataCommand";
import { IPlaceholderContentScaleCommandArgs } from "./ItemsCommands/PlaceholderContentScaleCommand";
import { IPlaceholderContentResetCommandArgs } from "./ItemsCommands/PlaceholderContentResetCommand";
import { IChangeBarcodeFormatCommandArgs } from "./ItemsCommands/ChangeBarcodeFormatCommand";
import { IChangeColumnCountCommandArgs } from "./ItemsCommands/ChangeColumnCountCommand";
import { IPlaceholderContentRotateCommandArgs } from "./ItemsCommands/PlaceholderContentRotateCommand";
import { IInsertItemsIntoAreaCommandArgs } from "./ItemsCommands/InsertItemsIntoAreaCommand";
import { IChangeLayoutCommandArgs } from "./ItemsCommands/ChangeLayoutCommand";
import { IGroupItemsCommandArgs } from "./ItemsCommands/GroupItemsCommand";
import { IUngroupItemsCommandArgs } from "./ItemsCommands/UngroupItemsCommand";
import { IReplaceGroupItemContentCommandArgs } from "./ItemsCommands/ReplaceGroupItemContentCommand";
import { IChangeClipartItemColorArgs } from "./ItemsCommands/ChangeClipartItemColor";
import { IFillPlaceholdersCommandArgs } from "./ProductCommand/FillPlaceholdersCommand";
import { IResizeArgs, IExternalResizeArgs } from "./ProductCommand/ResizeCommand";
import { ITranslateItemCommandArgs, IExternalTranslateItemCommandArgs } from "./ItemsCommands/TranslateItemsCommand";
import { IConvertGroupIntoLayoutArgs } from "./ItemsCommands/ConvertGroupIntoLayoutCommand";
import { IConvertLayoutIntoGroupArgs } from "./ItemsCommands/ConvertLayoutIntoGroupCommand";
import { ISetImageItemCommandArgs } from "./ItemsCommands/SetImageItemCommand";
import { IConvertItemToPlaceholderCommandArgs } from "./ItemsCommands/ConvertItemToPlaceholderCommand";
import { IConvertPlaceholderToItemCommandArgs } from "./ItemsCommands/ConvertPlaceholderToItemCommand";
import { ISetBleedCommandArgs } from "./SurfaceCommands/SetBleedCommand";
import { IZoomToItemsCommandArgs } from "./ZoomCommands/ZoomToItemsCommand";
import { IZoomToSafetyLineCommandArgs } from "./ZoomCommands/ZoomToSafetyLineCommand";
import { IPlaceItemsToAreaCommandArgs } from "./ItemsCommands/PlaceItemsToAreaCommand";
import { IFixUnsupportedTextCommandArgs } from "./ItemsCommands/FixUnsupportedTextCommand";
import { IConvertTextItemCommandArgs } from "./ItemsCommands/ConvertTextItemCommand";
import { ISelectItemsByRectArgs } from "./SelectionCommand/SelectItemsByRect";
import { ITransformItemsCommandArgs } from "./ItemsCommands/TransformCommands/TransformItemsCommand";
import { IReplaceItemCommandArgs } from "./ItemsCommands/ReplaceItemsCommand";
import { ISetSlugCommandArgs } from "./SurfaceCommands/SetSlugCommand";
import { IEditPlaceholderCommandArgs } from "./ItemsCommands/EditPlaceholderCommand";
import { IRotateItemsCommandArgs } from "./ItemsCommands/TransformCommands/RotateItemsCommand";
import { INewTranslateItemsCommandArgs } from "./ItemsCommands/TransformCommands/NewTranslateItemsCommand";
import { IResizeItemsCommandArgs } from "./ItemsCommands/TransformCommands/ResizeItemsCommand";
import { IMoveViewportCommandArgs } from "./ViewerCommands/MoveViewportCommand";
import { ISetZoomCommandArgs } from "./ZoomCommands/SetZoomCommand";
import { IGroupAlignCommandArgs, ItemsCommand, ProductCommand, SelectionCommand, SurfaceCommand, ViewerCommand, ZoomCommand, ColorCommand } from "@aurigma/design-atoms-interfaces";
import { ICommandManager } from "./ICommandManager";
import { Color } from "@aurigma/design-atoms-model";
import { IParseColorCommandArgs } from "./ColorCommands/ParseColorCommand";
export declare class CommandManager implements ICommandManager, IExternalCommandManager {
    private _history;
    private _productHandler;
    private _productThemeManager;
    private _variableItemHelper;
    private _eventManager;
    private _canvas;
    private _itemsDataApplier;
    private _surfaceManager;
    configuration: IViewerConfiguration;
    constructor(_history: History, _productHandler: ProductHandler, _productThemeManager: ProductThemeManager, _variableItemHelper: VariableItemHelper, _eventManager: EventManager, _canvas: Canvas, _itemsDataApplier: ItemsDataApplier);
    private get _product();
    execute(name: SurfaceSwitchCommand.switchToSurface, args: ISwitchToSurfaceParams): Promise<void>;
    execute(name: SurfaceSwitchCommand.getNextSurface, args?: IGetNextSurfaceCmdName): Promise<Surface>;
    execute(name: SurfaceSwitchCommand.switchToNextSurface): Promise<void>;
    execute(name: SurfaceSwitchCommand.switchSurfaceForward): Promise<void>;
    execute(name: SurfaceSwitchCommand.switchSurfaceBackward): Promise<void>;
    execute(name: ProductCommand.rotateProduct, args: IRotateProductCmdArgs, historyUpdateMode?: HistoryUpdateMode): Promise<number>;
    execute(name: ProductCommand.replaceInterpolationPlaceholders, historyUpdateMode?: HistoryUpdateMode): Promise<BaseTextItem[]>;
    execute(name: ProductCommand.changeBackground, args: IChangeBgArgs, historyUpdateMode?: HistoryUpdateMode): Promise<Item[]>;
    execute(name: ProductCommand.fillPlaceholders, args: IFillPlaceholdersCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<Item[]>;
    execute(name: ProductCommand.applyProductTheme, args: IApplyProductThemeCmdArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ProductCommand.resize, args: IResizeArgs | IExternalResizeArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: SurfaceCommand.addItems, args: IAddItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: SurfaceCommand.setBleed, args: ISetBleedCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: SurfaceCommand.setSlug, args: ISetSlugCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.deleteItems, args: IDeleteItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.cloneItems, args: ICloneItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.addContent, args: IAddContentCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.alignItems, args: IAlignItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.groupAlign, args: IGroupAlignCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.bringItems, args: IBringItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.moveItem, args: IMoveItemCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.createItem, args: ICreateItemCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<Item>;
    execute(name: ItemsCommand.editItems, args: IEditItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.setImageMetadata, args: ISetImageMetadataCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.setImageItem, args: ISetImageItemCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.placeholderContentScale, args: IPlaceholderContentScaleCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.placeholderContentReset, args?: IPlaceholderContentResetCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.changeBarcodeFormat, args: IChangeBarcodeFormatCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.changeColumnCount, args: IChangeColumnCountCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.placeholderContentRotate, args: IPlaceholderContentRotateCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.insertItemsIntoArea, args: IInsertItemsIntoAreaCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.changeLayout, args: IChangeLayoutCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.groupItems, args: IGroupItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.ungroupItems, args: IUngroupItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.replaceGroupItemContent, args: IReplaceGroupItemContentCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.changeClipartItemColor, args: IChangeClipartItemColorArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.translateItems, args: ITranslateItemCommandArgs | IExternalTranslateItemCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.convertGroupIntoLayout, args: IConvertGroupIntoLayoutArgs, historyUpdateMode?: HistoryUpdateMode): Promise<LayoutItem[]>;
    execute(name: ItemsCommand.convertLayoutIntoGroup, args: IConvertLayoutIntoGroupArgs, historyUpdateMode?: HistoryUpdateMode): Promise<GroupItem[]>;
    execute(name: ItemsCommand.convertItemToPlaceholder, args: IConvertItemToPlaceholderCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<PlaceholderItem>;
    execute(name: ItemsCommand.convertPlaceholderToItem, args: IConvertPlaceholderToItemCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<Item>;
    execute(name: ItemsCommand.placeItemsToArea, args: IPlaceItemsToAreaCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.convertTextItem, args: IConvertTextItemCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<PlainTextItem>;
    execute(name: ItemsCommand.transformItems, args: ITransformItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.rotateItems, args: IRotateItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.fixUnsupportedText, args: IFixUnsupportedTextCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<BaseTextItem>;
    execute(name: ItemsCommand.replaceItemCommand, args: IReplaceItemCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.newTranslateItems, args: INewTranslateItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.resizeItems, args: IResizeItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: ItemsCommand.editPlaceholder, args: IEditPlaceholderCommandArgs): Promise<void>;
    execute(name: ItemsCommand.distributeItems, args: IDistributeItemsCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute(name: SelectionCommand.selectItems, args: ISelectItemsCommandArgs): Promise<void>;
    execute(name: SelectionCommand.selectFirst): Promise<void>;
    execute(name: SelectionCommand.clearSelection): Promise<void>;
    execute(name: SelectionCommand.selectItemsByRect, args: ISelectItemsByRectArgs): Promise<void>;
    execute(name: SelectionCommand.selectAll): Promise<void>;
    execute(name: ZoomCommand.zoomToItems, args: IZoomToItemsCommandArgs): Promise<void>;
    execute(name: ZoomCommand.zoomToSafetyLine, args: IZoomToSafetyLineCommandArgs): Promise<void>;
    execute(name: ZoomCommand.zoomToSelection): Promise<void>;
    execute(name: ZoomCommand.setZoom, args: ISetZoomCommandArgs): Promise<void>;
    execute(name: ViewerCommand.moveViewPort, args: IMoveViewportCommandArgs): Promise<void>;
    execute(name: ColorCommand.parseColor, args: IParseColorCommandArgs): Promise<Color>;
    protected _log(name: string, args?: any): void;
}
export interface IExternalCommandManager {
    execute?(name: ItemsCommand.translateItems, args: IExternalTranslateItemCommandArgs, historyUpdateMode?: HistoryUpdateMode): Promise<void>;
    execute?(name: ProductCommand.resize, args: IExternalResizeArgs, historyUpdateMode?: HistoryUpdateMode): any;
}