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

# SpotColor

> - [`Color`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#abstract-color)

## Classes

### SpotColor

#### Extends

#### Implements

- [`ISpotColor`](#ispotcolor)

#### Constructors

##### Constructor

```ts
new SpotColor(value): SpotColor;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `value` | `string` \| [`ISpotColor`](#ispotcolor) |

###### Returns

[`SpotColor`](#spotcolor)

###### Overrides

```ts
Color.constructor
```

#### Properties

##### alpha

```ts
alpha: number;
```

###### Implementation of

[`ISpotColor`](#ispotcolor).[`alpha`](#alpha-1)

###### Overrides

[`Color`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#abstract-color).[`alpha`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#alpha)

##### inkColor

```ts
inkColor: Color;
```

###### Implementation of

[`ISpotColor`](#ispotcolor).[`inkColor`](#inkcolor-1)

##### inkName

```ts
inkName: string;
```

###### Implementation of

[`ISpotColor`](#ispotcolor).[`inkName`](#inkname-1)

##### inkSolidity

```ts
inkSolidity: number;
```

###### Implementation of

[`ISpotColor`](#ispotcolor).[`inkSolidity`](#inksolidity-1)

##### preview

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

###### Implementation of

[`ISpotColor`](#ispotcolor).[`preview`](#preview-1)

###### Inherited from

[`Color`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#abstract-color).[`preview`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#preview)

##### profileId

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

###### Implementation of

[`ISpotColor`](#ispotcolor).[`profileId`](#profileid-1)

###### Inherited from

[`Color`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#abstract-color).[`profileId`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#profileid)

##### tint

```ts
tint: number;
```

###### Implementation of

[`ISpotColor`](#ispotcolor).[`tint`](#tint-1)

#### Accessors

##### previewFromServer

###### Get Signature

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

###### Returns

`boolean`

###### Inherited from

[`Color`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#abstract-color).[`previewFromServer`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#previewfromserver)

##### type

###### Get Signature

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

###### Returns

`string`

###### Implementation of

[`ISpotColor`](#ispotcolor).[`type`](#type-1)

###### Overrides

[`Color`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#abstract-color).[`type`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#type)

#### Methods

##### clone()

```ts
clone(): SpotColor;
```

###### Returns

[`SpotColor`](#spotcolor)

###### Overrides

[`Color`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#abstract-color).[`clone`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#clone)

##### equals()

```ts
equals(color): boolean;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `color` | `any` |

###### Returns

`boolean`

###### Overrides

[`Color`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#abstract-color).[`equals`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#equals)

##### getData()

```ts
getData(): ISpotColor;
```

###### Returns

[`ISpotColor`](#ispotcolor)

###### Overrides

[`Color`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#abstract-color).[`getData`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#getdata)

##### needUpdate()

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

###### Parameters

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

###### Returns

`boolean`

###### Inherited from

[`Color`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#abstract-color).[`needUpdate`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#needupdate)

##### toString()

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

###### Returns

`string`

###### Overrides

[`Color`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#abstract-color).[`toString`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#tostring)

##### equals()

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

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `a` | [`Color`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#abstract-color) |
| `b` | [`Color`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#abstract-color) |

###### Returns

`boolean`

###### Inherited from

[`Color`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#abstract-color).[`equals`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#equals-1)

## Interfaces

### ISpotColor

#### Extends

- [`IColor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#icolor)

#### Properties

##### alpha?

```ts
optional alpha?: number;
```

##### inkColor

```ts
inkColor: IColor;
```

##### inkName

```ts
inkName: string;
```

##### inkSolidity

```ts
inkSolidity: number;
```

##### preview?

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

###### Inherited from

[`IColor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#icolor).[`preview`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#preview-1)

##### profileId?

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

###### Inherited from

[`IColor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#icolor).[`profileId`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#profileid-1)

##### tint?

```ts
optional tint?: number;
```

##### type?

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

###### Inherited from

[`IColor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#icolor).[`type`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Color-1.md#type-1)