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

# RecolorEffectParameters

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

## Classes

### RecolorEffectParameters

#### Extends

#### Implements

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

#### Constructors

##### Constructor

```ts
new RecolorEffectParameters(): RecolorEffectParameters;
```

###### Returns

[`RecolorEffectParameters`](#recoloreffectparameters)

###### Inherited from

[`EffectParameters`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/NDEffectParameters.md#abstract-effectparameters).[`constructor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-model/NDEffectParameters.md#constructor)

#### Properties

##### currentColorReplacements

```ts
currentColorReplacements: Map<Color, Color>;
```

##### defaultColorReplacements

```ts
defaultColorReplacements: Map<Color, Color>;
```

##### reducedColorImageSource

```ts
reducedColorImageSource: ImageSource;
```

#### Accessors

##### currentColorReplacementKeys

###### Get Signature

```ts
get currentColorReplacementKeys(): Color[];
```

###### Returns

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

##### currentColorReplacementValues

###### Get Signature

```ts
get currentColorReplacementValues(): Color[];
```

###### Returns

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

##### defaultColorReplacementKeys

###### Get Signature

```ts
get defaultColorReplacementKeys(): Color[];
```

###### Returns

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

##### defaultColorReplacementValues

###### Get Signature

```ts
get defaultColorReplacementValues(): Color[];
```

###### Returns

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

#### Methods

##### clone()

```ts
clone(): RecolorEffectParameters;
```

###### Returns

[`RecolorEffectParameters`](#recoloreffectparameters)

##### equals()

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

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `recolorParams` | [`RecolorEffectParameters`](#recoloreffectparameters) |

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

##### setReplacementColor()

```ts
setReplacementColor(color, index): void;
```

###### Parameters

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

###### Returns

`void`

##### toJSON()

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

###### Returns

`object`

###### currentColorReplacements

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

###### defaultColorReplacements

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

###### reducedColorImageSource

```ts
reducedColorImageSource: object;
```

###### reducedColorImageSource.actualSize

```ts
actualSize: boolean;
```

###### reducedColorImageSource.containsOnlyVectorElements

```ts
containsOnlyVectorElements: boolean;
```

###### reducedColorImageSource.height

```ts
height: number;
```

###### reducedColorImageSource.id

```ts
id: string;
```

###### reducedColorImageSource.isVector

```ts
isVector: boolean;
```

###### reducedColorImageSource.origin

```ts
origin: Origin;
```

###### reducedColorImageSource.pageIndex

```ts
pageIndex: number;
```

###### reducedColorImageSource.saveAspectRatio

```ts
saveAspectRatio: boolean;
```

###### reducedColorImageSource.url

```ts
url: string;
```

###### reducedColorImageSource.width

```ts
width: number;
```

## Interfaces

### IRawRecolorEffectParameters

#### Properties

##### currentColorReplacements

```ts
currentColorReplacements: ColorDictionaryEntry[];
```

##### defaultColorReplacements

```ts
defaultColorReplacements: ColorDictionaryEntry[];
```

##### reducedColorImageSource

```ts
reducedColorImageSource: any;
```