Color Diff

https://www.npmjs.com/package/color-diff
Admin
Color Diff implements the CIEDE2000 color difference algorithm for comparing colors, converting...
Tokens:7,841
Snippets:60
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install color-diff

Source: https://www.npmjs.com/package/color-diff

Use npm to install the package as a dependency.

```bash
npm install color-diff --save
```

```bash
npm i color-diff
```

--------------------------------

### Installation

Source: https://www.npmjs.com/package/color-diff

Install the color-diff package using npm.

```APIDOC
## Installation
```
npm install color-diff --save
```
```

--------------------------------

### Install color-diff package

Source: https://www.npmjs.com/package/color-diff?activeTab=dependents

Install the color-diff package using npm. This command saves the package as a dependency in your project.

```bash
npm install color-diff --save
```

--------------------------------

### Define Lab color object

Source: https://www.npmjs.com/package/color-diff

Example of a Lab color object structure.

```javascript
{ L: 100, a: 0.005, b: -0.010 }
```

--------------------------------

### Define RGBA color object

Source: https://www.npmjs.com/package/color-diff

Example of an RGBA color object structure.

```javascript
{ R: 255, G: 1, B: 0 }
```

--------------------------------

### Run tests

Source: https://www.npmjs.com/package/color-diff

Execute the test suite located in the test/ folder.

```bash
npm test
```

--------------------------------

### Usage

Source: https://www.npmjs.com/package/color-diff?activeTab=versions

Import and use the functions from the color-diff package in your project.

```APIDOC
## Usage
```javascript
// CommonJS
const { 
  closest, 
  furthest,
  diff, 
  mapPalette,
  paletteMapKey,
  rgbaToLab, 
  mapPaletteLab,
  labPaletteMapKey,
} = require("color-diff");

// ESM
import { 
  closest,
  furthest,
  diff,
  mapPalette,
  paletteMapKey,
  rgbaToLab,
  mapPaletteLab,
  labPaletteMapKey,
} from "color-diff";
```
```

--------------------------------

### Import color-diff modules

Source: https://www.npmjs.com/package/color-diff

Import the library functions using either CommonJS or ESM syntax.

```javascript
// CommonJS
const { 
  closest, 
  furthest,
  diff, 
  mapPalette,
  paletteMapKey,
  rgbaToLab,
  mapPaletteLab,
  labPaletteMapKey,
} = require("color-diff");

// ESM
import {
  closest,
  furthest,
  diff,
  mapPalette,
  paletteMapKey,
  rgbaToLab,
  mapPaletteLab,
  labPaletteMapKey,
} from "color-diff";
```

--------------------------------

### mapPaletteLab(palette1, palette2)

Source: https://www.npmjs.com/package/color-diff?activeTab=versions

Maps colors from palette1 to palette2, assuming both palettes are in LAB color space.

```APIDOC
## mapPaletteLab(palette1, palette2)

### Description
Maps colors from palette1 to palette2, assuming both palettes are in LAB color space.

### Parameters
- **palette1** (Array.<Object>) - Required - The source color palette in LAB format. Each object should have 'L', 'a', 'b' properties.
- **palette2** (Array.<Object>) - Required - The target color palette in LAB format. Each object should have 'L', 'a', 'b' properties.

### Response
- **paletteMap** (Object) - An object where keys are colors from `palette1` and values are their closest matches in `palette2`.
```

--------------------------------

### Usage

Source: https://www.npmjs.com/package/color-diff

Import and use the functions from the color-diff package in your JavaScript project.

```APIDOC
## Usage

```javascript
// CommonJS
const { 
  closest, 
  furthest,
  diff, 
  mapPalette,
  paletteMapKey,
  rgbaToLab,
  mapPaletteLab,
  labPaletteMapKey,
} = require("color-diff");

// ESM
import {
  closest,
  furthest,
  diff,
  mapPalette,
  paletteMapKey,
  rgbaToLab,
  mapPaletteLab,
  labPaletteMapKey,
} from "color-diff";
```
```

--------------------------------

### Import color-diff functions (CommonJS)

