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

# IColorPreviewService

> - [`IListenableColorPreviewService`](#ilistenablecolorpreviewservice)

## Interfaces

### IColorPreviewService

#### Extended by

#### Methods

##### getPreview()

```ts
getPreview(color): any;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `color` | `Color` |

###### Returns

`any`

##### getPreviewAsync()

```ts
getPreviewAsync(color): Promise<RgbColor>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `color` | `Color` |

###### Returns

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

##### getPreviews()

```ts
getPreviews(colors): any[];
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `colors` | `Color`[] |

###### Returns

`any`[]

##### getPreviewsAsync()

```ts
getPreviewsAsync(colors): Promise<RgbColor[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `colors` | `Color`[] |

###### Returns

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

***

### IListenableColorPreviewService

#### Extends

- [`IColorPreviewService`](#icolorpreviewservice)

#### Methods

##### getPreview()

```ts
getPreview(color): any;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `color` | `Color` |

###### Returns

`any`

###### Inherited from

[`IColorPreviewService`](#icolorpreviewservice).[`getPreview`](#getpreview)

##### getPreviewAsync()

```ts
getPreviewAsync(color): Promise<RgbColor>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `color` | `Color` |

###### Returns

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

###### Inherited from

[`IColorPreviewService`](#icolorpreviewservice).[`getPreviewAsync`](#getpreviewasync)

##### getPreviews()

```ts
getPreviews(colors): any[];
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `colors` | `Color`[] |

###### Returns

`any`[]

###### Inherited from

[`IColorPreviewService`](#icolorpreviewservice).[`getPreviews`](#getpreviews)

##### getPreviewsAsync()

```ts
getPreviewsAsync(colors): Promise<RgbColor[]>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `colors` | `Color`[] |

###### Returns

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

###### Inherited from

[`IColorPreviewService`](#icolorpreviewservice).[`getPreviewsAsync`](#getpreviewsasync)

##### subscribeToPreviewLoaded()

```ts
subscribeToPreviewLoaded(color, listener): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `color` | `Color` |
| `listener` | (`args`) => `any` |

###### Returns

`void`

##### unsubscribeFromPreviewLoaded()

```ts
unsubscribeFromPreviewLoaded(color, listener): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `color` | `Color` |
| `listener` | (`args`) => `any` |

###### Returns

`void`

***

### IPreviewLoadedEventArgs

#### Properties

##### color

```ts
color: Color;
```