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

# IDesignAtomsApiClient

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

## Interfaces

### IDesignAtomsApiClient

#### Properties

##### backendUrl

```ts
backendUrl: string;
```

##### loadingImageUrl

```ts
loadingImageUrl: string;
```

##### loadingImageUrlChanged

```ts
loadingImageUrlChanged: EventWithSenderArg<IDesignAtomsApiClient, any>;
```

##### serviceEndpoint

```ts
serviceEndpoint: string;
```

#### 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

##### 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`[]\>

##### 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`\>

##### getFallbackFonts()

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

###### Returns

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

##### 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`\>

##### 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`\>

##### getImageMetaDataFromDesignImage()

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

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `designImageName` | `string` |
| `appDomainUrl?` | `string` |

###### Returns

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

##### getImageMetaDataFromFile()

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

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `filePath` | `string` |
| `userId` | `string` |
| `appDomainUrl?` | `string` |

###### Returns

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

##### getImageMetadataFromRemoteFile()

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

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `url` | `string` |
| `appDomainUrl?` | `string` |

###### Returns

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

##### 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`\>

##### getLicenseAsync()

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

###### Returns

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

##### 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`\>

##### 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`[]\>

##### sendRequest()

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

###### Parameters

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

###### Returns

`void`

##### setAuthorizationToken()

```ts
setAuthorizationToken(token): any;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `token` | `string` |

###### Returns

`any`

***

### IFallbackFontsResult

#### Properties

##### fonts

```ts
fonts: string[];
```

##### message

```ts
message: string;
```

***

### ILicense

#### Properties

##### expirationDate

```ts
expirationDate: Date;
```

##### isDesktopOnly

```ts
isDesktopOnly: boolean;
```

##### isDeveloper

```ts
isDeveloper: boolean;
```

##### isEnterprise

```ts
isEnterprise: boolean;
```

##### isTrial

```ts
isTrial: boolean;
```