Package @aurigma/design-atoms
Classes
AddContentCommand
AddItemsCommand
AjaxResponseException
AlignItemsCommand
ApplyProductThemeCommand
ArchedTextItemHandler
AutoEraseEffect
AutoErasePoint
AutoPreviewContainersSource
AutoScaledTextItemHandler
AxisResizeData
BarcodeHandlerData
BarcodeItemHandler
BaseCommand
BaseImageEffect
BaseItemsCommand
BaseProductCommand
BaseRectangleItemHandler
BaseSurfaceCommand
BaseTextHandlerData
BaseTextItemHandler
BaseViewer
BleedViolation
BoundedTextItemHandler
BringItemsCommand
Canvas
Represents the main host object containing a stack of layers.
This client-side class corresponds to the server-side class Canvas
and provides access to its primary members in TypeScript.
CanvasData
Represents a state of the canvas and allows for applying this state to the [[Canvas]] instance.
CanvasElementHandler
CanvasRenderer
CanvasStyle
CanvasViolationVisualizer
ChangeBackgroundCommand
ChangeBarcodeFormatCommand
ChangeClipartItemColorCommand
ChangeColumnCountCommand
ChangeLayoutCommand
ClearSelectionCommand
ClipartItemHandler
Clipboard_2
CloneItemsCommand
ColorPreviewService
CommandManager
ContentItemHandler
ConvertGroupIntoLayoutCommand
ConvertItemToPlaceholderCommand
ConvertLayoutIntoGroupCommand
ConvertPlaceholderToItemCommand
ConvertTextItemCommand
CreateItemCommand
CropEffect
Ctx2dTextRenderer
CurvedTextHandlerData
CurvedTextItemHandler
DashedLineItemHandler
DeleteItemsCommand
DistributeItemsCommand
DragNDropHandler
EditItemsCommand
EditPlaceholderCommand
EffectHandler
EllipseItemHandler
EventManager
FillPlaceholdersCommand
FiltersEffect
FixUnsupportedTextCommand
FloatingToolbarElementHandler
FloatingToolbarManager
FontRegistry
FrontEndLogger
Graphics
GridHandler
GroupAlignCommand
GroupItemHandler
GroupItemsCommand
HandlerFactoryByItem
HandlerFactoryByName
History_2
HitTestManager
HoverStyle
ImageContainer
ImageHandlerData
ImageItemHandler
ImageQualityViolation
InputTextValidator
InputTextValidatorResult
InsertItemsIntoAreaCommand
InStringPlaceholderConverter
InteractiveZonesHandler
InteractiveZonesStyles
ItemDataHandler
ItemHandler
ItemHandlerData
This is a base class for all the classes which represent a state of a vector object.
ItemHandlerImageLoaderService
ItemHandlersCollection
ItemsDataApplier
Layer
Represents a design element on the canvas.
This client-side class corresponds to the server-side class Canvas
and provides access to its primary members in TypeScript.
LayerCollection
LayerData
LayoutItemHandler
LineItemHandler
ListsHandler
MinDpiResizeConstraint
ModelUpdateCommand
MoveItemCommand
MoveViewportCommand
NewArchedTextItemHandler
NewBaseTextItemHandler
NewBoundedTextItemHandler
NewCurvedTextItemHandler
NewPlainTextItemHandler
NewTranslateItemsCommand
ObjectFactory
PathBoundedTextItemHandler
PathHandler
Permission
PermissionData
PlaceholderContentResetCommand
PlaceholderContentRotateCommand
PlaceholderContentScaleCommand
PlaceholderHandlerData
PlaceholderItemHandler
PlaceItemsToAreaCommand
PlainTextItemHandler
PreviewCanvas
PreviewTextEditorController
ProductHandler
ProductPreviewRenderer
ProductPreviewService
ProductThemeApplier
ProductThemeConfig
ProductThemeManager
QuerySelector
RectangleItemHandler
RegionViolation
ReplaceGroupItemContentCommand
ReplaceInterpolationPlaceholdersCommand
ReplaceItemCommand
ResizeCommand
ResizeHelper
ResizeItemsCommand
RotateHandler
RotateItemsCommand
RotateProductCommand
Rubberband
RubberbandStyle
SafetyLinesHandler
SafetyLineViolation
ScrollbarStyleHandler
Section
SelectAllItemsCommand
SelectFirstItemCommand
SelectionHandler
SelectionHitTestManager
SelectionProcessModifier
SelectionRectangleHandler
SelectionStyleConfig
SelectItemsByRectCommand
SelectItemsCommand
Service
SetBleedCommand
SetImageItemCommand
SetImageMetadataCommand
SetSlugCommand
SetZoomCommand
ShapeHandlerData
ShapeItemHandler
SnapLinesHandler
SpotlightStyle
SurfaceHandler
SurfaceManager
TextCropViolation
TextEditorController
Manages a text editor (TextWhizz or mobile versions).
TextEditorRenderer
TextImageData
TextInPlaceViolation
TextRenderer
TextsWorkaroundItemsComparer
TextWhizzInitData
Data required to initialize the text engine wrapper.
TouchFlags
TransformItemsCommand
TranslateItemsCommand
Translations
TreeConverter
UngroupItemsCommand
VariableItemHelper
Viewer
ViewerClientSideOptions
ViewerConfiguration
ViewportHandler
Violation
ViolationInfoResult
ViolationService
ViolationServiceFactory
ViolationViewController
WatermarkHandler
WebGLTextRenderer
WorkspaceRotation
XmlListStyles
XmlParagraphStyles
XmlSpanStyles
ZoomParams
ZoomToItemsCommand
ZoomToSafetyLineCommand
ZoomToSelectionCommand
Interfaces
IActiveTextCanvasHandler
IAddContentCommandArgs
IAddItemsCommandArgs
IAlignItemsCommandArgs
IAnchor
IApplyParams
IApplyProductThemeCmdArgs
IArchedTextItemData
IAxisResizeData
IBarcodeItemData
IBarcodeVariable
IBaseTextItemData
IBoundedTextItemData
IBringItemsCommandArgs
ICanvas
ICanvasDataSource
ICanvasElementHandler
ICanvasElementHandlerConfiguration
ICanvasFactory
ICanvasStyle
IChangeBarcodeFormatCommandArgs
IChangeBgArgs
IChangeClipartItemColorArgs
IChangeColumnCountCommandArgs
IChangeLayoutCommandArgs
ICloneItemsCommandArgs
IColorPalette
IColorPreviewService
ICommandManager
IContainerItemHandler
IContainerResizeOptions
IConvertGroupIntoLayoutArgs
IConvertItemToPlaceholderCommandArgs
IConvertLayoutIntoGroupArgs
IConvertPlaceholderToItemCommandArgs
IConvertTextItemCommandArgs
ICreateItemCommandArgs
IDeleteItemsCommandArgs
IDesignAtomsApiClient
IDistributeItemsCommandArgs
IDpiChangedEventArgs
IDragNDropHandler
IEditItemsCommandArgs
IEditPlaceholderCommandArgs
IEventManager
IExternalCommandManager
IExternalResizeArgs
IExternalTranslateItemCommandArgs
IFallbackFontsResult
IFillPlaceholdersCommandArgs
IFixUnsupportedTextCommandArgs
IFloatingButtonDescription
IFloatingItemToolbarConfig
IFontData
IFontService
IGetNextSurfaceCmdName
IGroupHandler
IGroupItemsCommandArgs
IHandlersConfiguration
IHistoryArgs
IHitTestManager
IHitTestResult
IHoverStyle
IImageItemData
IImageQualityViolationData
IImageResizedData
IInlineStyle
IInsertItemsIntoAreaCommandArgs
IInteractiveZonesHandler
IInteractiveZonesStateChangedEventArgs
IInteractiveZonesStyles
IInteractiveZoneStateStyle
IInteractiveZoneStyle
IInterpolationPlaceholderVariable
IIntervalCheckLoop
IItemHandlerRectData
IItemsComparer
IItemsContext
IItemViolationInfo
IItemViolationStateChangedEventArgs
ILicense
IListConfiguration
IListenableColorPreviewService
IListsHandler
IMoveByPointParams
IMoveData
IMoveItemCommandArgs
IMoveParams
IMoveViewportCommandArgs
INewTranslateItemsCommandArgs
IOptions
IParagraphStyle
IPermissionData
IPermissions
IPlaceholderContentResetCommandArgs
IPlaceholderContentRotateCommandArgs
IPlaceholderContentScaleCommandArgs
IPlaceholderItemData
IPlaceItemsToAreaCommandArgs
IPreviewColorSettings
IPreviewContainersSource
IPreviewContainersSourceFactory
IPreviewLoadedEventArgs
IPreviewOptions
IPrintZoneConfig
IPrintZoneConfiguration
IQualityLevelsConfig
IQualityMeterConfig
IRangeParams
IRectangleMovedEventArgs
IRectangleResizedEventArgs
IRectangleRotatedEventArgs
IReplaceGroupItemContentCommandArgs
IReplaceItemCommandArgs
IResizeArgs
IResizeByPointParams
IResizeData
IResizeItemsCommandArgs
IResizeLimits
IResolution
IRichTextData
IRotateByPointParams
IRotateData
IRotateItemsCommandArgs
IRotateProductCmdArgs
IRubberbandStyle
IRulersConfig
IRulersContext
ISafetyLinesConfig
ISection
ISelectedImageAxisInfo
ISelectedImageInfo
ISelectionHandler
ISelectionHitTestResult
ISelectionOptions
ISelectionProcessModifier
ISelectionRectangleEventArgs
ISelectionRectangleOperationParams
ISelectionStyle
ISelectItemsByRectArgs
ISelectItemsCommandArgs
IService
ISetBleedCommandArgs
ISetImageItemCommandArgs
ISetImageMetadataCommandArgs
ISetMetadataListItem
ISetSlugCommandArgs
ISetZoomCommandArgs
ISnapElementConfiguration
ISnapItemConfiguration
ISnapLineData
ISnapLinesConfiguration
ISnapLinesHandler
ISnapshotHandler
ISpotlightStyle
IStroke
IStubImagesBarcodeConfig
IStubImagesConfig
ISwitchToSurfaceParams
ITextEditorContext
ITextEditorController
Manages a text editor (TextWhizz or mobile versions).
ITextEditorControllerFactory
ITextEditorElementHandler
ITextItemData
ITextLimitsContext
ITextParams
ITextSelectionStyleConfig
ITotalViolationInfo
ITransformItemsCommandArgs
ITranslateItemCommandArgs
ITranslations
ITranslationsContext
IUngroupItemsCommandArgs
IVariable
IViewer
IViewerConfiguration
IViewerConfigurationContext
IViewerMessagesConfig
IViewerWarningMessageConfig
IViewportHandler
IViolationData
IViolationInfo
IViolationServiceConfiguration
IWaitClockRenderer
IZoomToItemsCommandArgs
IZoomToSafetyLineCommandArgs
Enums
ContentType
CoordinateSystem
FloatingToolbarMode
FontStyle
HistoryUpdateMode
InteractiveZoneLabelPosition
ItemHandlerState
Specifies values which define current item state.
LogLevel
LogSource
MouseCommandType
PlaceholderEditingViewMode
RenderState
RulersConfigUnit
SafetyLineViolationMode
ScrollBarsStyle
Specifies values which specify when to display scroll bars at the control.
SelectionState
SnapElementType
SurfaceSwitchCommand
TextEditorMode
TextStateType
UpdatePositionMode
UpdateTextTriggerType
ViewportAlignment
Specifies possible values for alignment of viewport.
ViolationState
Results of preflight check.
ZoomMode
Specifies zoom modes for displaying images.
ZoomQuality
Specifies zoom quality of the displayed image. Zoom with higher quality requires more resources on the server-side than lower quality zoom.
Functions
getSelectionAreaToImageSizeRatio(resizeData, imageHandler)
Declaration
export declare function getSelectionAreaToImageSizeRatio(resizeData: IResizeData, imageHandler: ImageItemHandler): {
width: number;
height: number;
};
Parameters
Type | Name | Description |
---|---|---|
IResizeData | resizeData | |
ImageItemHandler | imageHandler |
Returns
Type | Description |
---|---|
{ width: number; height: number; } |
getUnitScale(config)
Declaration
export declare function getUnitScale(config: IRulersConfig): number;
Parameters
Type | Name | Description |
---|---|---|
IRulersConfig | config |
Returns
Type | Description |
---|---|
number |
isIContainerItemHandler(object)
Declaration
export declare function isIContainerItemHandler(object: any): object is IContainerItemHandler;
Parameters
Type | Name | Description |
---|---|---|
any | object |
Returns
Type | Description |
---|---|
object is IContainerItemHandler |
isIncreasingResize(selection, resizeData)
Declaration
export declare function isIncreasingResize(selection: RotatedRectangleF, resizeData: IResizeData): boolean;
Parameters
Type | Name | Description |
---|---|---|
RotatedRectangleF | selection | |
IResizeData | resizeData |
Returns
Type | Description |
---|---|
boolean |
LogClr.blue(str)
Declaration
function blue(str: string): string;
Parameters
Type | Name | Description |
---|---|---|
string | str |
Returns
Type | Description |
---|---|
string |
LogClr.cyan(str)
Declaration
function cyan(str: string): string;
Parameters
Type | Name | Description |
---|---|---|
string | str |
Returns
Type | Description |
---|---|
string |
LogClr.green(str)
Declaration
function green(str: string): string;
Parameters
Type | Name | Description |
---|---|---|
string | str |
Returns
Type | Description |
---|---|
string |
LogClr.magenta(str)
Declaration
function magenta(str: string): string;
Parameters
Type | Name | Description |
---|---|---|
string | str |
Returns
Type | Description |
---|---|
string |
LogClr.red(str)
Declaration
function red(str: string): string;
Parameters
Type | Name | Description |
---|---|---|
string | str |
Returns
Type | Description |
---|---|
string |
LogClr.white(str)
Declaration
function white(str: string): string;
Parameters
Type | Name | Description |
---|---|---|
string | str |
Returns
Type | Description |
---|---|
string |
LogClr.yellow(str)
Declaration
function yellow(str: string): string;
Parameters
Type | Name | Description |
---|---|---|
string | str |
Returns
Type | Description |
---|---|
string |
Variables
ItemTypeNs.getType
Declaration
getType: (item: Item) => ItemType
ItemTypeNs.isText
Declaration
isText: (type: ItemType) => boolean
StandardIntervalCheckLoop
Declaration
StandardIntervalCheckLoop: {
start({ checkFunction, onChange, delayMs }: {
checkFunction: () => boolean;
onChange: Function;
delayMs?: number;
}): any;
stop(checkId: any): void;
}
Type Aliases
CanvasBackground
Declaration
export type CanvasBackground = "chess" | {
color: string;
};
ContainersChangeData
Declaration
export type ContainersChangeData = {
added: Container[];
removed: Container[];
};
EditorInitData
Declaration
export type EditorInitData = {
text?: string;
defaultParagraphStyle?: IParagraphStyle;
defaultInlineStyle?: ICharStyle;
rectangle?: RotatedRectangleF;
textAlignment?: TextAlignment;
borderWidth?: number;
borderColor?: string;
fillColor?: string;
opacity?: number;
point?: IPoint;
previewScale?: number;
textFormattingEnabled?: boolean;
transform?: Transform;
textVerticalAlignment?: TextVerticalAlignment;
newLineEnabled?: boolean;
isVertical?: boolean;
listSettings: IListConfiguration;
limits?: ITextLimits;
};
FailureFunc
Declaration
export type FailureFunc = (error: any, userContext: any, methodName: any) => any;
FloatingToolbarButton
Declaration
export type FloatingToolbarButton = "Handle" | "Select" | "Edit" | "Delete";
GetItemHandlersOptions
Declaration
export type GetItemHandlersOptions = {
excludeGroupItems?: boolean;
flatGroupItems?: boolean;
onlyVisible?: boolean;
onlyUnlocked?: boolean;
onlyType?: ItemHandlerType | ItemHandlerType[];
whiteListFilter?: (handler: any) => boolean;
blackListFilter?: (handler: any) => boolean;
};
GridConfig
Declaration
export type GridConfig = {
horizontalColor?: string;
verticalColor?: string;
stepX?: number;
stepY?: number;
lineWidthPx?: number;
enabled?: boolean;
};
HandlerUpdateFunc
Declaration
export type HandlerUpdateFunc = (handler: ItemHandler) => boolean;
HtmlFontValue
Declaration
export type HtmlFontValue = {
family?: string;
bold?: boolean;
italic?: boolean;
};
ImageLoadOpions
Declaration
export type ImageLoadOpions = {
downloadToServerCache?: boolean;
actualSize?: boolean;
saveAspectRatio?: boolean;
};
ItemHandlerType
Declaration
export type ItemHandlerType = typeof PlaceholderItemHandler | typeof ImageItemHandler | typeof ItemHandler | typeof PlainTextItemHandler | typeof RectangleItemHandler | typeof ShapeItemHandler | typeof BaseTextItemHandler | typeof NewBaseTextItemHandler;
RectangleSignsType
Declaration
export type RectangleSignsType = {
x: -1 | 1;
y: -1 | 1;
};
Request_2
Declaration
export type Request = {
id: string;
promise: Promise<void>;
};
SnapDataType
Declaration
export type SnapDataType = {
xAnchors: IAnchor[];
yAnchors: IAnchor[];
defaultBounds: RectangleF;
activeXAnchorIndex: number;
activeYAnchorIndex: number;
xPoints: number[];
yPoints: number[];
activeXPointIndex: number;
activeYPointIndex: number;
};
StaticTextChangedEventData
Declaration
export type StaticTextChangedEventData = {
rect: RectangleF;
canvas: HTMLCanvasElement;
};
StaticTextChangedHandler
Declaration
export type StaticTextChangedHandler = (data: StaticTextChangedEventData) => void;
StyleDictionary
Declaration
export type StyleDictionary = {
[prop: string]: string;
};
SuccessFunc
Declaration
export type SuccessFunc = (data: any, xmlhttprequest?: XMLHttpRequest) => any;
UpdateButtonGroupsOptions
Declaration
export type UpdateButtonGroupsOptions = {
onlyVisible?: boolean;
violationContainers?: boolean;
violationContainersPosition?: boolean;
violationContainerHandler?: BaseRectangleItemHandler;
violationContainerHandlerPosition?: boolean;
placeholderButtons?: boolean;
placeholderButtonsPosition?: boolean;
placeholderHandler?: PlaceholderItemHandler | GroupItemHandler;
placeholderHandlerPosition?: boolean;
instant?: boolean;
};