Class Color`Abstract`

Abstract Base Class for all color spaces. Provides shared functionality for conversion, mixing, manipulation, and analysis (DeltaE, WCAG contrast, Tone Mapping, etc.).

Hierarchy (View Summary)

Color
- AcesCg
- AdobeRgb
- Cmyk
- Hsl
- Hsv
- Hwb
- ICtCp
- JzAzBz
- JzCzHz
- Lab
- Lch
- LchUv
- LinearRgb
- Lms
- Lms2006
- LmsCat02
- LmsHpe
- Luv
- Oklab
- Oklch
- P3
- ProPhoto
- Rec2020
- Rec709
- Rgb
- Xyy
- Xyz
- XyzD50
- YCbCr
- Yuv

Constructors

`Protected`constructor

new Color(alpha: number, meta: ColorMeta<Color>): Color
Constructor.
Parameters
- alpha: number
  The alpha channel.
- meta: ColorMeta<Color>
  The reference to the colorspace specific meta instance.
Returns Color
- Defined in base/Color.ts:39

Properties

`Protected` `Readonly`_alpha

_alpha: number

The alpha channel. Common to all color spaces.

`Protected` `Readonly`_meta

_meta: ColorMeta<Color>

Pointer to concrete color spaces meta-information.

Accessors

alpha

get alpha(): number
Get the alpha channel.

Returns number
The value.
- Defined in base/Color.ts:94

chromaIndex

get chromaIndex(): number | null
Get the color chroma index. Return null if the color has no chroma component.

Returns number | null
The component index.
- Defined in base/Color.ts:104

colorSpace

get colorSpace(): (keyof PolarColorSpaces) | (keyof CartesianColorSpaces)
Get the color space name.

Returns (keyof PolarColorSpaces) | (keyof CartesianColorSpaces)
The color space name.
- Defined in base/Color.ts:113

`Abstract`components

get components(): number[]
Get the color components as an array of values. The last element is always the alpha channel. The other components follow the color space name, e.g. RGB: [R, G, B, alpha].

Returns number[]
The component values.
- Defined in base/Color.ts:441

hueIndex

get hueIndex(): number | null
Get the color hue index. Return null if the color has no hue component (i.e. it is not cylindrical).

Returns number | null
The component index.
- Defined in base/Color.ts:124

lightnessIndex

get lightnessIndex(): number | null
Get the color lightness index. Return null if the color has no lightness component.

Returns number | null
The component index.
- Defined in base/Color.ts:134

`Protected` `Static`_acromaticEpsilon

get _acromaticEpsilon(): number
Get the tollerance value for achromatic check.

Returns number
- Defined in base/Color.ts:471

Methods

clipHdr

clipHdr(): this
Clip the color to match its HDR range.

Returns this
The clipped color.
- Defined in base/Color.ts:152

clipSdr

clipSdr(): this
Clip the color to match its SDR range.

Returns this
The clipped color.
- Defined in base/Color.ts:169

getComponentByIndex

getComponentByIndex(index: number): number
Get the component value by index.
Parameters
- index: number
  The index.
Returns number
The component.

Throws
If the index is invalid.
- Defined in base/Color.ts:188

getComponentByName

getComponentByName(name: string): number
Get the component value by name.
Parameters
- name: string
  The name.
Returns number
The component.

Throws
If the name is invalid.
- Defined in base/Color.ts:204

`Abstract`isAchromatic

isAchromatic(): boolean
Check whether the color is achromatic. I.e. almost white/black/gray.

Returns boolean
Trus if the color is achromatic.
- Defined in base/Color.ts:447

isColorSpace

isColorSpace<C extends Color>(space: ColorConstructor<C>): this is C
Check whether the color is in a specific color space.
Type Parameters
- C extends Color
Parameters
- space: ColorConstructor<C>
  The color space.
Returns this is C
True if this is in the color space.
- Defined in base/Color.ts:220

isColorSpaceName

isColorSpaceName<
    N extends (keyof PolarColorSpaces)
    | (keyof CartesianColorSpaces),
>(
    name: N,
): this is ColorSpaceNames[N]
Check whether the color is in a specific color space.
Type Parameters
- N extends (keyof PolarColorSpaces) | (keyof CartesianColorSpaces)
Parameters
- name: N
  The color space name.
Returns this is ColorSpaceNames[N]
True if this is in the color space.
- Defined in base/Color.ts:232

isInHdr

isInHdr(): boolean
Check whether the color respects its color space boundaries for HDR.

Returns boolean
The check result.
- Defined in base/Color.ts:243

isInSdr

isInSdr(): boolean
Check whether the color respects its color space boundaries for SDR.

Returns boolean
The check result.
- Defined in base/Color.ts:261

setAlpha

setAlpha(v: number): this
Set the alpha component.
Parameters
- v: number
  The new value.
Returns this
The new instance with the alpha changed.
- Defined in base/Color.ts:280

setComponentByIndex

setComponentByIndex(index: number, value: number): this
Set the component by index.
Parameters
- index: number
  The component index.
- value: number
  The new value.
Returns this
The new instance with the component changed.

Throws
If the index is invalid.
- Defined in base/Color.ts:294

setComponentByName

setComponentByName(name: string, value: number): this
Set the component by name.
Parameters
- name: string
  The component name.
