Back to Website
Show / Hide Table of Contents

Package @aurigma/design-atoms-model

Classes

ArchedTextItem

ArgumentException

ArgumentNullException

AutoLayoutSettings

AutoScaledTextItem

BarcodeData

BarcodeItem

BarcodePermissions

BaseEventObject

BaseItem

BaseTextItem

BaseTextItem.BaseTextValue

BaseTextItem.FontSettings

BoundedTextItem

ClipartItem

CmykColor

Collection

Color

ColorGroup

ColorGroupTarget

ColorLessContainer

Configuration

Container

ContentItem

ContentPermissions

CornerRadiusConverter

CropMark

CropMarkText

CurvedTextItem

DashedLineItem

DefaultLayoutSettings

EllipseItem

EncodingOptions

EquatableKeyDictionary

Represents a dictionary which key supports comparison through equals() method

EventObject

EventWithAutoSenderArg

EventWithSenderArg

Exception

FontSettingsData

FrontendPermissions

FullColorContainer

GrayscaleColor

GridItem

GroupItem

HsbColor

ImageItem

ImageItem.ImageItemValue

ImageItem.ImageMetaData

ImageItem.ImageSource

ImageItem.ImageSource.Origin

ImageMetaData

ImagePermissions

Ink

InStringPlaceholder

InteractiveZone

InvalidOperationException

Item

ItemData

ItemMask

ItemPermissions

ItemsMetadata

ItemToolbarPermissions

LabColor

LayoutItem

LimitedColorContainer

LineItem

LinePermissions

ManipulationPermissions

Matrix

Creates a 2D transform matrix. [ x'] [ m00 m01 m02 ] [ x ] [ m00x + m01y + m02 ] [ y'] = [ m10 m11 m12 ] [ y ] = [ m10x + m11y + m12 ] [ 1 ] [ 0 0 1 ] [ 1 ] [ 1 ]

MockupContainer

ModelComponent

NotImplementedException

OutOfRangeException

OverlayEffect

Palette

ParagraphSettings

Path

PathBoundedTextItem

PathBoundedTextPermissions

PathSegment

PlaceholderItem

PlaceholderPermissions

PlainTextItem

PointF

PolylineItem

PrintArea

ProcessColor

Product

RectangleF

RectangleItem

ResizeGripsPermissions

RgbColor

RgbColors

RotatedRectangleF

SafetyLine

ShadowSettings

ShadowSettingsData

ShapeItem

ShapePermissions

Size

SizeF

SmartItem

SpotColor

SpotColorContainer

StrokeSettings

StrokeSettingsData

Surface

SurfaceContainer

SurfaceMockup

Swatch

TextPermissions

TextureContainer

ThemeBinding

Transform

UnexpectedDataException

This exception is thrown when unexpected data is encountered.

Uuid

VCardAddress

VisualizationPermissions

Watermark

WatermarkConfig

WatermarkImageConfig

WatermarkTextConfig

WatermarkVisibilityConfig

Interfaces

ICmykColor

IColor

IColorWithTitle

IDataSet

IEqualsReady

IEquatable

IFontSettings

IGetAllItemsOptions

IGrayscaleColor

IHiResOutputRendering

IInk

IInputPropertyMetadata

IInStringPlaceholder

IItemData

IItemsData

ILabColor

ILtrb

IPdfMetadata

IPoint

IProcessColor

IProductThemeConfig

IProofImageRendering

IRenderingConfig

IResizeGripsPermissions

IRgbColor

IShadowSettings

ISize

ISpotColor

IStrokeSettings

ISurfaceBinding

ISurfaceData

ISurfaceRendering

IWatermarkConfig

IWatermarkImageConfig

IWatermarkTextConfig

IWatermarkVisibilityConfig

Enums

AutoLayoutAlignItems

AutoLayoutAnchorPoint

AutoLayoutJustifyContent

AutoLayoutOrientation

AutoSizeMode

BarcodeFormat

BarcodeSubType

BlendMode

ColorSpace

CopyFittingMode

CropMarkTextAlignment

FirstBaselineOffset

FitMode

HorizontalContentAlignment

ImageEffect

ImageItem.ImageSourceType

IPdfFormat

ItemColorProperty

LayoutType

LineJoin

OverflowStrategy

PdfBox

PrintAreaBoundsType

RenderingType

ResizeMode

ShrinkMode

TextAlignment

TextVerticalAlignment

VerticalContentAlignment

WrappingMode

Functions

applyNullableValue(actual, redefined)

Declaration
export declare function applyNullableValue<T>(actual: T, redefined: T): T;
Parameters
Type Name Description
T actual
T redefined
Returns
Type Description
T
Type Parameters
Name Description
T

