Interface SpaceOptions

interface SpaceOptions {
    aliases?: string[];
    base?: string | Space;
    coords?: Record<string, CoordMeta>;
    cssId?: string;
    formats?: Record<string, SpaceFormat>;
    fromBase?: ((coords) => number[]);
    gamutSpace?: string | Space;
    id: string;
    name: string;
    referred?: string;
    toBase?: ((coords) => number[]);
    white?: string | White;
}

Hierarchy (view full)

Properties

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

Properties

Optional aliases

aliases?: string[]

Optional base

base?: string | Space

The base color space

Optional coords

coords?: Record<string, CoordMeta>

Object mapping coord ids to coord metadata

See

CoordMeta

Optional cssId

cssId?: string

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

Optional formats

formats?: Record<string, SpaceFormat>

Details about string formats to parse from / serialize to

See

Format

Optional fromBase

fromBase?: ((coords) => number[])

Function that converts coords in the base color space to coords in this color space. Must perform chromatic adaptation if needed

Type declaration

    • (coords): number[]

    • Parameters

      Returns number[]

Optional gamutSpace

gamutSpace?: string | Space

id

id: string

Id of this space, used in things such as conversions

name

name: string

The readable name of the space, used in user-facing UI

Optional referred

referred?: string

Optional toBase

toBase?: ((coords) => number[])

Function that converts coords in this color space to coords in the base color space. Must perform chromatic adaptation if needed

Type declaration

    • (coords): number[]

    • Parameters

      Returns number[]

Optional white

white?: string | White

Settings

Member Visibility

Theme

On This Page

aliasesbasecoordscssIdformatsfromBasegamutSpaceidnamereferredtoBasewhite