Interface SpaceFormat

interface SpaceFormat {
    [instance]?: default;
    alpha?: boolean;
    commas?: boolean;
    coordGrammar?: (string & {
        range?: [number, number];
    })[];
    coords?: string[];
    id?: string;
    ids?: string[];
    name?: string;
    parse?: ((str) => ColorConstructor);
    serialize?: ((coords, alpha, opts?) => string);
    serializeCoords?: ((coords, precision) => [string, string, string]);
    space?: Space;
    test?: ((str) => 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]?: default

Optional alpha

alpha?: boolean

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

Optional commas

commas?: boolean

Whether commas should separate arguments for a format

Optional coordGrammar

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

Optional coords

coords?: string[]

Optional id

id?: string

Optional ids

ids?: string[]

Optional name

name?: string

Default

"color"

Optional parse

parse?: ((str) => ColorConstructor)

Function to parse a string into a color

Type declaration

Optional serialize

serialize?: ((coords, alpha, opts?) => string)

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

Type declaration

    • (coords, alpha, opts?): string

    • Parameters

      • coords: Coords
      • alpha: number
      • Optional opts: Record<string, any>

      Returns string

Optional serializeCoords

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

Type declaration

    • (coords, precision): [string, string, string]

    • Parameters

      • coords: Coords
      • precision: number

      Returns [string, string, string]

Optional space

space?: Space

Optional test

test?: ((str) => boolean)

Type declaration

    • (str): boolean

    • Parameters

      • str: string

      Returns boolean

Optional toGamut

toGamut?: boolean

Whether to adjust the coordinates to fit in the gamut

Optional type

type?: string

Default

"function"

Settings

Member Visibility

Theme

On This Page

[instance]alphacommascoordGrammarcoordsididsnameparseserializeserializeCoordsspacetesttoGamuttype