---
title: "DesignAtomsApiClient | Customer's Canvas On-Premises"
canonical: "https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/DesignAtomsApiClient/"
---

# DesignAtomsApiClient

> - [`IDesignAtomsApiClient`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#idesignatomsapiclient)
> - [`MultiSelectMode`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/Commands.md#multiselectmode)

## Classes

### DesignAtomsApiClient

#### Implements

#### Constructors

##### Constructor

```ts
new DesignAtomsApiClient(timeout?): DesignAtomsApiClient;
```

###### Parameters

| Parameter | Type | Default value |
| ------ | ------ | ------ |
| `timeout` | `number` | `60000` |

###### Returns

[`DesignAtomsApiClient`](#designatomsapiclient)

#### Accessors

##### backendUrl

###### Get Signature

```ts
get backendUrl(): string;
```

###### Returns

`string`

###### Set Signature

```ts
set backendUrl(value): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `value` | `string` |

###### Returns

`void`

###### Implementation of

[`IDesignAtomsApiClient`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#idesignatomsapiclient).[`backendUrl`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#backendurl)

##### loadingImageUrl

###### Get Signature

```ts
get loadingImageUrl(): string;
```

###### Returns

`string`

###### Set Signature

```ts
set loadingImageUrl(value): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `value` | `string` |

###### Returns

`void`

###### Implementation of

[`IDesignAtomsApiClient`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#idesignatomsapiclient).[`loadingImageUrl`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#loadingimageurl)

##### loadingImageUrlChanged

###### Get Signature

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

###### Returns

`EventWithSenderArg`\<[`IDesignAtomsApiClient`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#idesignatomsapiclient), `any`\>

###### Implementation of

[`IDesignAtomsApiClient`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#idesignatomsapiclient).[`loadingImageUrlChanged`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#loadingimageurlchanged)

##### serviceEndpoint

###### Get Signature

```ts
get serviceEndpoint(): string;
```

###### Returns

`string`

###### Implementation of

[`IDesignAtomsApiClient`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#idesignatomsapiclient).[`serviceEndpoint`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#serviceendpoint)

#### Methods

##### getColorPreview()

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

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `color` | `Color` |
| `colorSettings` | [`IPreviewColorSettings`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IPreviewColorSettings.md#ipreviewcolorsettings) |

###### Returns

[`Promise`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/finally.md#promise)\<`RgbColor`\>

###### Implementation of

[`IDesignAtomsApiClient`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#idesignatomsapiclient).[`getColorPreview`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#getcolorpreview)

##### getColorPreviews()

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

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `colors` | `Color`[] |
| `colorSettings` | [`IPreviewColorSettings`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IPreviewColorSettings.md#ipreviewcolorsettings) |

###### Returns

[`Promise`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/finally.md#promise)\<`RgbColor`[]\>

###### Implementation of

[`IDesignAtomsApiClient`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#idesignatomsapiclient).[`getColorPreviews`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#getcolorpreviews)

##### getContentPath()

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

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `originalPathId` | `string` |

###### Returns

[`Promise`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/finally.md#promise)\<`string`\>

###### Implementation of

[`IDesignAtomsApiClient`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#idesignatomsapiclient).[`getContentPath`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#getcontentpath)

##### getFallbackFonts()

```ts
getFallbackFonts(): Promise<IFallbackFontsResult>;
```

###### Returns

[`Promise`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/finally.md#promise)\<[`IFallbackFontsResult`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#ifallbackfontsresult)\>

###### Implementation of

[`IDesignAtomsApiClient`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#idesignatomsapiclient).[`getFallbackFonts`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#getfallbackfonts)

##### getFontsByteArray()

```ts
getFontsByteArray(psName): Promise<Uint8Array>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `psName` | `string` |

###### Returns

[`Promise`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/finally.md#promise)\<`Uint8Array`\>

###### Implementation of

[`IDesignAtomsApiClient`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#idesignatomsapiclient).[`getFontsByteArray`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#getfontsbytearray)

##### getFontsCSS()

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

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `requestedFonts` | `string`[] |
| `advancedMode` | `boolean` |

###### Returns

[`Promise`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/finally.md#promise)\<`string`\>

###### Implementation of

[`IDesignAtomsApiClient`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#idesignatomsapiclient).[`getFontsCSS`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#getfontscss)

##### getImageMetaDataFromDesignImage()

```ts
getImageMetaDataFromDesignImage(designImageName): Promise<ImageMetaData>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `designImageName` | `string` |

###### Returns

[`Promise`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/finally.md#promise)\<`ImageMetaData`\>

###### Implementation of

[`IDesignAtomsApiClient`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#idesignatomsapiclient).[`getImageMetaDataFromDesignImage`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#getimagemetadatafromdesignimage)

##### getImageMetaDataFromFile()

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

###### Parameters

| Parameter | Type | Default value |
| ------ | ------ | ------ |
| `filePath` | `string` | `undefined` |
| `userId` | `string` | `null` |

###### Returns

[`Promise`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/finally.md#promise)\<`ImageMetaData`\>

###### Implementation of

[`IDesignAtomsApiClient`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#idesignatomsapiclient).[`getImageMetaDataFromFile`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#getimagemetadatafromfile)

##### getImageMetadataFromRemoteFile()

```ts
getImageMetadataFromRemoteFile(url): Promise<ImageMetaData>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `url` | `string` |

###### Returns

[`Promise`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/finally.md#promise)\<`ImageMetaData`\>

###### Implementation of

[`IDesignAtomsApiClient`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#idesignatomsapiclient).[`getImageMetadataFromRemoteFile`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#getimagemetadatafromremotefile)

##### getImageMetaDataFromRemoteUrl()

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

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `remoteUrl` | `string` |
| `appDomainUrl` | `string` |

###### Returns

[`Promise`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/finally.md#promise)\<`ImageMetaData`\>

###### Implementation of

[`IDesignAtomsApiClient`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#idesignatomsapiclient).[`getImageMetaDataFromRemoteUrl`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#getimagemetadatafromremoteurl)

##### getLicenseAsync()

```ts
getLicenseAsync(): Promise<ILicense>;
```

###### Returns

[`Promise`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/finally.md#promise)\<[`ILicense`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#ilicense)\>

###### Implementation of

[`IDesignAtomsApiClient`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#idesignatomsapiclient).[`getLicenseAsync`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#getlicenseasync)

##### getPathBoundsFromServer()

```ts
getPathBoundsFromServer(path): Promise<RectangleF>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `path` | `Path` |

###### Returns

[`Promise`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/finally.md#promise)\<`RectangleF`\>

###### Implementation of

[`IDesignAtomsApiClient`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#idesignatomsapiclient).[`getPathBoundsFromServer`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#getpathboundsfromserver)

##### promoteToStateResources()

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

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `cacheIds` | `string`[] |
| `appDomainUrl` | `string` |

###### Returns

[`Promise`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/finally.md#promise)\<`string`[]\>

###### Implementation of

[`IDesignAtomsApiClient`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#idesignatomsapiclient).[`promoteToStateResources`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#promotetostateresources)

##### sendRequest()

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

###### Parameters

| Parameter | Type | Default value |
| ------ | ------ | ------ |
| `methodName` | `any` | `undefined` |
| `data` | `any` | `undefined` |
| `resolve` | [`SuccessFunc`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IService.md#successfunc) | `undefined` |
| `failure` | [`FailureFunc`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IService.md#failurefunc) | `undefined` |
| `returnRawResponse` | `boolean` | `false` |

###### Returns

`void`

###### Implementation of

[`IDesignAtomsApiClient`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#idesignatomsapiclient).[`sendRequest`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#sendrequest)

##### setAuthorizationToken()

```ts
setAuthorizationToken(authorizationToken): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `authorizationToken` | `string` |

###### Returns

`void`

###### Implementation of

[`IDesignAtomsApiClient`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#idesignatomsapiclient).[`setAuthorizationToken`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#setauthorizationtoken)

***

### ServiceError

#### Constructors

##### Constructor

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

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `timeout` | `boolean` |
| `message` | `string` |
| `stacktrace?` | `string` |
| `type?` | `any` |
| `data?` | `any` |

###### Returns

[`ServiceError`](#serviceerror)