interface Color<T extends ColorParam = ColorParam> {
    a(): number;
    a(val: number): Color<ColorParam>;
    alpha(): number;
    alpha(val: number): Color<ColorParam>;
    ansi16(...args: number[]): Color<ColorParam>;
    ansi256(...args: number[]): Color<ColorParam>;
    apple(...args: number[]): Color<ColorParam>;
    array(): number[];
    b(): number;
    b(val: number): Color<ColorParam>;
    black(): number;
    black(val: number): Color<ColorParam>;
    blacken(ratio: number): Color<ColorParam>;
    blue(): number;
    blue(val: number): Color<ColorParam>;
    chroma(): number;
    chroma(val: number): Color<ColorParam>;
    cmyk(...args: number[]): Color<ColorParam>;
    contrast(color2: Color<ColorParam>): number;
    cyan(): number;
    cyan(val: number): Color<ColorParam>;
    darken(ratio: number): Color<ColorParam>;
    desaturate(ratio: number): Color<ColorParam>;
    fade(ratio: number): Color<ColorParam>;
    gray(): number;
    gray(val: number): Color<ColorParam>;
    grayscale(): Color<ColorParam>;
    green(): number;
    green(val: number): Color<ColorParam>;
    hcg(...args: number[]): Color<ColorParam>;
    hex(): string;
    hex<V extends string>(val: V): Color<V>;
    hexa(): string;
    hexa<V extends string>(val: V): Color<V>;
    hsl(...args: number[]): Color<ColorParam>;
    hsv(...args: number[]): Color<ColorParam>;
    hue(): number;
    hue(val: number): Color<ColorParam>;
    hwb(...args: number[]): Color<ColorParam>;
    isDark(): boolean;
    isLight(): boolean;
    keyword(): string;
    keyword<V extends string>(val: V): Color<V>;
    l(): number;
    l(val: number): Color<ColorParam>;
    lab(...args: number[]): Color<ColorParam>;
    lch(...args: number[]): Color<ColorParam>;
    level(color2: Color<ColorParam>): "" | "AAA" | "AA";
    lighten(ratio: number): Color<ColorParam>;
    lightness(): number;
    lightness(val: number): Color<ColorParam>;
    luminosity(): number;
    magenta(): number;
    magenta(val: number): Color<ColorParam>;
    mix(mixinColor: Color<ColorParam>, weight?: number): Color<ColorParam>;
    negate(): Color<ColorParam>;
    object(): { alpha?: number } & { [key: string]: number };
    opaquer(ratio: number): Color<ColorParam>;
    percentString(places?: number): string;
    red(): number;
    red(val: number): Color<ColorParam>;
    rgb(...args: number[]): Color<ColorParam>;
    rgbNumber(): number;
    rotate(degrees: number): Color<ColorParam>;
    round(places?: number): Color<ColorParam>;
    saturate(ratio: number): Color<ColorParam>;
    saturationl(): number;
    saturationl(val: number): Color<ColorParam>;
    saturationv(): number;
    saturationv(val: number): Color<ColorParam>;
    string(places?: number): string;
    toJSON(): Color<T>;
    toString(): string;
    unitArray(): number[];
    unitObject(): { alpha?: number; b: number; g: number; r: number };
    value(): number;
    value(val: number): Color<ColorParam>;
    wblack(): number;
    wblack(val: number): Color<ColorParam>;
    white(): number;
    white(val: number): Color<ColorParam>;
    whiten(ratio: number): Color<ColorParam>;
    x(): number;
    x(val: number): Color<ColorParam>;
    xyz(...args: number[]): Color<ColorParam>;
    y(): number;
    y(val: number): Color<ColorParam>;
    yellow(): number;
    yellow(val: number): Color<ColorParam>;
    z(): number;
    z(val: number): Color<ColorParam>;
}

Type Parameters

  • T extends ColorParam = ColorParam

