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

# Color

> - [`CmykColor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/CmykColor-1.md#cmykcolor)
> - [`GrayscaleColor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/GrayscaleColor-1.md#grayscalecolor)
> - [`LabColor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/LabColor-1.md#labcolor)
> - [`RgbColor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RgbColor-1.md#rgbcolor)
> - [`SpotColor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/SpotColor-1.md#spotcolor)

## Classes

### `abstract` Color

#### Extended by

#### Properties

##### preview

```ts
preview: string = null;
```

##### profileId

```ts
profileId: string = null;
```

#### Accessors

##### alpha

###### Get Signature

```ts
get abstract alpha(): number;
```

###### Returns

`number`

##### previewFromServer

###### Get Signature

```ts
get previewFromServer(): boolean;
```

###### Returns

`boolean`

##### type

###### Get Signature

```ts
get abstract type(): string;
```

###### Returns

`string`

#### Methods

##### clone()

```ts
abstract clone(): Color;
```

###### Returns

[`Color`](#abstract-color)

##### equals()

```ts
equals(color, ignorePreview?): boolean;
```

###### Parameters

| Parameter | Type | Default value |
| ------ | ------ | ------ |
| `color` | [`Color`](#abstract-color) | `undefined` |
| `ignorePreview` | `boolean` | `false` |

###### Returns

`boolean`

##### getData()

```ts
getData(): IColor;
```

###### Returns

[`IColor`](#icolor)

##### needUpdate()

```ts
needUpdate(defaultRgbProfileId): boolean;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `defaultRgbProfileId` | `string` |

###### Returns

`boolean`

##### toString()

```ts
abstract toString(): string;
```

###### Returns

`string`

##### equals()

```ts
static equals(a, b): boolean;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `a` | [`Color`](#abstract-color) |
| `b` | [`Color`](#abstract-color) |

###### Returns

`boolean`

## Interfaces

### IColor

#### Extended by

- [`ICmykColor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/CmykColor-1.md#icmykcolor)
- [`IGrayscaleColor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/GrayscaleColor-1.md#igrayscalecolor)
- [`ILabColor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/LabColor-1.md#ilabcolor)
- [`IRgbColor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RgbColor-1.md#irgbcolor)
- [`ISpotColor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/SpotColor-1.md#ispotcolor)

#### Properties

##### preview?

```ts
optional preview?: string;
```

##### profileId?

```ts
optional profileId?: string;
```

##### type?

```ts
optional type?: string;
```

## Type Aliases

### ColorConstructor

```ts
type ColorConstructor = (value) => Color;
```

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `value` | `any` |

#### Returns

[`Color`](#abstract-color)