Source: https://www.npmjs.com/package/color-diff?activeTab=code

Import all available functions from the color-diff package using CommonJS module syntax.

```javascript
const { 
  closest, 
  furthest,
  diff, 
  mapPalette,
  paletteMapKey,
  rgbaToLab,
  mapPaletteLab,
  labPaletteMapKey,
} = require("color-diff");
```

--------------------------------

### Import color-diff functions (ESM)

Source: https://www.npmjs.com/package/color-diff?activeTab=code

Import all available functions from the color-diff package using ECMAScript Module (ESM) syntax.

```javascript
import {
  closest,
  furthest,
  diff,
  mapPalette,
  paletteMapKey,
  rgbaToLab,
  mapPaletteLab,
  labPaletteMapKey,
} from "color-diff";
```

--------------------------------

### mapPalette(palette1, palette2)

Source: https://www.npmjs.com/package/color-diff

Creates a mapping from colors in the first palette to the closest colors in the second palette.

```APIDOC
## mapPalette(palette1, palette2)

### Description
Returns a mapping from the colors in palette1 to palette2.

### Parameters
#### Path Parameters
- **palette1** (Array.<Object>) - Required - The source color palette.
- **palette2** (Array.<Object>) - Required - The target color palette.

### Response
#### Success Response (200)
- **paletteMap** (Object) - An object where keys are colors from palette1 and values are their closest matches in palette2.
```

--------------------------------

### Import color-diff functions (CommonJS)

Source: https://www.npmjs.com/package/color-diff?activeTab=dependents

Import specific functions from the color-diff package using CommonJS module syntax.

```javascript
// CommonJS
const { 
  closest, 
  furthest, 
  diff, 
  mapPalette, 
  paletteMapKey, 
  rgbaToLab, 
  mapPaletteLab, 
  labPaletteMapKey,
} = require("color-diff");
```

--------------------------------

### Import color-diff functions (ESM)

Source: https://www.npmjs.com/package/color-diff?activeTab=dependents

Import specific functions from the color-diff package using ECMAScript Module (ESM) syntax.

```javascript
// ESM
import {
  closest,
  furthest,
  diff,
  mapPalette,
  paletteMapKey,
  rgbaToLab,
  mapPaletteLab,
  labPaletteMapKey,
} from "color-diff";
```

--------------------------------

### mapPalette(palette1, palette2)

Source: https://www.npmjs.com/package/color-diff?activeTab=versions

Generates a mapping from colors in the first palette to the closest colors in the second palette.

```APIDOC
## mapPalette(palette1, palette2)

### Description
Returns a mapping from the colors in palette1 to palette2.

### Parameters
- **palette1** (Array.<Object>) - Required - The source color palette.
- **palette2** (Array.<Object>) - Required - The target color palette.

### Response
- **paletteMap** (Object) - An object where keys are colors from `palette1` and values are their closest matches in `palette2`.
```

--------------------------------

### mapPaletteLab(palette1, palette2)

Source: https://www.npmjs.com/package/color-diff

Maps colors from palette1 to palette2 using LAB color space. This function is likely an internal helper or a variation of mapPalette for LAB colors.

```APIDOC
## mapPaletteLab(palette1, palette2)

### Description
Returns a mapping from the colors in palette1 to palette2, specifically designed for LAB colors.

### Parameters
#### Path Parameters
- **palette1** (Array.<Object>) - Required - The source color palette in LAB format.
- **palette2** (Array.<Object>) - Required - The target color palette in LAB format.

### Response
#### Success Response (200)
- **paletteMap** (Object) - An object mapping colors from palette1 to their closest matches in palette2.
```

--------------------------------

### mapPalette(palette1, palette2)

Source: https://www.npmjs.com/package/color-diff?activeTab=dependencies

Maps colors from one palette to another.

```APIDOC
## mapPalette(palette1, palette2)

### Description
Returns a mapping from the colors in palette1 to the closest colors in palette2.

### Parameters
- **palette1** (Array.<RGBAColor>) - Required - The source palette.
- **palette2** (Array.<RGBAColor>) - Required - The target palette.
```

