dojox/color/Palette.js

• Provides:

  • dojox.color.Palette

• Requires:

  • dojox.color in common

• dojox.color.Palette.generators

  • type

    Object

• dojox.color.Palette.generators.analogous

  • parameters:
    • args: (typeof dojox.color.Palette.__analogousArgs)
  • summary

    Create a 5 color palette based on the analogous rules as implemented at
    http://kuler.adobe.com.

  • type

    Function

• dojox.color.Palette.generators.monochromatic

  • parameters:
    • args: (typeof dojox.color.Palette.__generatorArgs)
  • summary

    Create a 5 color palette based on the monochromatic rules as implemented at
    http://kuler.adobe.com.

  • type

    Function

• dojox.color.Palette.generators.triadic

  • parameters:
    • args: (typeof dojox.color.Palette.__generatorArgs)
  • summary

    Create a 5 color palette based on the triadic rules as implemented at
    http://kuler.adobe.com.

  • type

    Function

• dojox.color.Palette.generators.complementary

  • parameters:
    • args: (typeof dojox.color.Palette.__generatorArgs)
  • summary

    Create a 5 color palette based on the complementary rules as implemented at
    http://kuler.adobe.com.

  • type

    Function

• dojox.color.Palette.generators.splitComplementary

  • parameters:
    • args: (typeof dojox.color.Palette.__splitComplementaryArgs)
  • summary

    Create a 5 color palette based on the split complementary rules as implemented at
    http://kuler.adobe.com.

  • type

    Function

• dojox.color.Palette.generators.compound

  • parameters:
    • args: (typeof dojox.color.Palette.__generatorArgs)
  • summary

    Create a 5 color palette based on the compound rules as implemented at
    http://kuler.adobe.com.

  • type

    Function

• dojox.color.Palette.generators.shades

  • parameters:
    • args: (typeof dojox.color.Palette.__generatorArgs)
  • summary

    Create a 5 color palette based on the shades rules as implemented at
    http://kuler.adobe.com.

  • type

    Function

• dojox.color.Palette.generate

  • parameters:
    • base: (typeof String|dojox.color.Color)
    • type: (typeof Function|String)
  • returns

    dojox.color.Palette

  • summary

    Generate a new Palette using any of the named functions in
    dojox.color.Palette.generators or an optional function definition.  Current
    generators include "analogous", "monochromatic", "triadic", "complementary",
    "splitComplementary", and "shades".

  • type

    Function

• dojox.color.Palette

  • type

    Function

  • parameters:
    • base: (typeof String|Array|dojox.color.Color|dojox.color.Palette)
  • summary

    An object that represents a palette of colors.

  • description

    A Palette is a representation of a set of colors.  While the standard
    number of colors contained in a palette is 5, it can really handle any
    number of colors.
    
    A palette is useful for the ability to transform all the colors in it
    using a simple object-based approach.  In addition, you can generate
    palettes using dojox.color.Palette.generate; these generated palettes
    are based on the palette generators at http://kuler.adobe.com.

• dojox.color.Palette.transform

  • parameters:
    • kwArgs: (typeof dojox.color.Palette.__transformArgs)
  • returns

    dojox.color.Palette

  • summary

    Transform the palette using a specific transformation function
    and a set of transformation parameters.

  • description

    {palette}.transform is a simple way to uniformly transform
    all of the colors in a palette using any of 5 formulae:
    RGBA, HSL, HSV, CMYK or CMY.
    
    Once the forumula to be used is determined, you can pass any
    number of parameters based on the formula "d"[param]; for instance,
    { use: "rgba", dr: 20, dg: -50 } will take all of the colors in
    palette, add 20 to the R value and subtract 50 from the G value.
    
    Unlike other types of transformations, transform does *not* alter
    the original palette but will instead return a new one.

  • type

    Function

• dojox.color.Palette.clone

  • returns

    dojox.color.Palette

  • summary

    Clones the current palette.

  • type

    Function

• dojox.color

  • alias - dojox.color

• dojox.color.Palette.colors

  • type

    dojox.color.Color[]

  • summary

    The actual color references in this palette.

• dojox.color.Palette.__transformArgs

  • parameters:
    • use: (typeof String)

      Specify the color model to use for the transformation.  Can be "rgb", "rgba", "hsv", "hsl", "cmy", "cmyk".

    • dr: (typeof Number)

      The delta to be applied to the red aspect of the RGB/RGBA color model.

    • dg: (typeof Number)

      The delta to be applied to the green aspect of the RGB/RGBA color model.

    • db: (typeof Number)

      The delta to be applied to the blue aspect of the RGB/RGBA color model.

    • da: (typeof Number)

      The delta to be applied to the alpha aspect of the RGBA color model.

    • dc: (typeof Number)

      The delta to be applied to the cyan aspect of the CMY/CMYK color model.

    • dm: (typeof Number)

      The delta to be applied to the magenta aspect of the CMY/CMYK color model.

    • dy: (typeof Number)

      The delta to be applied to the yellow aspect of the CMY/CMYK color model.

    • dk: (typeof Number)

      The delta to be applied to the black aspect of the CMYK color model.

    • dh: (typeof Number)

      The delta to be applied to the hue aspect of the HSL/HSV color model.

    • ds: (typeof Number)

      The delta to be applied to the saturation aspect of the HSL/HSV color model.

    • dv: (typeof Number)

      The delta to be applied to the value aspect of the HSV color model.

    • dl: (typeof Number)

      The delta to be applied to the luminosity aspect of the HSL color model.

  • summary

    The keywords argument to be passed to the dojox.color.Palette.transform function.  Note that
    while all arguments are optional, *some* arguments must be passed.  The basic concept is that
    you pass a delta value for a specific aspect of a color model (or multiple aspects of the same
    color model); for instance, if you wish to transform a palette based on the HSV color model,
    you would pass one of "dh", "ds", or "dv" as a value.

  • type

    Function