applyUndefinedValue(actual, redefined)

Declaration
export declare function applyUndefinedValue<T>(actual: T, redefined: T): T;
Parameters
Type Name Description
T actual
T redefined
Returns
Type Description
T
Type Parameters
Name Description
T

arrayEquals(obj1, obj2)

Declaration
export declare function arrayEquals(obj1: equalsBasicType[], obj2: equalsBasicType[]): any;
Parameters
Type Name Description
equalsBasicType[] obj1
equalsBasicType[] obj2
Returns
Type Description
any

arrayReferenceEquals(obj1, obj2)

Declaration
export declare function arrayReferenceEquals(obj1: Object[], obj2: Object[]): boolean;
Parameters
Type Name Description
Object[] obj1
Object[] obj2
Returns
Type Description
boolean

assert(expression, message)

Declaration
export declare function assert(expression: boolean, message?: string): void;
Parameters
Type Name Description
boolean expression
string message
Returns
Type Description
void

assign(target, sources, options)

Declaration
export declare function assign<T extends Object>(target: T, sources: any[], options?: {
    deep?: boolean;
    ignoreNull?: boolean;
}): T;
Parameters
Type Name Description
T target
any[] sources
{ deep?: boolean; ignoreNull?: boolean; } options
Returns
Type Description
T
Type Parameters
Name Description
T

assignProperties(target, propObject)

Declaration
export declare function assignProperties<T extends Object>(target: T, propObject: Partial<T>): T;
Parameters
Type Name Description
T target
Partial<T> propObject
Returns
Type Description
T
Type Parameters
Name Description
T

capitalize(word)

Declaration
export declare function capitalize(word: string): string;
Parameters
Type Name Description
string word
Returns
Type Description
string

contains(str1, str2)

Declaration
export declare function contains(str1: string, str2: string): boolean;
Parameters
Type Name Description
string str1
string str2
Returns
Type Description
boolean

createCssDataUri(css)

Declaration
export declare function createCssDataUri(css: string): string;
Parameters
Type Name Description
string css
Returns
Type Description
string

devicePixelsToCssPixels(devicePixels)

Declaration
export declare function devicePixelsToCssPixels(devicePixels: number): number;
Parameters
Type Name Description
number devicePixels
Returns
Type Description
number

enableMoveDropDownFocus(element, getFocusElement)

Declaration
export declare function enableMoveDropDownFocus(element: HTMLElement, getFocusElement: () => any): void;
Parameters
Type Name Description
HTMLElement element

Element contains twitter bootstrap dropdown

() => any getFocusElement

Function returns element to be focused after dropdown expand

Returns
Type Description
void

equals(obj1, obj2)

Declaration
export declare function equals(obj1: equalsType, obj2: equalsType): any;
Parameters
Type Name Description
equalsType obj1
equalsType obj2
Returns
Type Description
any

escapeXml(str)

Declaration
export declare function escapeXml(str: string): string;
Parameters
Type Name Description
string str
Returns
Type Description
string

flatten(nestedCollec)

Declaration
export declare function flatten<T>(nestedCollec: T[][]): T[];
Parameters
Type Name Description
T[][] nestedCollec
Returns
Type Description
T[]
Type Parameters
Name Description
T

getCurrentLineInTextArea(element)

Declaration
export declare function getCurrentLineInTextArea(element: HTMLTextAreaElement): string;
Parameters
Type Name Description
HTMLTextAreaElement element
Returns
Type Description
string

getExtension(fileName)

Declaration
export declare function getExtension(fileName: string): string;
Parameters
Type Name Description
string fileName
Returns
Type Description
string

getFontNames(text)

Declaration
export declare function getFontNames(text: string): string[];
Parameters
Type Name Description
string text
Returns
Type Description
string[]

getHiddenElemenHeight(el)

Declaration
export declare function getHiddenElemenHeight(el: HTMLElement): number;
Parameters
Type Name Description
HTMLElement el
Returns
Type Description
number

getImageSize(imageUrl)

Declaration
export declare function getImageSize(imageUrl: string): Promise<{
    width: number;
    height: number;
}>;
Parameters
Type Name Description
string imageUrl
Returns
Type Description
Promise<{ width: number; height: number; }>

getLastPathSegment(path)

Declaration
export declare function getLastPathSegment(path: string): any;
Parameters
Type Name Description
string path
Returns
Type Description
any

getNameWithoutExtension(fileName)

Declaration
export declare function getNameWithoutExtension(fileName: string): string;
Parameters
Type Name Description
string fileName
Returns
Type Description
string

getStringEnumValue(enumObject, enumValue)

Declaration
export declare function getStringEnumValue(enumObject: Object, enumValue: string): string;
Parameters
Type Name Description
Object enumObject
string enumValue
Returns
Type Description
string