--------------------------------

### mapPalette(palette1, palette2)

Source: https://www.npmjs.com/package/color-diff?activeTab=dependents

Returns a mapping from the colors in palette1 to palette2.

```APIDOC
## mapPalette(palette1, palette2)

### Description
Creates a mapping of colors from one palette to another.

### Parameters
- **palette1** (Array<RGBAColor>) - Required - Source palette.
- **palette2** (Array<RGBAColor>) - Required - Target palette.

### Response
- **mapping** (Object) - A map object linking colors from palette1 to palette2.
```

--------------------------------

### labPaletteMapKey(color)

Source: https://www.npmjs.com/package/color-diff?activeTab=versions

Generates a unique key for a color in LAB color space.

```APIDOC
## labPaletteMapKey(color)

### Description
Return the palette map key for the color, to be used with the result from mapPaletteLab.

### Parameters
- **color** (Object) - Required - The color in LAB format. Expected format: `{ L: number, a: number, b: number }`.

### Response
- **key** (string) - A unique string key representing the LAB color.
```

--------------------------------

### labPaletteMapKey(color)

Source: https://www.npmjs.com/package/color-diff

Generates a unique key for a LAB color, intended for use with LAB color palette mappings.

```APIDOC
## labPaletteMapKey(color)

### Description
Return the palette map key for the LAB color, to be used with the result from mapPaletteLab.

### Parameters
#### Path Parameters
- **color** (Object) - Required - The LAB color for which to generate a map key. Expected format: `{ L: number, a: number, b: number }`.

### Response
#### Success Response (200)
- **mapKey** (string) - A string representation of the LAB color, suitable for use as a map key.
```

--------------------------------

### Color Difference and Palette Mapping API

Source: https://www.npmjs.com/package/color-diff?activeTab=code

This section covers the core functions for color difference calculation, color space conversion, and palette manipulation.

