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

# GrayscaleColor

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

## Classes

### GrayscaleColor

#### Extends

#### Implements

- [`IGrayscaleColor`](#igrayscalecolor)

#### Constructors

##### Constructor

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

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `value` | [`IGrayscaleColor`](#igrayscalecolor) |

###### Returns

[`GrayscaleColor`](#grayscalecolor)

###### Overrides

```ts
Color.constructor
```

#### Properties

##### a

```ts
a: number = 255;
```

###### Implementation of

[`IGrayscaleColor`](#igrayscalecolor).[`a`](#a-1)

##### l

```ts
l: number = 0;
```

###### Implementation of

[`IGrayscaleColor`](#igrayscalecolor).[`l`](#l-1)

##### preview

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

###### Implementation of

[`IGrayscaleColor`](#igrayscalecolor).[`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

[`IGrayscaleColor`](#igrayscalecolor).[`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)

#### Accessors

##### alpha

###### Get Signature

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

###### Returns

`number`

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

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

[`IGrayscaleColor`](#igrayscalecolor).[`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(): GrayscaleColor;
```

###### Returns

[`GrayscaleColor`](#grayscalecolor)

###### 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(): IGrayscaleColor;
```

###### Returns

[`IGrayscaleColor`](#igrayscalecolor)

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

### IGrayscaleColor

#### Extends

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

#### Properties

##### a?

```ts
optional a?: number;
```

##### l

```ts
l: 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)

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