Class RGBColorSpace

Convenience class for RGB color spaces

Hierarchy (view full)

Space
- RGBColorSpace

Index

Constructors

Constructors

constructor

new RGBColorSpace(options): RGBColorSpace
Creates a new RGB ColorSpace. If coords are not specified, they will use the default RGB coords. Instead of fromBase() and toBase() functions, you can specify to/from XYZ matrices and have the default toBase() and fromBase() methods use them via this.M.toXYZ and this.M.fromXYZ.
Parameters
- options: RGBOptions
Returns RGBColorSpace
Overrides Space.constructor
- Defined in RGBColorSpace.js:19

Properties

`Optional`aliases

aliases?: string[]

base

base: Space

bases

bases: Space[]

This space's ancestors, ordered closest first (immediate base → root), excluding this space

coords

coords: Record<string, CoordMeta>

`Optional`displaySpaces

displaySpaces?: Space[]

Spaces to try when serializing for display and this space is not natively supported

formats

formats: Record<string, SpaceFormat>

gamutSpace

gamutSpace: Space

id

id: string

`Optional`linearGamut

linearGamut?: RGBColorSpace

M

M: Record<string, Matrix3x3>

Matrices relevant to this color space, keyed by a descriptive name

name

name: string

`Optional`referred

referred?: string

`Optional`rgbGamut

rgbGamut?: RGBColorSpace

white

white: White

`Static`DEFAULT_FORMAT

DEFAULT_FORMAT: {
name: "color";
type: "functions";
}

`Static`registry

registry: Record<string, Space>

Accessors

cssId

get cssId(): string
The ID used by CSS, such as display-p3 or --cam16-jmh

Returns string
Inherited from ColorSpace.cssId
- Defined in ColorSpace.d.ts:137

isPolar

get isPolar(): boolean
Returns boolean
Inherited from ColorSpace.isPolar
- Defined in ColorSpace.d.ts:138

isUnbounded

get isUnbounded(): boolean
Returns boolean
Inherited from ColorSpace.isUnbounded
- Defined in ColorSpace.d.ts:139

`Static`all

get all(): Space[]
Returns Space[]
Inherited from ColorSpace.all
- Defined in ColorSpace.d.ts:132

Methods

equals

equals(space): boolean
Parameters
- space: string | Space
Returns boolean
Inherited from Space.equals
- Defined in ColorSpace.d.ts:175

from

from(color): Coords
Parameters
- color: ColorTypes
Returns Coords
Inherited from Space.from
- Defined in ColorSpace.d.ts:161
from(space, coords): Coords
Parameters
- space: string | Space
- coords: Coords
Returns Coords
Inherited from Space.from
- Defined in ColorSpace.d.ts:162

fromBase

fromBase(xyz): Vector3
Parameters
- xyz: any
Returns Vector3
Overrides Space.fromBase
- Defined in RGBColorSpace.js:67

getFormat

getFormat(format?): Format
Parameters
- Optionalformat: string | SpaceFormat | Format
Returns Format
Inherited from Space.getFormat
- Defined in ColorSpace.d.ts:164

getMinCoords

getMinCoords(): Coords
Returns Coords
Inherited from Space.getMinCoords
- Defined in ColorSpace.d.ts:166

inGamut

inGamut(coords, options?): boolean
Parameters
- coords: Coords
- Optionaloptions: {
  epsilon?: number;
  }
  - Optionalepsilon?: number
Returns boolean
Inherited from Space.inGamut
- Defined in ColorSpace.d.ts:168

to

to(color): Coords
Parameters
- color: ColorTypes
Returns Coords
Inherited from Space.to
- Defined in ColorSpace.d.ts:170
to(space, coords): Coords
Parameters
- space: string | Space
- coords: Coords
Returns Coords
Inherited from Space.to
- Defined in ColorSpace.d.ts:171

toBase

toBase(rgb): Vector3
Parameters
- rgb: any
Returns Vector3
Overrides Space.toBase
- Defined in RGBColorSpace.js:56

toString

toString(): string
Returns string
Inherited from Space.toString
- Defined in ColorSpace.d.ts:173

`Static`findFormat

findFormat(filters, spaces?): Format
Parameters
- filters: string | object
- Optionalspaces: Space[]
Returns Format
Inherited from Space.findFormat
- Defined in ColorSpace.d.ts:134

`Static`get

get(space, ...alternatives): Space
Parameters
- space: string | Space
- Rest...alternatives: (string | Space)[]
Returns Space
Throws
If no matching color space is found
Inherited from Space.get
- Defined in ColorSpace.d.ts:110

`Static`register

register(space): Space
Parameters
- space: Space
Returns Space
Throws
If a space with the provided id already exists
Inherited from Space.register
- Defined in ColorSpace.d.ts:127
register(id, space): Space
Parameters
- id: string
- space: Space
Returns Space
Inherited from Space.register
- Defined in ColorSpace.d.ts:128

`Static`resolveCoord

resolveCoord(ref, workingSpace?): CoordMeta & {
    id: string;
    index: number;
    space: Space;
}
Parameters
- ref: Ref
- OptionalworkingSpace: string | Space
Returns CoordMeta & {
    id: string;
    index: number;
    space: Space;
}
Throws
If no space or an unknown space is provided
Inherited from Space.resolveCoord
- Defined in ColorSpace.d.ts:115

Class RGBColorSpace

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns RGBColorSpace

Properties

Optionalaliases

base

bases

coords

OptionaldisplaySpaces

formats

gamutSpace

id

OptionallinearGamut

M

name

Optionalreferred

OptionalrgbGamut

white

StaticDEFAULT_FORMAT

Staticregistry

Accessors

cssId

Returns string

isPolar

Returns boolean

isUnbounded

Returns boolean

Staticall

Returns Space[]

Methods

equals

Parameters

Returns boolean

from

Parameters

Returns Coords

Parameters

Returns Coords

fromBase

Parameters

Returns Vector3

getFormat

Parameters

Returns Format

getMinCoords

Returns Coords

inGamut

Parameters

Optionalepsilon?: number

Returns boolean

to

Parameters

Returns Coords

Parameters

Returns Coords

toBase

Parameters

Returns Vector3

toString

Returns string

StaticfindFormat

Parameters

Returns Format

Staticget

Parameters

Returns Space

Throws

Staticregister

Parameters

Returns Space

Throws

Parameters

`Optional`aliases

`Optional`displaySpaces

`Optional`linearGamut

`Optional`referred

`Optional`rgbGamut

`Static`DEFAULT_FORMAT

`Static`registry

`Static`all

`Optional`epsilon?: number

`Static`findFormat

`Static`get

`Static`register

`Static`resolveCoord

Returns CoordMeta & {
id: string;
index: number;
space: Space;
}