getTextFromXml(xmlFormattedText, replaceParagraphString)

Declaration
export declare function getTextFromXml(xmlFormattedText: string, replaceParagraphString?: string): string;
Parameters
Type Name Description
string xmlFormattedText
string replaceParagraphString
Returns
Type Description
string

getUniqueId(object)

Declaration
export declare function getUniqueId(object: Object): string;
Parameters
Type Name Description
Object object
Returns
Type Description
string

inchesToPixels(inches, dpi)

Declaration
export declare function inchesToPixels(inches: number, dpi: number): number;
Parameters
Type Name Description
number inches
number dpi
Returns
Type Description
number

isFocused(element)

Declaration
export declare function isFocused(element: Element): any;
Parameters
Type Name Description
Element element
Returns
Type Description
any

isNullOrEmptyOrWhiteSpace(str)

Declaration
export declare function isNullOrEmptyOrWhiteSpace(str: string): boolean;
Parameters
Type Name Description
string str
Returns
Type Description
boolean

isValidXml(str, fixAmpsEnabled)

Declaration
export declare function isValidXml(str: string, fixAmpsEnabled?: boolean): boolean;
Parameters
Type Name Description
string str
boolean fixAmpsEnabled
Returns
Type Description
boolean

localStorageEnabled()

Declaration
export declare function localStorageEnabled(): boolean;
Returns
Type Description
boolean

measureScrollbar()

Declaration
export declare function measureScrollbar(): number;
Returns
Type Description
number

mmToPoint(millimeters)

Declaration
export declare function mmToPoint(millimeters: number): number;
Parameters
Type Name Description
number millimeters
Returns
Type Description
number

normalize(paramObject, defaults)

Declaration
export declare function normalize<T>(paramObject: T, defaults: Partial<T>): T;
Parameters
Type Name Description
T paramObject
Partial<T> defaults
Returns
Type Description
T
Type Parameters
Name Description
T

parsePercentOrPointValue(point, printAreaSize)

Declaration
export declare function parsePercentOrPointValue(point: string | number, printAreaSize: number): number;
Parameters
Type Name Description
string | number point
number printAreaSize
Returns
Type Description
number

pixelsToPoints(pixels, dpi)

Declaration
export declare function pixelsToPoints(pixels: number, dpi: number): number;
Parameters
Type Name Description
number pixels
number dpi
Returns
Type Description
number

pointsToInches(points)

Declaration
export declare function pointsToInches(points: number): number;
Parameters
Type Name Description
number points
Returns
Type Description
number

pointsToPixels(points, dpi)

Declaration
export declare function pointsToPixels(points: number, dpi: number): number;
Parameters
Type Name Description
number points
number dpi
Returns
Type Description
number

pointsToPixels(points, dpi)

Declaration
export declare function pointsToPixels(points: PointF, dpi: number): PointF;
Parameters
Type Name Description
PointF points
number dpi
Returns
Type Description
PointF

Property(value)

Declaration
export declare function Property(value: IInputPropertyMetadata): (target: Object, propertyKey: string) => void;
Parameters
Type Name Description
IInputPropertyMetadata value
Returns
Type Description
(target: Object, propertyKey: string) => void

PropertyChanged()

Declaration
export declare function PropertyChanged(): (target: Object, propertyKey: string) => void;
Returns
Type Description
(target: Object, propertyKey: string) => void

pushArray(array, pushValues)

Declaration
export declare function pushArray<T>(array: T[], pushValues: T[]): void;
Parameters
Type Name Description
T[] array
T[] pushValues
Returns
Type Description
void
Type Parameters
Name Description
T

stringEquals(str1, str2, ignoreCase)

Declaration
export declare function stringEquals(str1: string, str2: string, ignoreCase?: boolean): boolean;
Parameters
Type Name Description
string str1
string str2
boolean ignoreCase
Returns
Type Description
boolean

stringEquals(str1, str2, options)

Declaration
export declare function stringEquals(str1: string, str2: string, options?: {
    ignoreCase: boolean;
}): boolean;
Parameters
Type Name Description
string str1
string str2
{ ignoreCase: boolean; } options
Returns
Type Description
boolean

stringFormat(str)

Declaration
export declare function stringFormat(str: string): string;
Parameters
Type Name Description
string str
Returns
Type Description
string

stripForJson(obj, omitProperties)

Declaration
export declare function stripForJson(obj: any, omitProperties?: string | string[]): {};
Parameters
Type Name Description
any obj
string | string[] omitProperties
Returns
Type Description
{}

strToInt(str)

Declaration
export declare function strToInt(str: string): number;
Parameters
Type Name Description
string str
Returns
Type Description
number

