Interface CubehelixColorFactory

A color factory object for Dave Green's Cubehelix colors, which may also be used with instanceof to test if an object is a Cubehelix color instance.

interface CubehelixColorFactory {
    [metadata]: DecoratorMetadataObject;
    arguments: any;
    caller: Function;
    length: number;
    name: string;
    prototype: CubehelixColor;
    [hasInstance](value): boolean;
    apply(this, thisArg, argArray?): any;
    bind(this, thisArg, ...argArray): any;
    call(this, thisArg, ...argArray): any;
    toString(): string;
    (h, s, l, opacity?): CubehelixColor;
    (cssColorSpecifier): CubehelixColor;
    (color): CubehelixColor;
}

Hierarchy

  • CubehelixColorFactory(h, s, l, opacity?): CubehelixColor

  • Constructs a new Cubehelix color based on the specified channel values and opacity.

    Parameters

    • h: number

      Hue channel value.

    • s: number

      Saturation channel value.

    • l: number

      Lightness channel value.

    • Optional opacity: number

      Optional opacity value, defaults to 1.

    Returns CubehelixColor

  • CubehelixColorFactory(cssColorSpecifier): CubehelixColor

  • Parses the specified CSS Color Module Level 3 specifier string, returning an Cubehelix color. If the specifier was not valid, null is returned.

    Parameters

    • cssColorSpecifier: string

      A CSS Color Module Level 3 specifier string.

    Returns CubehelixColor

  • CubehelixColorFactory(color): CubehelixColor

  • Converts the provided color instance and returns a Cubehelix color. The color instance is specified, it is converted to the RGB color space using color.rgb and then converted to Cubehelix. (Colors already in the Cubehelix color space skip the conversion to RGB.)

    Parameters

    Returns CubehelixColor

Methods

[hasInstance] apply bind call toString

Properties

[metadata] arguments caller length name prototype

Methods

[hasInstance]

  • [hasInstance](value): boolean

  • Determines whether the given value inherits from this function if this function was used as a constructor function.

    A constructor function can control which objects are recognized as its instances by 'instanceof' by overriding this method.

    Parameters

    • value: any

    Returns boolean

apply

  • apply(this, thisArg, argArray?): any

  • Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.

    Parameters

    • this: Function
    • thisArg: any

      The object to be used as the this object.

    • Optional argArray: any

      A set of arguments to be passed to the function.

    Returns any

bind

  • bind(this, thisArg, ...argArray): any

  • For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.

    Parameters

    • this: Function
    • thisArg: any

      An object to which the this keyword can refer inside the new function.

    • Rest ...argArray: any[]

      A list of arguments to be passed to the new function.

    Returns any

call

  • call(this, thisArg, ...argArray): any

  • Calls a method of an object, substituting another object for the current object.

    Parameters

    • this: Function
    • thisArg: any

      The object to be used as the current object.

    • Rest ...argArray: any[]

      A list of arguments to be passed to the method.

    Returns any

toString

  • toString(): string

  • Returns a string representation of a function.

    Returns string

Properties

[metadata]

[metadata]: DecoratorMetadataObject

arguments

arguments: any

caller

caller: Function

Readonly length

length: number

Readonly name

name: string

Returns the name of the function. Function names are read-only and can not be changed.

Readonly prototype

prototype: CubehelixColor

Prototype of the factory, which can be used for instanceof testing

Settings

Member Visibility

Theme

On This Page