Skip to main content

IDesignAtomsApiClient

Interfaces

IDesignAtomsApiClient

Properties

backendUrl
backendUrl: string;
loadingImageUrl
loadingImageUrl: string;
loadingImageUrlChanged
loadingImageUrlChanged: EventWithSenderArg<IDesignAtomsApiClient, any>;
serviceEndpoint
serviceEndpoint: string;

Methods

getColorPreview()
getColorPreview(color, colorSettings): Promise<RgbColor>;
Parameters
ParameterType
colorColor
colorSettingsIPreviewColorSettings
Returns

Promise<RgbColor>

getColorPreviews()
getColorPreviews(colors, colorSettings): Promise<RgbColor[]>;
Parameters
ParameterType
colorsColor[]
colorSettingsIPreviewColorSettings
Returns

Promise<RgbColor[]>

getContentPath()
getContentPath(originalPathId): Promise<string>;
Parameters
ParameterType
originalPathIdstring
Returns

Promise<string>

getFallbackFonts()
getFallbackFonts(): Promise<IFallbackFontsResult>;
Returns

Promise<IFallbackFontsResult>

getFontsByteArray()
getFontsByteArray(psName): Promise<Uint8Array>;
Parameters
ParameterType
psNamestring
Returns

Promise<Uint8Array>

getFontsCSS()
getFontsCSS(requestedFonts, advancedMode): Promise<string>;
Parameters
ParameterType
requestedFontsstring[]
advancedModeboolean
Returns

Promise<string>

getImageMetaDataFromDesignImage()
getImageMetaDataFromDesignImage(designImageName, appDomainUrl?): Promise<ImageMetaData>;
Parameters
ParameterType
designImageNamestring
appDomainUrl?string
Returns

Promise<ImageMetaData>

getImageMetaDataFromFile()
getImageMetaDataFromFile(
filePath,
userId,
appDomainUrl?): Promise<ImageMetaData>;
Parameters
ParameterType
filePathstring
userIdstring
appDomainUrl?string
Returns

Promise<ImageMetaData>

getImageMetadataFromRemoteFile()
getImageMetadataFromRemoteFile(url, appDomainUrl?): Promise<ImageMetaData>;
Parameters
ParameterType
urlstring
appDomainUrl?string
Returns

Promise<ImageMetaData>

getImageMetaDataFromRemoteUrl()
getImageMetaDataFromRemoteUrl(remoteUrl, appDomainUrl?): Promise<ImageMetaData>;
Parameters
ParameterType
remoteUrlstring
appDomainUrl?string
Returns

Promise<ImageMetaData>

getLicenseAsync()
getLicenseAsync(): Promise<ILicense>;
Returns

Promise<ILicense>

getPathBoundsFromServer()
getPathBoundsFromServer(path): Promise<RectangleF>;
Parameters
ParameterType
pathPath
Returns

Promise<RectangleF>

sendRequest()
sendRequest(
methodName,
data,
resolve,
failure,
returnRawResponse?): void;
Parameters
ParameterType
methodNameany
dataany
resolveSuccessFunc
failureFailureFunc
returnRawResponse?boolean
Returns

void

setAuthorizationToken()
setAuthorizationToken(token): any;
Parameters
ParameterType
tokenstring
Returns

any


IFallbackFontsResult

Properties

fonts
fonts: string[];
message
message: string;

ILicense

Properties

expirationDate
expirationDate: Date;
isDesktopOnly
isDesktopOnly: boolean;
isDeveloper
isDeveloper: boolean;
isEnterprise
isEnterprise: boolean;
isTrial
isTrial: boolean;
Was this page helpful?