- value: number
  The new value.
Returns this
The new instance with the component changed.

Throws
If the name is invlaid.
- Defined in base/Color.ts:312

`Abstract`setComponents

setComponents(values: number[]): this
Set the component vlaues. The last one is always the alpha channel. The other components follow the color space name, e.g. RGB: [R, G, B, alpha].
Parameters
- values: number[]
  The values to set.
Returns this
A new instance of the target color space.
- Defined in base/Color.ts:456

to

to<T extends Color>(targetSpace: ColorConstructor<T>): T
Converts this color to any other color space.
Type Parameters
- T extends Color
Parameters
- targetSpace: ColorConstructor<T>
  The class constructor of the target space (e.g., Rgb, Oklch).
Returns T
A new instance of the target color space.
Example
```
const oklch = myRgb.to(Oklch);
```
- Defined in base/Color.ts:331

toColorSpaceOf

toColorSpaceOf<T extends Color>(color: T): T
Converts this color to the color space of the other color.
Type Parameters
- T extends Color
Parameters
- color: T
  The color of which match the color space.
Returns T
A new instance of the target color space.
- Defined in base/Color.ts:342

`Abstract`toJSON

toJSON(): ColorJson
Return a JSON describing the component values.

Returns ColorJson
The JSON.
- Defined in base/Color.ts:461

`Abstract`toXyz

toXyz(): Xyz
Map this color to XYZ space color.

Returns Xyz
The mapped color.
- Defined in base/Color.ts:466

tryGetChroma

tryGetChroma(): number | null
Get the chroma component value. Return null if the color has no chroma component.

Returns number | null
The chroma value.
- Defined in base/Color.ts:355

tryGetHue

tryGetHue(): number | null
Get the hue component value. Return null if the color has no hue component.

Returns number | null
The hue value.
- Defined in base/Color.ts:367

tryGetLightness

tryGetLightness(): number | null
Get the lightness component value. Return null if the color has no lightness component.

Returns number | null
The lightness value.
- Defined in base/Color.ts:379

trySetChroma

trySetChroma(c: number | null): this
Set the chroma component value. If null is passed, nothing is done.
Parameters
- c: number | null
  The new chroma value.
Returns this
A new instance of the target color space.
- Defined in base/Color.ts:392

trySetHue

trySetHue(h: number | null): this
Set the hue component value. If null is passed, nothing is done.
Parameters
- h: number | null
  The new hue value.
Returns this
A new instance of the target color space.
- Defined in base/Color.ts:408

trySetLightness

trySetLightness(l: number | null): this
Set the lightness component value. If null is passed, nothing is done.
Parameters
- l: number | null
  The new lightness value.
Returns this
A new instance of the target color space.
- Defined in base/Color.ts:424

`Static`equals

equals<C extends Color>(c1: C, c2: C, epsilon?: number): boolean
Check whether two colors are equals. If they are of different color spaces, they are considered different.
Type Parameters
- C extends Color
Parameters
- c1: C
  The first color.
- c2: C
  The second color.
- Optionalepsilon: number
Returns boolean
True of they are equals.
- Defined in base/Color.ts:52

`Static`toComponents

toComponents(
    srcComps: number[],
    srcClassDef: ColorConstructor<Color>,
    dstClassDef: ColorConstructor<Color>,
): number[]
Convert source components to destination components.
Parameters
- srcComps: number[]
  The source components.
- srcClassDef: ColorConstructor<Color>
  The source components class definition.
- dstClassDef: ColorConstructor<Color>
  The destination components class definition.
Returns number[]
The converted components.
- Defined in base/Color.ts:80

Class ColorAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

Protectedconstructor

Parameters

Returns Color

Properties

Protected Readonly_alpha

Protected Readonly_meta

Accessors

alpha

Returns number

chromaIndex

Returns number | null

colorSpace

Returns (keyof PolarColorSpaces) | (keyof CartesianColorSpaces)

Abstractcomponents

Returns number[]

hueIndex

Returns number | null

lightnessIndex

Returns number | null

meta

Returns ColorMeta<this>

Protected Static_acromaticEpsilon

Returns number

Methods

clipHdr

Returns this

clipSdr

Returns this

getComponentByIndex

Parameters

Returns number

Throws

getComponentByName

Parameters

Returns number

Throws

AbstractisAchromatic

Returns boolean

isColorSpace

Type Parameters

Parameters

Returns this is C

isColorSpaceName

Type Parameters

Parameters

Returns this is ColorSpaceNames[N]

isInHdr

Returns boolean

isInSdr

Returns boolean

setAlpha

Parameters

Returns this

setComponentByIndex

Parameters

Returns this

Throws

setComponentByName

Parameters

Returns this

Throws

AbstractsetComponents

Parameters

Returns this

to

Type Parameters

Parameters

Returns T

Example

toColorSpaceOf

Type Parameters

Parameters

Class Color`Abstract`

`Protected`constructor

`Protected` `Readonly`_alpha

`Protected` `Readonly`_meta

`Abstract`components

`Protected` `Static`_acromaticEpsilon

`Abstract`isAchromatic

`Abstract`setComponents

`Abstract`toJSON

`Abstract`toXyz

`Static`equals

`Static`toComponents