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

# NDEffects

> - [`IEqualsReady`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Utils-2.md#iequalsready)

## Classes

### NDEffects

#### Implements

#### Constructors

##### Constructor

```ts
new NDEffects(): NDEffects;
```

###### Returns

[`NDEffects`](#ndeffects)

#### Properties

##### None

```ts
None: any = null;
```

##### Recolor

```ts
Recolor: RecolorEffectParameters;
```

#### Accessors

##### recolorEffect

###### Get Signature

```ts
get recolorEffect(): RecolorEffectParameters;
```

###### Returns

[`RecolorEffectParameters`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RecolorEffectParameters.md#recoloreffectparameters)

###### Set Signature

```ts
set recolorEffect(params): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | [`RecolorEffectParameters`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/RecolorEffectParameters.md#recoloreffectparameters) |

###### Returns

`void`

#### Methods

##### clone()

```ts
clone(): NDEffects;
```

###### Returns

[`NDEffects`](#ndeffects)

##### equals()

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

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `ndEffect` | [`NDEffects`](#ndeffects) |

###### Returns

`boolean`

###### Implementation of

[`IEqualsReady`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Utils-2.md#iequalsready).[`equals`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/Utils-2.md#equals)

##### toJSON()

```ts
toJSON(): object;
```

###### Returns

`object`

###### None

```ts
None: object = {};
```

###### Recolor

```ts
Recolor: object;
```

###### Recolor.currentColorReplacements

```ts
currentColorReplacements: Collection<ColorDictionaryEntry>;
```

###### Recolor.defaultColorReplacements

```ts
defaultColorReplacements: Collection<ColorDictionaryEntry>;
```

###### Recolor.reducedColorImageSource

```ts
reducedColorImageSource: object;
```

###### Recolor.reducedColorImageSource.actualSize

```ts
actualSize: boolean;
```

###### Recolor.reducedColorImageSource.containsOnlyVectorElements

```ts
containsOnlyVectorElements: boolean;
```

###### Recolor.reducedColorImageSource.height

```ts
height: number;
```

###### Recolor.reducedColorImageSource.id

```ts
id: string;
```

###### Recolor.reducedColorImageSource.isVector

```ts
isVector: boolean;
```

###### Recolor.reducedColorImageSource.origin

```ts
origin: Origin;
```

###### Recolor.reducedColorImageSource.pageIndex

```ts
pageIndex: number;
```

###### Recolor.reducedColorImageSource.saveAspectRatio

```ts
saveAspectRatio: boolean;
```

###### Recolor.reducedColorImageSource.url

```ts
url: string;
```

###### Recolor.reducedColorImageSource.width

```ts
width: number;
```

## Interfaces

### IRawNDEffects

#### Properties

##### None

```ts
None: object;
```

##### Recolor

```ts
Recolor: IRawRecolorEffectParameters;
```
