Class Xyz

CIE 1931 XYZ. The root of all color spaces. Represents physical linear light.

White Point: D65 (Standard for sRGB, P3, Rec.2020, etc.).
Y: Luminance (0.0 - 1.0 for SDR, > 1.0 for HDR).

Hierarchy (View Summary)

Color
- Xyz

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.

`Static` `Readonly`META

META: ColorMeta<Xyz> = ...

The meta instance.

Accessors

alpha

get alpha(): number
Get the alpha channel.

Returns number
The value.
Inherited from Color.alpha
- 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.
Inherited from Yuv.chromaIndex
- 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.
Inherited from Color.colorSpace
- Defined in base/Color.ts:113

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.
Overrides Color.components
- Defined in colorSpaces/Xyz.ts:212

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.
Inherited from Yuv.hueIndex
- 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.
Inherited from Yuv.lightnessIndex
- Defined in base/Color.ts:134

x

get x(): number
Get the x component.

Returns number
The component.
- Defined in colorSpaces/Xyz.ts:221

y

get y(): number
Get the y component.

Returns number
The component.
- Defined in colorSpaces/Xyz.ts:230

z

get z(): number
Get the z component.

Returns number
The component.
- Defined in colorSpaces/Xyz.ts:239

`Protected` `Static`_acromaticEpsilon

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

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

`Static`black

get black(): Xyz
The base black color in this color space.

Returns Xyz
The black color.
- Defined in colorSpaces/Xyz.ts:93

`Static`gray

get gray(): Xyz
The base gray color in this color space. Mathematical center (Y=0.5). Scaled from D65 White Point. Visually looks very bright (linear space).

Returns Xyz
The gray color.
- Defined in colorSpaces/Xyz.ts:105

`Static`middleGray

get middleGray(): Xyz
The base perceptual gray color in this color space. Perceptual Middle Gray (L* = 50). Corresponds to Y = 0.1842 (scaled from D65).

Returns Xyz
The gray color.
- Defined in colorSpaces/Xyz.ts:116

`Static`transparent

get transparent(): Xyz
The base transparent color in this color space.

Returns Xyz
The transparent color.
- Defined in colorSpaces/Xyz.ts:125

`Static`white

get white(): Xyz
The base white color in this color space. Standard D65 White. X=0.95047, Y=1.00000, Z=1.08883.

Returns Xyz
The white color.
- Defined in colorSpaces/Xyz.ts:136

`Static`whitePoint

get whitePoint(): Xyz
Get the white point.

Returns Xyz
The white point.
- Defined in colorSpaces/Xyz.ts:145

Methods

clipHdr

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

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

clipSdr

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

Returns this
The clipped color.
Inherited from Color.clipSdr
- 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.
Inherited from Color.getComponentByIndex
- 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.
Inherited from Color.getComponentByName
- Defined in base/Color.ts:204

isAchromatic

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

Returns boolean
Trus if the color is achromatic.
Overrides Color.isAchromatic
- Defined in colorSpaces/Xyz.ts:244

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.
Inherited from Color.isColorSpace
- 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.
Inherited from Color.isColorSpaceName
- 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.
Inherited from Color.isInHdr
- 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.
Inherited from Color.isInSdr
- 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.
Inherited from Color.setAlpha
- 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.
Inherited from Color.setComponentByIndex
- 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.
Inherited from Color.setComponentByName
- Defined in base/Color.ts:312

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.
Overrides Color.setComponents
- Defined in colorSpaces/Xyz.ts:273

setX

setX(v: number): Xyz
Set the x component.
Parameters
- v: number
  The new value.
Returns Xyz
The new instance.
- Defined in colorSpaces/Xyz.ts:283

setY

setY(v: number): Xyz
Set the y component.
Parameters
- v: number
  The new value.
Returns Xyz
The new instance.
- Defined in colorSpaces/Xyz.ts:293

setZ

setZ(v: number): Xyz
Set the z component.
Parameters
- v: number
  The new value.
