Package @aurigma/design-atoms-interfaces

Interfaces

IAddContentCommandArgs

IAddItemsCommandArgs

IAlignItemsCommandArgs

IApplyParams

IApplyProductThemeCmdArgs

IArchedTextItemData

A structure defining the default parameters of arched text.

IBarcodeItemData

A structure defining the default parameters of barcodes.

IBarcodeOptions

A structure defining the barcode options.

IBarcodePermissionsData

A structure defining the barcode permissions.

IBaseNames

IBaseTextItemData

A structure defining the basic text parameters.

IBoundedTextItemData

A structure defining the basic parameters of bounded text.

IBringItemsCommandArgs

IChangeBarcodeFormatCommandArgs

IChangeBgArgs

IChangeColumnCountCommandArgs

IChangeLayoutCommandArgs

IClipartItemData

A structure containing parameters of clipart.

ICloneItemsCommandArgs

ICommandManager

IContentItemData

A structure defining the common parameters of text elements and images.

IContentPermissionsData

A structure defining permissions for the placeholder's content.

IConvertGroupIntoLayoutArgs

IConvertItemToPlaceholderCommandArgs

IConvertLayoutIntoGroupArgs

IConvertPlaceholderToItemCommandArgs

IConvertTextItemCommandArgs

ICreateItemCommandArgs

IDeleteItemsCommandArgs

IDistributeItemsCommandArgs

IEditItemsCommandArgs

IEditPlaceholderCommandArgs

IEllipseItemData

A structure defining the default parameters of ellipses.

IEmptyBarcodeContent

A structure defining the content of empty barcode placeholders.

IFixUnsupportedTextCommandArgs

IFontSettingsData

A configuration of font settings.

IGetNextSurfaceCmdName

IGroupAlignCommandArgs

IGroupItemData

A structure containing parameters of groups.

IGroupItemsCommandArgs

IImageItemData

A structure containing default parameters of images.

IImagePermissionsData

A structure defining the image permissions.

IInsertItemsIntoAreaCommandArgs

IItemData

A structure containing parameters of custom design elements.

IItemPermissionsData

A structure defining common permissions for design elements.

IItemToolbarPermissionsData

A structure containing the configuration of the Floating item toolbar.

ILinearBarcodeContent

A structure defining the content of linear barcodes.

ILineItemData

A structure containing default parameters of lines.

ILinePermissionsData

A structure defining permissions for lines.

ILocationData

A structure defining the default location of design elements.

IManipulationPermissionsData

A structure defining the manipulation permissions.

IMoveItemCommandArgs

IMoveViewportCommandArgs

INewTranslateItemsCommandArgs

IParagraphSettingsData

A structure defining the paragraph parameters.

IPlaceholderContentResetCommandArgs

IPlaceholderContentRotateCommandArgs

IPlaceholderContentScaleCommandArgs

IPlaceholderItemData

A structure defining the default parameters of image placeholders.

IPlaceholderPermissionsData

A structure defining the image placeholder permissions.

IPlaceItemsToAreaCommandArgs

IPlainTextItemData

A structure defining the basic parameters of plain text.

IPointF

A structure representing a point in a two-dimensional plane.

IQrPhoneBarcodeContent

A structure defining the content of VCard QR codes.

IQrUrlBarcodeContent

A structure defining the content of URL QR codes.

IQrVCardBarcodeContent

A structure defining the content of VCard QR codes.

IQueryOptions

IRectangleItemData

A structure defining the default parameters of rectangles.

IReplaceGroupItemContentCommandArgs

IReplaceItemCommandArgs

IResizeArgs

IResizeGripsPermissions

A structure defining the grips that appear on bounding rectangles.

IResizeItemsCommandArgs

IRichTextData

A structure defining the basic parameters of rich-formatted text.

IRotateItemsCommandArgs

IRotateProductCmdArgs

ISelectItemsByRectArgs

ISelectItemsCommandArgs

ISetBleedCommandArgs

ISetImageItemCommandArgs

ISetImageMetadataCommandArgs

ISetMetadataListItem

ISetSlugCommandArgs

ISetZoomCommandArgs

IShapeItemData

A structure defining common shape parameters and parameters of SVG images imported in the Shape mode.

IShapePermissionsData

A structure defining permissions for shapes.

IStubBarcodeContent

A structure defining the content of stub barcode placeholders.

ISwitchToSurfaceParams

ITextItemData

A structure defining the parameters of text elements.

ITextPermissionsData

A structure defining permissions for text elements.

IThemeBindingData

A structure defining default colors and styles of design elements.

ITransformItemsCommandArgs

ITranslateItemCommandArgs

IUngroupItemsCommandArgs

IViolationSettings

A structure containing the configuration of preflight warnings.

IVisualizationPermissionsData

A structure defining visualization of design elements.

IZoomToItemsCommandArgs

IZoomToSafetyLineCommandArgs

Enums

BlendMode

DistributeType

HistoryUpdateMode

ItemsCommand

ItemType

MultiSelectMode

OriginPointType

The origin of coordinates.

See an example.

ProductCommand

ResizeRectangleType

RotationType

SelectionCommand

SurfaceCommand

SurfaceSwitchCommand

ViewerCommand

ZoomCommand

Type Aliases

AlignTargetType

Declaration

export declare type AlignTargetType = "printArea" | "safeArea" | "auto";

AlignType

Declaration

export declare type AlignType = "right" | "left" | "bottom" | "top" | "verticalCenter" | "horizontalCenter";

ArbitraryCorner

Declaration

export declare type ArbitraryCorner = "Arbitrary";

BarcodeContentType

Info encoded in the barcode.

Declaration

export declare type BarcodeContentType<TBarcodeFormat, TBarcodeSubType> = IEmptyBarcodeContent<TBarcodeFormat, TBarcodeSubType> | IStubBarcodeContent<TBarcodeFormat, TBarcodeSubType> | ILinearBarcodeContent<TBarcodeFormat, TBarcodeSubType> | IQrVCardBarcodeContent<TBarcodeFormat, TBarcodeSubType> | IQrUrlBarcodeContent<TBarcodeFormat, TBarcodeSubType> | IQrPhoneBarcodeContent<TBarcodeFormat, TBarcodeSubType>;

Type Parameters

Name	Description
TBarcodeFormat
TBarcodeSubType

ContentResizeMode

Declaration

export declare type ContentResizeMode = "fill" | "fit" | "original";

HorizontalOriginPointType

Declaration

export declare type HorizontalOriginPointType = OriginPointType.Left | OriginPointType.Right | OriginPointType.Center;

ImageEffect

Declaration

export declare type ImageEffect = "none" | "blackAndWhite" | "flipVertical" | "flipHorizontal" | "colorize" | "blackAndTransparent";

OverflowStrategy

Copyfitting rules.

Declaration

export declare type OverflowStrategy = "clip" | "fitToWidth" | "fitToBox" | "expandBox";

ProportionalCorner

Declaration

export declare type ProportionalCorner = "Proportional";

ResizeGripsCorner

Declaration

export declare type ResizeGripsCorner = ArbitraryCorner | ProportionalCorner;

ShrinkMode

Shrink modes for overflowing text.

Declaration

export declare type ShrinkMode = "scale" | "size";

VerticalAlignmentType

Vertical alignment.

Declaration

export declare type VerticalAlignmentType = "top" | "center" | "bottom";

VerticalOriginPointType

Declaration

export declare type VerticalOriginPointType = OriginPointType.Top | OriginPointType.Bottom | OriginPointType.Center;

WrappingMode

Declaration

export declare type WrappingMode = "none" | "square" | "tight";