```APIDOC
## closest(color, palette, bc)

### Description
Returns the closest color in the `palette` to the given `color`. The optional `bc` parameter specifies a background color, which is used when colors have alpha channels.

### Method
`closest`

### Parameters
- **color** (Object) - Required - The color to find the closest match for. Should be an RGBAColor or LabColor object.
- **palette** (Array<Object>) - Required - An array of RGBAColor or LabColor objects representing the available colors.
- **bc** (Object) - Optional - A background color object (RGBAColor or LabColor) to use for alpha channel calculations.

### Request Example
```javascript
const color = { R: 255, G: 1, B: 30 };
const palette = [ {R: 255, G: 0, B: 0 }, {R: 0, G: 255, B: 0 }, {R: 0, G: 0, B: 255} ];
closest(color, palette);
```

### Response
#### Success Response (200)
- **Object** - The RGBAColor or LabColor object from the palette that is closest to the input color.

### Response Example
```json
{ "R": 255, "G": 0, "B": 0 }
```

## furthest(color, palette, bc)

### Description
Returns the color in the `palette` that is furthest from the given `color`. The optional `bc` parameter specifies a background color, which is used when colors have alpha channels.

### Method
`furthest`

### Parameters
- **color** (Object) - Required - The color to find the furthest match from. Should be an RGBAColor or LabColor object.
- **palette** (Array<Object>) - Required - An array of RGBAColor or LabColor objects representing the available colors.
- **bc** (Object) - Optional - A background color object (RGBAColor or LabColor) to use for alpha channel calculations.

### Request Example
```javascript
const color = { R: 255, G: 255, B: 255 };
const palette = [ {R: 0, G: 0, B: 0 }, {R: 255, G: 255, B: 255 } ];
furthest(color, palette);
```

### Response
#### Success Response (200)
- **Object** - The RGBAColor or LabColor object from the palette that is furthest from the input color.

### Response Example
```json
{ "R": 0, "G": 0, "B": 0 }
```

## mapPalette(palette1, palette2)

### Description
Returns a mapping from the colors in `palette1` to the closest colors in `palette2`.

### Method
`mapPalette`

### Parameters
- **palette1** (Array<Object>) - Required - The source color palette.
- **palette2** (Array<Object>) - Required - The target color palette.

### Response
#### Success Response (200)
- **Object** - An object where keys are indices of colors in `palette1` and values are the closest matching colors from `palette2`.

## paletteMapKey(color)

### Description
Returns a unique key for a given color, which can be used in conjunction with the results from `mapPalette`.

### Method
`paletteMapKey`

### Parameters
- **color** (Object) - Required - The color object (RGBAColor or LabColor) to generate a key for.

### Response
#### Success Response (200)
- **string** - A string representation of the color, suitable as a map key.

## diff(color1, color2, bc)

### Description
Calculates the CIEDE2000 color difference between two colors. The optional `bc` parameter specifies a background color, which is used when colors have alpha channels.

### Method
`diff`

### Parameters
- **color1** (Object) - Required - The first color object (RGBAColor or LabColor).
- **color2** (Object) - Required - The second color object (RGBAColor or LabColor).
- **bc** (Object) - Optional - A background color object (RGBAColor or LabColor) to use for alpha channel calculations.

### Request Example
```javascript
const color1 = { L: 50, a: 10, b: -5 };
const color2 = { L: 60, a: 15, b: -10 };
diff(color1, color2);
```

### Response
#### Success Response (200)
- **number** - The calculated CIEDE2000 color difference value.

### Response Example
```json
10.5
```

## rgbaToLab(rgbaColor, bc)

### Description
Converts an RGBA color object to its CIELAB color space representation. The optional `bc` parameter specifies a background color, which is used in the conversion process, especially when alpha channels are present.

### Method
`rgbaToLab`

### Parameters
- **rgbaColor** (Object) - Required - The RGBA color object to convert. Must have R, G, B properties, and optionally A.
- **bc** (Object) - Optional - A background color object (RGBAColor or LabColor) to use for the conversion.

### Request Example
```javascript
const rgbaColor = { R: 255, G: 100, B: 50, A: 0.8 };
rgbaToLab(rgbaColor);
```

### Response
#### Success Response (200)
- **Object** - The CIELAB color object with L, a, and b properties.

### Response Example
```json
{ "L": 53.4, "a": 25.1, "b": 15.8 }
```

## mapPaletteLab(palette1, palette2)

### Description
Returns a mapping from the colors in `palette1` (assumed to be in LAB color space) to the closest colors in `palette2` (also assumed to be in LAB color space).

### Method
`mapPaletteLab`

### Parameters
- **palette1** (Array<Object>) - Required - The source color palette in LAB color space.
- **palette2** (Array<Object>) - Required - The target color palette in LAB color space.

### Response
#### Success Response (200)
- **Object** - An object where keys are indices of colors in `palette1` and values are the closest matching colors from `palette2`.

## labPaletteMapKey(labColor)

### Response
#### Success Response (200)
- **string** - A string representation of the LAB color, suitable as a map key.

### Description
Returns a unique key for a given LAB color, which can be used in conjunction with the results from `mapPaletteLab`.

### Method
`labPaletteMapKey`

### Parameters
- **labColor** (Object) - Required - The LAB color object to generate a key for.

### Request Example
```javascript
const labColor = { L: 50, a: 10, b: -5 };
labPaletteMapKey(labColor);
```

### Response Example
```json
"50,10,-5"
```
```

--------------------------------

### diff(color1, color2, bc)

Source: https://www.npmjs.com/package/color-diff?activeTab=dependents

Calculates the difference between two LAB colors using the CIEDE2000 algorithm.

```APIDOC
## diff(color1, color2, bc)

### Description
Returns the difference between two lab colors.

### Parameters
- **color1** (LabColor) - Required - First color.
- **color2** (LabColor) - Required - Second color.
- **bc** (RGBAColor) - Optional - Background color used if alpha channels are present.

### Response
- **difference** (Number) - The calculated CIEDE2000 difference.
```

--------------------------------

### paletteMapKey(color)

Source: https://www.npmjs.com/package/color-diff?activeTab=versions