timeout(delay)

Declaration
export declare function timeout(delay?: number): Promise<void>;
Parameters
Type Name Description
number delay
Returns
Type Description
Promise<void>

toDashedStyle(camleCase)

Declaration
export declare function toDashedStyle(camleCase: string): string;
Parameters
Type Name Description
string camleCase
Returns
Type Description
string

unescapeXml(str)

Declaration
export declare function unescapeXml(str: string): string;
Parameters
Type Name Description
string str
Returns
Type Description
string

urlCombine(startUrl, urlParts)

Declaration
export declare function urlCombine(startUrl: string, ...urlParts: string[]): string;
Parameters
Type Name Description
string startUrl
string[] urlParts
Returns
Type Description
string

Variables

checkType

Declaration
checkType: (meta: IInputPropertyMetadata, target: object, key: string) => TPropertyDataTypes

Clamp

Declaration
Clamp: (min: number, val: number, max: number) => number

CompareRectangels

Declaration
CompareRectangels: (rects0: any, rects1: any) => boolean

ConvertDegreeToRadian

Declaration
ConvertDegreeToRadian: (angle: any) => number

ConvertRadianToDegree

Declaration
ConvertRadianToDegree: (angle: any) => number

delay

Declaration
delay: typeof timeout

Environment

Declaration
Environment: {
    IsIos: () => boolean;
    GetIosVersion: () => number[];
    IosMajorVersion: () => number;
    IsAndroid: () => boolean;
    IsTouchDevice: () => boolean;
    IsNativeAndroidBrowser: () => boolean;
    IsGoogleChrome: () => boolean;
    IsSafari: () => boolean;
    IsSafariOrSafariWebView: () => boolean;
    IsFirefox: () => boolean;
    IsTouchIE: () => boolean;
    IsIE: () => boolean;
    IsEdge: () => boolean;
    GetEdgeHtmlVersion: () => number[];
    readonly devicePixelRatio: number;
    readonly screenDpi: number;
    IsSmallScreen: () => boolean;
}

EqualsOfFloatNumbers

Declaration
EqualsOfFloatNumbers: (f1: number, f2: number, tolerance?: number) => boolean

getBounds

Declaration
getBounds: (points: PointF[]) => RectangleF

getLineWidth

Declaration
getLineWidth: (p1: PointF, p2: PointF, width: any, scaleX: any, scaleY: any) => number

getOrientedSquare

Declaration
getOrientedSquare: (p1: PointF, p2: PointF, p3: PointF) => number

getScalarProduct

Declaration
getScalarProduct: (v1: PointF, v2: PointF) => number

getSquareDistanceToPoint

Declaration
getSquareDistanceToPoint: (p1: PointF, p2: PointF) => number

getSquareDistanceToSegment

Declaration
getSquareDistanceToSegment: (p: PointF, p1: PointF, p2: PointF) => number

getTriangleAngle

Declaration
getTriangleAngle: (p1: PointF, p2: PointF, p3: PointF) => number

insertPointOutOfRange

Declaration
insertPointOutOfRange = "addPoint: Index out of range."

itemBelongsCollection

Declaration
itemBelongsCollection = "The item already belongs to this collection, or to another collection."

itemNotFoundInCollection

Declaration
itemNotFoundInCollection = "The item was not found in this collection."

itemsMetadata

Declaration
itemsMetadata: ItemsMetadata

normalizeAngle

Declaration
normalizeAngle: (angle: number) => number

removePointOutOfRange

Declaration
removePointOutOfRange = "removePoint: Index out of range."

setPointOutOfRange

Declaration
setPointOutOfRange = "setPoint: Index out of range."

Type Aliases

Action

Declaration
export declare type Action<T1 = void, T2 = void> = [T1] extends [void] ? () => any : [T2] extends [void] ? (arg: T1) => any : ((arg1: T1, arg2: T2) => any);
Type Parameters
Name Description
T1
T2

AnyFunction

Declaration
export declare type AnyFunction = (...args: any[]) => any;

ArbitraryCorner

Declaration
export declare type ArbitraryCorner = "Arbitrary";

Func

Declaration
export declare type Func<TResult, TArg = void> = (a: TArg) => TResult;
Type Parameters
Name Description
TResult
TArg

MarginOrNumber

Declaration
export declare type MarginOrNumber = number | Margin;

ProportionalCorner

Declaration
export declare type ProportionalCorner = "Proportional";

ResizeGripsCorner

Declaration
export declare type ResizeGripsCorner = ArbitraryCorner | ProportionalCorner;

TPropertyDataTypes

Declaration
export declare type TPropertyDataTypes = "number" | "string" | "boolean" | "enum" | "collection" | "color" | "item" | "object";
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