Class Space

constructor

• new Space(options): Space

• Parameters

  • options: SpaceOptions

  Returns Space

Optional aliases

base

coords

formats

Optional fromBase

gamutSpace

id

name

Optional referred

Optional toBase

white

Static DEFAULT_FORMAT

Static registry

cssId

• get cssId(): string

• The ID used by CSS, such as display-p3 or --cam16-jmh

  Returns string

isPolar

• get isPolar(): boolean

• Returns boolean

isUnbounded

• get isUnbounded(): boolean

• Returns boolean

Static all

• get all(): Space[]

• Returns Space[]

equals

• equals(space): boolean

• Parameters

  • space: string | Space

  Returns boolean

from

• from(color): Coords

• Parameters

  • color: ColorTypes

  Returns Coords

• from(space, coords): Coords

• Parameters

  • space: string | Space
  • coords: Coords

  Returns Coords

getFormat

• getFormat(format?): default

• Parameters

  • Optional format: string | SpaceFormat | default

  Returns default

getMinCoords

• getMinCoords(): Coords

• Returns Coords

inGamut

• inGamut(coords, options?): boolean

• Parameters

  • coords: Coords
  • Optional options: {
        epsilon?: number;
    }

    • Optional epsilon?: number

  Returns boolean

to

• to(color): Coords

• Parameters

  • color: ColorTypes

  Returns Coords

• to(space, coords): Coords

• Parameters

  • space: string | Space
  • coords: Coords

  Returns Coords

toString

• toString(): string

• Returns string

Static findFormat

• findFormat(filters, spaces?): default

• Parameters

  • filters: string | object
  • Optional spaces: Space[]

  Returns default

Static get

• get(space, ...alternatives): Space

• Parameters

  • space: string | Space
  • Rest ...alternatives: (string | Space)[]

  Returns Space

  Throws

  If no matching color space is found

Static register

• register(space): Space

• Parameters

  • space: Space

  Returns Space

  Throws

  If a space with the provided id already exists

• register(id, space): Space

• Parameters

  • id: string
  • space: Space

  Returns Space

Static resolveCoord

• resolveCoord(ref, workingSpace?): CoordMeta & {
      id: string;
      index: number;
      space: Space;
  }

• Parameters

  • ref: Ref
  • Optional workingSpace: string | Space

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

  Throws

  If no space or an unknown space is provided