Generates a unique key for a color, suitable for use with the results of mapPalette.

```APIDOC
## paletteMapKey(color)

### Description
Return the palette map key for the color, to be used with the result from mapPalette.

### Parameters
- **color** (Object) - Required - The color to generate a key for. Expected format: `{ R: number, G: number, B: number, A?: number }` or `{ r: number, g: number, b: number, a?: number }`.

### Response
- **key** (string) - A unique string key representing the color.
```

--------------------------------

### paletteMapKey(color)

Source: https://www.npmjs.com/package/color-diff

Generates a unique key for a color, suitable for use with palette mapping results.

```APIDOC
## paletteMapKey(color)

### Description
Return the palette map key for the color, to be used with the result from mapPalette.

### Parameters
#### Path Parameters
- **color** (Object) - Required - The color for which to generate a map key. Expected format: `{ R: number, G: number, B: number, A?: number }` or `{ r: number, g: number, b: number, a?: number }`.

### Response
#### Success Response (200)
- **mapKey** (string) - A string representation of the color, suitable for use as a map key.
```

--------------------------------

### diff(color1, color2, bc)

Source: https://www.npmjs.com/package/color-diff

Calculates the CIEDE2000 color difference between two colors. An optional background color can be provided for alpha channel calculations.

```APIDOC
## diff(color1, color2, bc)

### Description
Returns the difference between the lab colors color1 and color2. The parameter bc is optional and is used as background color when one of the colors uses alpha channels.

### Parameters
#### Path Parameters
- **color1** (Object) - Required - The first color. Expected format: `{ R: number, G: number, B: number, A?: number }` or `{ r: number, g: number, b: number, a?: number }`.
- **color2** (Object) - Required - The second color. Expected format: `{ R: number, G: number, B: number, A?: number }` or `{ r: number, g: number, b: number, a?: number }`.
- **bc** (Object) - Optional - The background color, used for alpha channel calculations. Expected format: `{ R: number, G: number, B: number, A?: number }` or `{ r: number, g: number, b: number, a?: number }`.

### Data Types
#### RGBAColor
`Object`
`RGBAColor` is an object containing 4 properties: 'R', 'G', 'B', 'A', where 'A' is optional OR 'r', 'g', 'b', 'a', where 'a' is optional. Such as:
```
{ R: 255, G: 1, B: 0 }
```
There is an optional property 'A', which specifies the alpha channel between 0.0 and 1.0. If not present the color will be treated as fully opaque, i.e. A = 1.0.
Each RGBA-color is transformed into a RGB-color before being used to calculate the CIEDE2000 difference, using the specified background color (defaults to white).

#### LabColor
`Object`
`LabColor` is an object containing 3 properties 'L', 'a', 'b' such as:
```
{ L: 100, a: 0.005, b: -0.010 }
```

#### Palette
`Array.<RGBAColor>`
Color palette array which contains many `RGBAColor` objects.

### Response
#### Success Response (200)
- **difference** (number) - The CIEDE2000 color difference value between color1 and color2.
```

--------------------------------

### diff(color1, color2, bc)

Source: https://www.npmjs.com/package/color-diff?activeTab=versions

Calculates the CIEDE2000 color difference between two colors. An optional background color can be provided for alpha channel calculations.

```APIDOC
## diff(color1, color2, bc)

### Description
Returns the difference between the lab colors color1 and color2. The parameter bc is optional and is used as background color when one of the colors uses alpha channels.

### Parameters
- **color1** (Object) - Required - The first color. Expected format: `{ R: number, G: number, B: number, A?: number }` or `{ r: number, g: number, b: number, a?: number }`.
- **color2** (Object) - Required - The second color. Expected format: `{ R: number, G: number, B: number, A?: number }` or `{ r: number, g: number, b: number, a?: number }`.
- **bc** (Object) - Optional - The background color to use for alpha channel calculations. Expected format: `{ R: number, G: number, B: number, A?: number }` or `{ r: number, g: number, b: number, a?: number }`.

### Request Example
```javascript
const color1 = { R: 255, G: 0, B: 0 }; // Red
const color2 = { R: 0, G: 0, B: 255 }; // Blue