Returns Xyz
A new instance.
- Defined in colorSpaces/Xyz.ts:303

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);
```
Inherited from Color.to
- 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.
Inherited from Color.toColorSpaceOf
- Defined in base/Color.ts:342

toJSON

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

Returns XyzJsonAlpha
The JSON.
Overrides Color.toJSON
- Defined in colorSpaces/Xyz.ts:308

toXyz

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

Returns this
The mapped color.
Overrides Color.toXyz
- Defined in colorSpaces/Xyz.ts:318

tryGetChroma

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

Returns number | null
The chroma value.
Inherited from Color.tryGetChroma
- 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.
Inherited from Color.tryGetHue
- 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.
Inherited from Color.tryGetLightness
- 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.
Inherited from Color.trySetChroma
- 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.
Inherited from Color.trySetHue
- 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.
Inherited from Color.trySetLightness
- 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.
Inherited from Color.equals
- Defined in base/Color.ts:52

`Static`fromComponents

fromComponents(comps: number[]): Xyz
Create an instance from its components.
Parameters
- comps: number[]
  The components.
Returns Xyz
The new instance.

Throws
If the components length is invalid.
- Defined in colorSpaces/Xyz.ts:157

`Static`fromJSON

fromJSON(json: XyzJson | XyzJsonAlpha): Xyz
Create an instance from its JSON representation.
Parameters
- json: XyzJson | XyzJsonAlpha
  The JSON.
Returns Xyz
The new instance.
- Defined in colorSpaces/Xyz.ts:168

`Static`fromXyz

fromXyz(color: Xyz): Xyz
Convert a XYZ color to this space. It is just a mathematic conversion. It does nothing obviously.
Parameters
- color: Xyz
  the input color.
Returns Xyz
The color.
- Defined in colorSpaces/Xyz.ts:185

`Static`fromXyzComponents

fromXyzComponents(xyzComps: number[]): number[]
Convert XYZ components to this color space components. It does nothing but returning a new instance.
Parameters
- xyzComps: number[]
  The XYZ components as [x, y, z, alpha].
Returns number[]
The color space components as [x, y, z, alpha].
- Defined in colorSpaces/Xyz.ts:196

`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.
Inherited from Color.toComponents
- Defined in base/Color.ts:80

`Static`toXyzComponents

toXyzComponents(comps: number[]): number[]
Convert this color space components to XYZ components. It does nothing but returning a new instance.
Parameters
- comps: number[]
  The color space components as [x, y, z, alpha].
Returns number[]
The XYZ components as [x, y, z, alpha].
- Defined in colorSpaces/Xyz.ts:207

Class Xyz

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

Protected Readonly_alpha

Protected Readonly_meta

Static ReadonlyMETA

Accessors

alpha

Returns number

chromaIndex

Returns number | null

colorSpace

Returns (keyof PolarColorSpaces) | (keyof CartesianColorSpaces)

components

Returns number[]

hueIndex

Returns number | null

lightnessIndex

Returns number | null

meta

Returns ColorMeta<this>

x

Returns number

y

Returns number

z

Returns number

Protected Static_acromaticEpsilon

Returns number

Staticblack

Returns Xyz

Staticgray

Returns Xyz

StaticmiddleGray

Returns Xyz

Statictransparent

Returns Xyz

Staticwhite

Returns Xyz

StaticwhitePoint

Returns Xyz

Methods

clipHdr

Returns this

clipSdr

Returns this

getComponentByIndex

Parameters

Returns number

Throws

getComponentByName

Parameters

Returns number

Throws

isAchromatic

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

`Protected` `Readonly`_alpha

`Protected` `Readonly`_meta

`Static` `Readonly`META

`Protected` `Static`_acromaticEpsilon

`Static`black

`Static`gray

`Static`middleGray

`Static`transparent

`Static`white

`Static`whitePoint

`Static`equals

`Static`fromComponents

`Static`fromJSON

`Static`fromXyz

`Static`fromXyzComponents

`Static`toComponents

`Static`toXyzComponents