Class Space

constructor

• new Space(options): Space

• Parameters

  • options: SpaceOptions

  Returns Space

aliases

base

coords

formats

fromBase

gamutSpace

id

name

referred

toBase

white

StaticDEFAULT_FORMAT

Staticregistry

cssId

• get cssId(): string

• Returns string

isPolar

• get isPolar(): boolean

• Returns boolean

isUnbounded

• get isUnbounded(): boolean

• Returns boolean

Staticall

• get all(): Space[]

• Returns Space[]

equals

• equals(space): boolean

• Check if this color space is the same as another color space reference. Allows proxying color space objects and comparing color spaces with ids.

  Parameters

  • space: string | Space

    ColorSpace object or id to compare to

  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

• Lookup a format in this color space

  Parameters

  • format: string | Format | FormatObject

    Format id if string. If object, it's converted to a Format object and returned.

  Returns Format

getMinCoords

• getMinCoords(): Coords

• Returns Coords

inGamut

• inGamut(coords, __namedParameters?): boolean

• Parameters

  • coords: Coords
  • __namedParameters: {
        epsilon: number;
    } = {}

    • 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

StaticfindFormat

• findFormat(filters, spaces?): Format

• Look up all color spaces for a format that matches certain criteria

  Parameters

  • filters: any
  • Optionalspaces: Space[] = ColorSpace.all

  Returns Format

Staticget

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

• Lookup ColorSpace object by name

  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

  Throws

  If a space with the provided id already exists

StaticresolveCoord

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

• Get metadata about a coordinate of a color 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