Class Space

Class for color spaces. Each color space corresponds to a ColorSpace instance

Hierarchy (view full)

Space
- RGBColorSpace

Index

Constructors

Properties

aliases? base coords formats fromBase? gamutSpace id name referred? toBase? white DEFAULT_FORMAT registry

Accessors

cssId isPolar isUnbounded all

Methods

equals from getFormat getMinCoords inGamut to toString findFormat get register resolveCoord

Constructors

constructor

new Space(options): Space
Parameters
- options: SpaceOptions
Returns Space
- Defined in ColorSpace.d.ts:89

Properties

`Optional`aliases

aliases?: string[]

base

base: Space

coords

coords: Record<string, CoordMeta>

formats

formats: Record<string, SpaceFormat>

`Optional`fromBase

fromBase?: ((coords: Coords) => Coords)

gamutSpace

gamutSpace: Space

id

id: string

name

name: string

`Optional`referred

referred?: string

`Optional`toBase

toBase?: ((coords: Coords) => Coords)

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
- Defined in ColorSpace.d.ts:123

isPolar

get isPolar(): boolean
Returns boolean
- Defined in ColorSpace.d.ts:124

isUnbounded

get isUnbounded(): boolean
Returns boolean
- Defined in ColorSpace.d.ts:125

`Static`all

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

Methods

equals

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

from

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

getFormat

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

getMinCoords

getMinCoords(): Coords
Returns Coords
- Defined in ColorSpace.d.ts:144

inGamut

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

to

to(color): Coords
Parameters
- color: ColorTypes
Returns Coords
- Defined in ColorSpace.d.ts:148
to(space, coords): Coords
Parameters
- space: string | Space
- coords: Coords
Returns Coords
- Defined in ColorSpace.d.ts:149

toString

toString(): string
Returns string
- Defined in ColorSpace.d.ts:151

`Static`findFormat

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

`Static`get

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

`Static`register

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

`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
- Defined in ColorSpace.d.ts:101