Methods

  • Returns number

  • Parameters

    • val: number

    Returns Color<ColorParam>

  • Returns number

  • Parameters

    • val: number

    Returns Color<ColorParam>

  • Parameters

    • ...args: number[]

    Returns Color<ColorParam>

  • Parameters

    • ...args: number[]

    Returns Color<ColorParam>

  • Parameters

    • ...args: number[]

    Returns Color<ColorParam>

  • Returns number[]

  • Returns number

  • Parameters

    • val: number

    Returns Color<ColorParam>

  • Returns number

  • Parameters

    • val: number

    Returns Color<ColorParam>

  • Parameters

    • ratio: number

    Returns Color<ColorParam>

  • Returns number

  • Parameters

    • val: number

    Returns Color<ColorParam>

  • Returns number

  • Parameters

    • val: number

    Returns Color<ColorParam>

  • Parameters

    • ...args: number[]

    Returns Color<ColorParam>

  • Parameters

    • color2: Color<ColorParam>

    Returns number

  • Returns number

  • Parameters

    • val: number

    Returns Color<ColorParam>

  • Parameters

    • ratio: number

    Returns Color<ColorParam>

  • Parameters

    • ratio: number

    Returns Color<ColorParam>

  • Parameters

    • ratio: number

    Returns Color<ColorParam>

  • Returns number

  • Parameters

    • val: number

    Returns Color<ColorParam>

  • Returns Color<ColorParam>

  • Returns number

  • Parameters

    • val: number

    Returns Color<ColorParam>

  • Parameters

    • ...args: number[]

    Returns Color<ColorParam>

  • Returns string

  • Type Parameters

    • V extends string

    Parameters

    • val: V

    Returns Color<V>

  • Returns string

  • Type Parameters

    • V extends string

    Parameters

    • val: V

    Returns Color<V>

  • Parameters

    • ...args: number[]

    Returns Color<ColorParam>

  • Parameters

    • ...args: number[]

    Returns Color<ColorParam>

  • Returns number

  • Parameters

    • val: number

    Returns Color<ColorParam>

  • Parameters

    • ...args: number[]

    Returns Color<ColorParam>

  • Returns boolean

  • Returns boolean

  • Returns string

  • Type Parameters

    • V extends string

    Parameters

    • val: V

    Returns Color<V>

  • Returns number

  • Parameters

    • val: number

    Returns Color<ColorParam>

  • Parameters

    • ...args: number[]

    Returns Color<ColorParam>

  • Parameters

    • ...args: number[]

    Returns Color<ColorParam>

  • Parameters

    • color2: Color<ColorParam>

    Returns "" | "AAA" | "AA"

  • Parameters

    • ratio: number

    Returns Color<ColorParam>

  • Returns number

  • Parameters

    • val: number

    Returns Color<ColorParam>

  • Returns number

  • Returns number

  • Parameters

    • val: number

    Returns Color<ColorParam>

  • Parameters

    • mixinColor: Color<ColorParam>
    • Optionalweight: number

    Returns Color<ColorParam>

  • Returns Color<ColorParam>

  • Returns { alpha?: number } & { [key: string]: number }

  • Parameters

    • ratio: number

    Returns Color<ColorParam>

  • Parameters

    • Optionalplaces: number

    Returns string

  • Returns number

  • Parameters

    • val: number

    Returns Color<ColorParam>

  • Parameters

    • ...args: number[]

    Returns Color<ColorParam>

  • Returns number

  • Parameters

    • degrees: number

    Returns Color<ColorParam>

  • Parameters

    • Optionalplaces: number

    Returns Color<ColorParam>

  • Parameters

    • ratio: number

    Returns Color<ColorParam>

  • Returns number

  • Parameters

    • val: number

    Returns Color<ColorParam>

  • Returns number

  • Parameters

    • val: number

    Returns Color<ColorParam>

  • Parameters

    • Optionalplaces: number

    Returns string

  • Returns Color<T>

  • Returns string

  • Returns number[]

  • Returns { alpha?: number; b: number; g: number; r: number }

  • Returns number

  • Parameters

    • val: number

    Returns Color<ColorParam>

  • Returns number

  • Parameters

    • val: number

    Returns Color<ColorParam>

  • Returns number

  • Parameters

    • val: number

    Returns Color<ColorParam>

  • Parameters

    • ratio: number

    Returns Color<ColorParam>

  • Returns number

  • Parameters

    • val: number

    Returns Color<ColorParam>

  • Parameters

    • ...args: number[]

    Returns Color<ColorParam>

  • Returns number

  • Parameters

    • val: number

    Returns Color<ColorParam>

  • Returns number

  • Parameters

    • val: number

    Returns Color<ColorParam>

  • Returns number

  • Parameters

    • val: number

    Returns Color<ColorParam>