DesignAtomsApiClient

Classes

DesignAtomsApiClient

Implements

• IDesignAtomsApiClient
• MultiSelectMode

Constructors

Constructor

new DesignAtomsApiClient(timeout?): DesignAtomsApiClient;

Parameters

Parameter	Type	Default value
timeout	number	60000

Returns

DesignAtomsApiClient

Accessors

backendUrl

Get Signature

get backendUrl(): string;

Returns

string

Set Signature

set backendUrl(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Implementation of

IDesignAtomsApiClient.backendUrl

loadingImageUrl

Get Signature

get loadingImageUrl(): string;

Returns

string

Set Signature

set loadingImageUrl(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Implementation of

IDesignAtomsApiClient.loadingImageUrl

loadingImageUrlChanged

Get Signature

get loadingImageUrlChanged(): EventWithSenderArg<IDesignAtomsApiClient, any>;

Returns

EventWithSenderArg<IDesignAtomsApiClient, any>

Implementation of

IDesignAtomsApiClient.loadingImageUrlChanged

serviceEndpoint

Get Signature

get serviceEndpoint(): string;

Returns

string

Implementation of

IDesignAtomsApiClient.serviceEndpoint

Methods

getColorPreview()

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

Parameters

Parameter	Type
color	Color
colorSettings	IPreviewColorSettings

Returns

Promise<RgbColor>

Implementation of

IDesignAtomsApiClient.getColorPreview

getColorPreviews()

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

Parameters

Parameter	Type
colors	Color[]
colorSettings	IPreviewColorSettings

Returns

Promise<RgbColor[]>

Implementation of

IDesignAtomsApiClient.getColorPreviews

getContentPath()

getContentPath(originalPathId): Promise<string>;

Parameters

Parameter	Type
originalPathId	string

Returns

Promise<string>

Implementation of

IDesignAtomsApiClient.getContentPath

getFallbackFonts()

getFallbackFonts(): Promise<IFallbackFontsResult>;

Returns

Promise<IFallbackFontsResult>

Implementation of

IDesignAtomsApiClient.getFallbackFonts

getFontsByteArray()

getFontsByteArray(psName): Promise<Uint8Array>;

Parameters

Parameter	Type
psName	string

Returns

Promise<Uint8Array>

Implementation of

IDesignAtomsApiClient.getFontsByteArray

getFontsCSS()

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

Parameters

Parameter	Type
requestedFonts	string[]
advancedMode	boolean

Returns

Promise<string>

Implementation of

IDesignAtomsApiClient.getFontsCSS

getImageMetaDataFromDesignImage()

getImageMetaDataFromDesignImage(designImageName): Promise<ImageMetaData>;

Parameters

Parameter	Type
designImageName	string

Returns

Promise<ImageMetaData>

Implementation of

IDesignAtomsApiClient.getImageMetaDataFromDesignImage

getImageMetaDataFromFile()

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

Parameters

Parameter	Type	Default value
filePath	string	undefined
userId	string	null

Returns

Promise<ImageMetaData>

Implementation of

IDesignAtomsApiClient.getImageMetaDataFromFile

getImageMetadataFromRemoteFile()

getImageMetadataFromRemoteFile(url): Promise<ImageMetaData>;

Parameters

Parameter	Type
url	string

Returns

Promise<ImageMetaData>

Implementation of

IDesignAtomsApiClient.getImageMetadataFromRemoteFile

getImageMetaDataFromRemoteUrl()

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

Parameters

Parameter	Type
remoteUrl	string
appDomainUrl	string

Returns

Promise<ImageMetaData>

Implementation of

IDesignAtomsApiClient.getImageMetaDataFromRemoteUrl

getLicenseAsync()

getLicenseAsync(): Promise<ILicense>;

Returns

Promise<ILicense>

Implementation of

IDesignAtomsApiClient.getLicenseAsync

getPathBoundsFromServer()

getPathBoundsFromServer(path): Promise<RectangleF>;

Parameters

Parameter	Type
path	Path

Returns

Promise<RectangleF>

Implementation of

IDesignAtomsApiClient.getPathBoundsFromServer

promoteToStateResources()

promoteToStateResources(cacheIds, appDomainUrl?): Promise<string[]>;

Parameters

Parameter	Type
cacheIds	string[]
appDomainUrl	string

Returns

Promise<string[]>

Implementation of

IDesignAtomsApiClient.promoteToStateResources

sendRequest()

sendRequest(
   methodName, 
   data, 
   resolve, 
   failure, 
   returnRawResponse?): void;

Parameters

Parameter	Type	Default value
methodName	any	undefined
data	any	undefined
resolve	SuccessFunc	undefined
failure	FailureFunc	undefined
returnRawResponse	boolean	false

Returns

void

Implementation of

IDesignAtomsApiClient.sendRequest

setAuthorizationToken()

setAuthorizationToken(authorizationToken): void;

Parameters

Parameter	Type
authorizationToken	string

Returns

void

Implementation of

IDesignAtomsApiClient.setAuthorizationToken

---

ServiceError

Constructors

Constructor

new ServiceError(
   timeout, 
   message, 
   stacktrace?, 
   type?, 
   data?): ServiceError;

Parameters

Parameter	Type
timeout	boolean
message	string
stacktrace?	string
type?	any
data?	any

Returns

ServiceError