const difference = diff(color1, color2);
console.log(difference); // CIEDE2000 difference value
```

### Response
- **difference** (number) - The CIEDE2000 color difference value between `color1` and `color2`.
```

--------------------------------

### diff(color1, color2, bc)

Source: https://www.npmjs.com/package/color-diff?activeTab=dependencies

Calculates the difference between two LAB colors.

```APIDOC
## diff(color1, color2, bc)

### Description
Returns the difference between two lab colors using the CIEDE2000 algorithm.

### Parameters
- **color1** (LabColor) - Required - The first color.
- **color2** (LabColor) - Required - The second color.
- **bc** (RGBAColor) - Optional - Background color used if alpha channels are present.
```

--------------------------------

### rgbaToLab(color, bc)

Source: https://www.npmjs.com/package/color-diff

Converts an RGBA color to its LAB color space representation. An optional background color can be provided.

```APIDOC
## rgbaToLab(color, bc)

### Description
Converts an RGBA color to a LAB color.

### Parameters
#### Path Parameters
- **color** (Object) - Required - The RGBA color to convert. Expected format: `{ R: number, G: number, B: number, A?: number }` or `{ r: number, g: number, b: number, a?: number }`.
- **bc** (Object) - Optional - The background color, used in the conversion process. Expected format: `{ R: number, G: number, B: number, A?: number }` or `{ r: number, g: number, b: number, a?: number }`.

### Response
#### Success Response (200)
- **labColor** (Object) - The converted color in LAB format. Expected format: `{ L: number, a: number, b: number }`.
```

--------------------------------

### rgbaToLab(color)

Source: https://www.npmjs.com/package/color-diff?activeTab=versions

Converts an RGBA color to LAB color space.

```APIDOC
## rgbaToLab(color)

### Description
Converts an RGBA color to LAB color space.

### Parameters
- **color** (Object) - Required - The RGBA color to convert. Expected format: `{ R: number, G: number, B: number, A?: number }` or `{ r: number, g: number, b: number, a?: number }`.

### Request Example
```javascript
const rgbaColor = { R: 255, G: 1, B: 30 };
const labColor = rgbaToLab(rgbaColor);
console.log(labColor); // { L: ..., a: ..., b: ... }
```

### Response
- **labColor** (Object) - The color converted to LAB format. Contains 'L', 'a', 'b' properties.
```

--------------------------------

### closest(color, palette, bc)

Source: https://www.npmjs.com/package/color-diff?activeTab=dependencies

Finds the closest color in a palette to a given input color.

```APIDOC
## closest(color, palette, bc)

### Description
Returns the closest color from a provided palette based on the CIEDE2000 difference algorithm.

### Parameters
- **color** (RGBAColor) - Required - The target color to match.
- **palette** (Array.<RGBAColor>) - Required - The palette of colors to search through.
- **bc** (RGBAColor) - Optional - Background color used for alpha channel calculations.
```

--------------------------------

### Calculate color difference

Source: https://www.npmjs.com/package/color-diff?activeTab=code

The `diff` function calculates the CIEDE2000 difference between two colors. An optional background color `bc` can be provided for alpha channel calculations.

```javascript
const color1 = { R: 255, G: 1, B: 0 };
const color2 = { L: 100, a: 0.005, b: -0.010 };

diff(color1, color2);
```

--------------------------------

### Find closest color

Source: https://www.npmjs.com/package/color-diff

Identify the color in a palette that is closest to a target color.

```javascript
const color = { R: 255, G: 1, B: 30 };
// red, green, blue
const palette = [ {R: 255, G: 0, B: 0 },
                {R: 0, G: 255, B: 0 },
                {R: 0, G: 0, B: 255} ];

closest(color, palette); // {R: 255, G: 0, B: 0 }, red
```

--------------------------------

### furthest(color, palette, bc)

Source: https://www.npmjs.com/package/color-diff?activeTab=dependencies

Finds the most different color in a palette compared to a given input color.

