Class ColorMeta<C>

Class representing meta informations about a color space. Useful to generalize/factorize some manipulations and to push the tree-shaking.

Type Parameters

C extends Color

Index

Accessors

chromaIndex classDef componentNames componentNumber componentUnits constraint css hdrLimits hueIndex lightnessIndex luminance name sdrLimits xyyBoundaries

Methods

componentIndex componentName hasComponent fromConfig

Accessors

chromaIndex

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

Returns number | null
The component index.
- Defined in base/ColorMeta.ts:177

classDef

get classDef(): ColorConstructor<C>
Get the color space class.

Returns ColorConstructor<C>
The class.
- Defined in base/ColorMeta.ts:186

componentNames

get componentNames(): readonly string[]
Get the component names.

Returns readonly string[]
The component names.
- Defined in base/ColorMeta.ts:195

componentNumber

get componentNumber(): number
Get the number of components.

Returns number
The number of components.
- Defined in base/ColorMeta.ts:204

componentUnits

get componentUnits(): ColorUnit[]
Get the component units.

Returns ColorUnit[]
The component units.
- Defined in base/ColorMeta.ts:213

constraint

get constraint(): ((comps: number[]) => number[]) | undefined
Get the constraint function.

Returns ((comps: number[]) => number[]) | undefined
The constraint function.
- Defined in base/ColorMeta.ts:222

css

get css(): CssMetaInfo | null
Get the css meta info. Return null of no CSS representation is possible for this color space.

Returns CssMetaInfo | null
The CSS meta info.
- Defined in base/ColorMeta.ts:233

hdrLimits

get hdrLimits(): readonly ColorLimit[]
Get the HDR limits.

Returns readonly ColorLimit[]
The limits.
- Defined in base/ColorMeta.ts:242

hueIndex

get hueIndex(): number | null
Get the 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/ColorMeta.ts:253

lightnessIndex

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

Returns number | null
The component index.
- Defined in base/ColorMeta.ts:263

luminance

get luminance(): ColorLimit
Get the standardized luminance limit inside xyY space.

Returns ColorLimit
- Defined in base/ColorMeta.ts:269

name

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

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

sdrLimits

get sdrLimits(): readonly ColorLimit[]
Get the SDR limits.

Returns readonly ColorLimit[]
The limits.
- Defined in base/ColorMeta.ts:287

xyyBoundaries

get xyyBoundaries(): Point2D[] | null
Get the cohordinates of the polygon delimiting the color validity in xyY space.

Returns Point2D[] | null
The cohordinates.
- Defined in base/ColorMeta.ts:297

Methods

componentIndex

componentIndex(name: string): number | null
Get the component index by name. Returns null if no name matches.
Parameters
- name: string
  The component name.
Returns number | null
The index.
- Defined in base/ColorMeta.ts:308

componentName

componentName(index: number): string | null
Get the component name by index. Returns null if no index matches.
Parameters
- index: number
  The component indxe.
Returns string | null
The index.
- Defined in base/ColorMeta.ts:321

hasComponent

hasComponent(name: string): boolean
Check whether the component name is valid.
Parameters
- name: string
Returns boolean
True if valid.
- Defined in base/ColorMeta.ts:334

`Static`fromConfig

fromConfig<C extends Color>(config: ColorMetaConfig<C>): ColorMeta<C>
Create an instance.
Type Parameters
- C extends Color
Parameters
- config: ColorMetaConfig<C>
  The configuration.
Returns ColorMeta<C>
The new instance.
- Defined in base/ColorMeta.ts:165