Class Space

constructor

• new Space(options): Space

• Parameters

  • options: SpaceOptions

  Returns Space

Optionalaliases

base

bases

coords

OptionaldisplaySpaces

formats

OptionalfromBase

gamutSpace

id

OptionallinearGamut

name

Optionalreferred

OptionalrgbGamut

OptionaltoBase

white

StaticDEFAULT_FORMAT

Staticregistry

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

Staticall

• 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?): Format

• Parameters

  • Optionalformat: string | SpaceFormat | Format

  Returns Format

getMinCoords

• getMinCoords(): Coords

• Returns Coords

inGamut

• inGamut(coords, options?): boolean

• Parameters

  • coords: Coords
  • Optionaloptions: {
        epsilon?: number;
    }

    • Optionalepsilon?: 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

StaticfindFormat

• findFormat(filters, spaces?): Format

• Parameters

  • filters: string | object
  • Optionalspaces: Space[]

  Returns Format

Staticget

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

• Parameters

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

  Returns Space

  Throws

  If no matching color space is found

Staticregister

• 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

StaticresolveCoord

• 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