Interface SpaceFormat

interface SpaceFormat {
    [instance]?: Format;
    alpha?: boolean;
    commas?: boolean;
    coordGrammar?: (string & {
        range?: [number, number];
    })[];
    coords?: string[];
    id?: string;
    ids?: string[];
    name?: string;
    parse?: ((str: string) => ColorConstructor);
    serialize?: ((coords: Coords, alpha: number, opts?: Record<string, any>) => string);
    serializeCoords?: ((coords: Coords, precision: number) => [string, string, string]);
    space?: Space;
    test?: ((str: string) => boolean);
    toGamut?: boolean;
    type?: string;
}

Properties

[instance]? alpha? commas? coordGrammar? coords? id? ids? name? parse? serialize? serializeCoords? space? test? toGamut? type?

Properties

Optional[instance]

[instance]?: Format

Optionalalpha

alpha?: boolean

Whether to always have alpha at the end (true), never (false), or auto (undefined)

Optionalcommas

commas?: boolean

Whether commas should separate arguments for a format

OptionalcoordGrammar

coordGrammar?: (string & {
    range?: [number, number];
})[]

Optionalcoords

coords?: string[]

Optionalid

id?: string

Optionalids

ids?: string[]

Optionalname

name?: string

Default

"color"

Optionalparse

parse?: ((str: string) => ColorConstructor)

Function to parse a string into a color

Optionalserialize

serialize?: ((coords: Coords, alpha: number, opts?: Record<string, any>) => string)

Serialize coordinates and an alpha channel into a string. Must be defined for a format to support serialization

OptionalserializeCoords

serializeCoords?: ((coords: Coords, precision: number) => [string, string, string])

Optionalspace

space?: Space

Optionaltest

test?: ((str: string) => boolean)

OptionaltoGamut

toGamut?: boolean

Whether to adjust the coordinates to fit in the gamut

Optionaltype

type?: string

Default

"function"

Settings

Member Visibility

On This Page

Properties