@skchr/color
    Preparing search index...

    Type Alias StatsOptions

    Optional parameters to specify how the data should be computed.

    type StatsOptions = {
        against?: ColorToken;
        colorspace?: Colorspaces;
        relative?: boolean;
    }
    Index

    Properties

    against? colorspace? relative?

    Properties

    against?: ColorToken

    The color to compare the factor with. All the factors are calculated between this color and the ones in the colors array. Only works for the 'distance' and 'contrast' factor.

    colorspace?: Colorspaces

    The colorspace to perform the sorting operation in. It is ignored when the factor is 'luminance' | 'contrast' | 'distance'.

    relative?: boolean

    Choose whether to use the against color token for factors that support it as an overload (that is, all factors except distance and `contrast)

    Settings

    Member Visibility

    On This Page

    Properties