```APIDOC
## furthest(color, palette, bc)

### Description
Returns the most different color from a provided palette based on the CIEDE2000 difference algorithm.

### Parameters
- **color** (RGBAColor) - Required - The target color.
- **palette** (Array.<RGBAColor>) - Required - The palette of colors to search through.
- **bc** (RGBAColor) - Optional - Background color used for alpha channel calculations.
```

--------------------------------

### furthest(color, palette, bc)

Source: https://www.npmjs.com/package/color-diff?activeTab=dependents

Returns the most different color from a provided palette based on the CIEDE2000 difference.

```APIDOC
## furthest(color, palette, bc)

### Description
Returns the most different color from a palette compared to the target color.

### Parameters
- **color** (RGBAColor) - Required - The target color.
- **palette** (Array<RGBAColor>) - Required - The array of colors to search through.
- **bc** (RGBAColor) - Optional - Background color used when alpha channels are present.

### Response
- **color** (RGBAColor) - The most different color found in the palette.
```

--------------------------------

### Find furthest color

Source: https://www.npmjs.com/package/color-diff

Identify the color in a palette that is most different from a target color.

```javascript
const color = { R: 255, G: 255, B: 255 };
// black, white
const palette = [ {R: 0, G: 0, B: 0 }, {R: 255, G: 255, B: 255 } ];

furthest(color, palette); // {R: 0, G: 0, B: 0 }, black
```

--------------------------------

### furthest(color, palette, bc)

Source: https://www.npmjs.com/package/color-diff

Finds the furthest color in a given palette from a specified color. An optional background color can be provided for alpha channel calculations.

```APIDOC
## furthest(color, palette, bc)

### Description
Returns the most different color. The parameter bc is optional and is used as background color when the color and/or palette uses alpha channels.

### Parameters
#### Path Parameters
- **color** (Object) - Required - The color to find the furthest match from. Expected format: `{ R: number, G: number, B: number, A?: number }` or `{ r: number, g: number, b: number, a?: number }`.
- **palette** (Array.<Object>) - Required - An array of colors to search within. Each color should be in the same format as the `color` parameter.
- **bc** (Object) - Optional - The background color, used for alpha channel calculations. Expected format: `{ R: number, G: number, B: number, A?: number }` or `{ r: number, g: number, b: number, a?: number }`.

### Request Example
```javascript
const color = { R: 255, G: 255, B: 255 };
const palette = [ {R: 0, G: 0, B: 0 }, {R: 255, G: 255, B: 255 } ];

const furthestColor = furthest(color, palette);
console.log(furthestColor); // Output: { R: 0, G: 0, B: 0 }
```

### Response
#### Success Response (200)
- **furthestColor** (Object) - The color from the palette that is furthest from the input color.
```

--------------------------------

### furthest(color, palette, bc)

Source: https://www.npmjs.com/package/color-diff?activeTab=versions

Returns the furthest color from a palette to a given color. An optional background color can be provided for alpha channel calculations.

```APIDOC
## furthest(color, palette, bc)

### Description
Returns the most different color. The parameter bc is optional and is used as background color when the color and/or palette uses alpha channels.

### Parameters
- **color** (Object) - Required - The color to find the furthest match from. Expected format: `{ R: number, G: number, B: number, A?: number }` or `{ r: number, g: number, b: number, a?: number }`.
- **palette** (Array.<Object>) - Required - An array of colors to search within. Each color should be in the same format as the `color` parameter.
- **bc** (Object) - Optional - The background color to use for alpha channel calculations. Expected format: `{ R: number, G: number, B: number, A?: number }` or `{ r: number, g: number, b: number, a?: number }`.

### Request Example
```javascript
const color = { R: 255, G: 255, B: 255 };
const palette = [ {R: 0, G: 0, B: 0 }, {R: 255, G: 255, B: 255 } ];

const furthestColor = furthest(color, palette);
console.log(furthestColor); // {R: 0, G: 0, B: 0 }
```

### Response
- **furthestColor** (Object) - The color from the palette that is furthest from the input color.
```
Tokens:
Raw