Interface SpaceOptions

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

Hierarchy (view full)

Properties

aliases? base? coords? cssId? displaySpaces? formats? fromBase? gamutSpace? id linearGamut? M? name referred? rgbGamut? toBase? white? ε?

Properties

Optionalaliases

aliases?: string[]

Optionalbase

base?: string | Space

The base color space

Optionalcoords

coords?: Record<string, CoordMeta>

Object mapping coord ids to coord metadata

See

CoordMeta

OptionalcssId

cssId?: string

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

OptionaldisplaySpaces

displaySpaces?: (string | Space)[]

Spaces to try if not natively supported, if different from base chain.

Optionalformats

formats?: Record<string, SpaceFormat>

Details about string formats to parse from / serialize to

See

Format

OptionalfromBase

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

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

OptionalgamutSpace

gamutSpace?: string | Space

id

id: string

Id of this space, used in things such as conversions

OptionallinearGamut

linearGamut?: RGBColorSpace

OptionalM

M?: Record<string, Matrix3x3>

Matrices relevant to this color space, keyed by a descriptive name. Exposed on the resulting space as ColorSpace.M so that consumer code can reuse them instead of duplicating the data.

name

name: string

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

Optionalreferred

referred?: string

OptionalrgbGamut

rgbGamut?: RGBColorSpace

OptionaltoBase

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

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

Optionalwhite

white?: string | White

Optionalε

ε?: number

Settings

Member Visibility

On This Page

Properties