Interface IDesignAtomsApiClient

Package: @aurigma/design-atoms

Properties

backendUrl

Declaration

backendUrl: string;

Property Value

Type	Description
string

loadingImageUrl

Declaration

loadingImageUrl: string;

Property Value

Type	Description
string

loadingImageUrlChanged

Declaration

loadingImageUrlChanged: EventWithSenderArg<IDesignAtomsApiClient, any>;

Property Value

Type	Description
EventWithSenderArg<IDesignAtomsApiClient, any>

serviceEndpoint

Declaration

serviceEndpoint: string;

Property Value

Type	Description
string

Methods

getColorPreview(color, colorSettings)

Declaration

getColorPreview(color: Color, colorSettings: IPreviewColorSettings): Promise<RgbColor>;

Parameters

Type	Name	Description
Color	color
IPreviewColorSettings	colorSettings

Returns

Type	Description
Promise<RgbColor>

getColorPreviews(colors, colorSettings)

Declaration

getColorPreviews(colors: Color[], colorSettings: IPreviewColorSettings): Promise<RgbColor[]>;

Parameters

Type	Name	Description
Color[]	colors
IPreviewColorSettings	colorSettings

Returns

Type	Description
Promise<RgbColor[]>

getContentPath(originalPathId)

Declaration

getContentPath(originalPathId: string): Promise<string>;

Parameters

Type	Name	Description
string	originalPathId

Returns

Type	Description
Promise<string>

getFallbackFonts()

Declaration

getFallbackFonts(): Promise<IFallbackFontsResult>;

Returns

Type	Description
Promise<IFallbackFontsResult>

getFontsByteArray(psName)

Declaration

getFontsByteArray(psName: string): Promise<Uint8Array>;

Parameters

Type	Name	Description
string	psName

Returns

Type	Description
Promise<Uint8Array>

getFontsCSS(requestedFonts, advancedMode)

Declaration

getFontsCSS(requestedFonts: string[], advancedMode: boolean): Promise<string>;

Parameters

Type	Name	Description
string[]	requestedFonts
boolean	advancedMode

Returns

Type	Description
Promise<string>

getImageMetaDataFromDesignImage(designImageName, appDomainUrl)

Declaration

getImageMetaDataFromDesignImage(designImageName: string, appDomainUrl?: string): Promise<ImageMetaData>;

Parameters

Type	Name	Description
string	designImageName
string	appDomainUrl

Returns

Type	Description
Promise<ImageMetaData>

getImageMetaDataFromFile(filePath, userId, appDomainUrl)

Declaration

getImageMetaDataFromFile(filePath: string, userId: string, appDomainUrl?: string): Promise<ImageMetaData>;

Parameters

Type	Name	Description
string	filePath
string	userId
string	appDomainUrl

Returns

Type	Description
Promise<ImageMetaData>

getImageMetadataFromRemoteFile(url, appDomainUrl)

Declaration

getImageMetadataFromRemoteFile(url: string, appDomainUrl?: string): Promise<ImageMetaData>;

Parameters

Type	Name	Description
string	url
string	appDomainUrl

Returns

Type	Description
Promise<ImageMetaData>

getImageMetaDataFromRemoteUrl(remoteUrl, appDomainUrl)

Declaration

getImageMetaDataFromRemoteUrl(remoteUrl: string, appDomainUrl?: string): Promise<ImageMetaData>;

Parameters

Type	Name	Description
string	remoteUrl
string	appDomainUrl

Returns

Type	Description
Promise<ImageMetaData>

getLicenseAsync()

Declaration

getLicenseAsync(): Promise<ILicense>;

Returns

Type	Description
Promise<ILicense>

getPathBoundsFromServer(path)

Declaration

getPathBoundsFromServer(path: Path): Promise<RectangleF>;

Parameters

Type	Name	Description
Path	path

Returns

Type	Description
Promise<RectangleF>

sendRequest(methodName, data, resolve, failure, returnRawResponse)

Declaration

sendRequest(methodName: any, data: any, resolve: SuccessFunc, failure: FailureFunc, returnRawResponse?: boolean): void;

Parameters

Type	Name	Description
any	methodName
any	data
SuccessFunc	resolve
FailureFunc	failure
boolean	returnRawResponse

Returns

Type	Description
void

setAuthorizationToken(token)

Declaration

setAuthorizationToken(token: string): any;

Parameters

Type	Name	Description
string	token

Returns

Type	Description
any