• dojox.color.Palette.__transformArgs.use

  • optional
  • type

    String

  • summary

    Specify the color model to use for the transformation.  Can be "rgb", "rgba", "hsv", "hsl", "cmy", "cmyk".

• dojox.color.Palette.__transformArgs.dr

  • optional
  • type

    Number

  • summary

    The delta to be applied to the red aspect of the RGB/RGBA color model.

• dojox.color.Palette.__transformArgs.dg

  • optional
  • type

    Number

  • summary

    The delta to be applied to the green aspect of the RGB/RGBA color model.

• dojox.color.Palette.__transformArgs.db

  • optional
  • type

    Number

  • summary

    The delta to be applied to the blue aspect of the RGB/RGBA color model.

• dojox.color.Palette.__transformArgs.da

  • optional
  • type

    Number

  • summary

    The delta to be applied to the alpha aspect of the RGBA color model.

• dojox.color.Palette.__transformArgs.dc

  • optional
  • type

    Number

  • summary

    The delta to be applied to the cyan aspect of the CMY/CMYK color model.

• dojox.color.Palette.__transformArgs.dm

  • optional
  • type

    Number

  • summary

    The delta to be applied to the magenta aspect of the CMY/CMYK color model.

• dojox.color.Palette.__transformArgs.dy

  • optional
  • type

    Number

  • summary

    The delta to be applied to the yellow aspect of the CMY/CMYK color model.

• dojox.color.Palette.__transformArgs.dk

  • optional
  • type

    Number

  • summary

    The delta to be applied to the black aspect of the CMYK color model.

• dojox.color.Palette.__transformArgs.dh

  • optional
  • type

    Number

  • summary

    The delta to be applied to the hue aspect of the HSL/HSV color model.

• dojox.color.Palette.__transformArgs.ds

  • optional
  • type

    Number

  • summary

    The delta to be applied to the saturation aspect of the HSL/HSV color model.

• dojox.color.Palette.__transformArgs.dl

  • optional
  • type

    Number

  • summary

    The delta to be applied to the luminosity aspect of the HSL color model.

• dojox.color.Palette.__transformArgs.dv

  • optional
  • type

    Number

  • summary

    The delta to be applied to the value aspect of the HSV color model.

• dojox.color.Palette.__generatorArgs

  • parameters:
    • base: (typeof dojo.Color)

      The base color to be used to generate the palette.

  • summary

    The keyword arguments object used to create a palette based on a base color.

  • type

    Function

• dojox.color.Palette.__generatorArgs.base

  • type

    dojo.Color

  • summary

    The base color to be used to generate the palette.

• dojox.color.Palette.__analogousArgs

  • parameters:
    • base: (typeof dojo.Color)

      The base color to be used to generate the palette.

    • high: (typeof Number)

      The difference between the hue of the base color and the highest hue.  In degrees, default is 60.

    • low: (typeof Number)

      The difference between the hue of the base color and the lowest hue.  In degrees, default is 18.

  • summary

    The keyword arguments object that is used to create a 5 color palette based on the
    analogous rules as implemented at http://kuler.adobe.com, using the HSV color model.

  • type

    Function

• dojox.color.Palette.__analogousArgs.base

  • type

    dojo.Color

  • summary

    The base color to be used to generate the palette.

• dojox.color.Palette.__analogousArgs.high

  • optional
  • type

    Number

  • summary

    The difference between the hue of the base color and the highest hue.  In degrees, default is 60.

• dojox.color.Palette.__analogousArgs.low

  • optional
  • type

    Number

  • summary

    The difference between the hue of the base color and the lowest hue.  In degrees, default is 18.

• dojox.color.Palette.__splitComplementaryArgs

  • parameters:
    • base: (typeof dojo.Color)

      The base color to be used to generate the palette.

    • da: (typeof Number)

      The delta angle to be used to determine where the split for the complementary rules happen.
      In degrees, the default is 30.

  • summary

    The keyword arguments object used to create a palette based on the split complementary rules
    as implemented at http://kuler.adobe.com.

  • type

    Function

• dojox.color.Palette.__splitComplementaryArgs.base

  • type

    dojo.Color

  • summary

    The base color to be used to generate the palette.

• dojox.color.Palette.__splitComplementaryArgs.da

  • optional
  • type

    Number

  • summary

    The delta angle to be used to determine where the split for the complementary rules happen.
    In degrees, the default is 30.

• dojox

  • type

    Object