color-util
Color format conversion, gradient colors, etc
Easy color format conversion with
colorutil.color
Basic color format conversion methods
Mass color format conversion with colorutil.convert
Clone a color
hue
hueFromColor
Gradient options
Gradient color data structures+ [Data structure 1](#data-structure-1)
+ [Data structure 2](#data-structure-2)
+ [Data structure 3](#data-structure-3)
+ [Data structure 4](#data-structure-4)Installation & import
```javascript $ npm install color-util --save ``` ```javascript var colorutil = require('color-util'); ``` or ``` ```Color format conversion
Easy color format conversion with colorutil.color
colorutil.color takes any type of color and provide getters for each type. It calculates the color only when getter is called and stores that color so it's not calculated next time. (colorutil.color does not support 32-bit integers: intabgr, intrgba)
```javascript
let color = colorutil.color(0xff0000);
color.int // 16711680
color.hex // "#ff0000"
color.rgb // {r: 255, g: 0, b: 0, a: 255}
color.cssrgb // "rgb(255,0,0)"
color.cssrgba // "rgba(255,0,0,1)"
color.hsl // {h: 0, s: 1, l: 0.5, a: 1}
color.csshsl // "hsl(0,100%,50%)"
color.csshsla // "hsla(0,100%,50%,1)"
color.hsv // {h: 0, s: 1, v: 1, a: 1}
```
Basic color format conversion methods
These are pure conversion functions without any intelligence. If you have massive amount of colors and you need to convert them fast then these are the ones you want to use. You have to know the source type of a color and a color needs to be in valid format. There are three main type of color formats (rgb, hsl, hsv). In addition those there are 8 sub types (csshsl, csshsla, cssrgb, cssrgba, hex, int, intrgba, intabgr). These basic conversions can convert between the main types and between the main type and it's sub type. So e.g. converting from hex to hsl requires two steps (hex to rgb, rgb to hsl). If speed is not your concern then incolorutil.color would be a cleaner solution.
The following list shows all the available basic conversions
```javascript
// rgb
colorutil.rgb.to.int({r: 0, g: 0, b: 255, a:255}) // 255
colorutil.rgb.to.hex({r: 0, g: 0, b: 255, a:255}) // "#0000ff"
colorutil.rgb.to.cssrgb({r: 0, g: 0, b: 255, a:255}) // "rgb(0,0,255)"
colorutil.rgb.to.cssrgba({r: 0, g: 0, b: 255, a:255}) // "rgba(0,0,255,1)"
colorutil.rgb.to.hsl({r: 0, g: 0, b: 255, a:255}) // {h: 0.6666666666666666, s: 1, l: 0.5, a: 1}
colorutil.rgb.to.hsv({r: 0, g: 0, b: 255, a:255}) // {h: 0.6666666666666666, s: 1, v: 1, a: 1}
colorutil.rgb.to.uintabgr({r: 0, g: 0, b: 255, a:0x7f}) // 2147418112
colorutil.rgb.to.uintabgrOpaque({r: 0, g: 0, b: 255, a:0x7f}) // 4294901760
colorutil.rgb.to.intabgr({r: 0, g: 0, b: 255, a:0x7f}) // 2147418112
colorutil.rgb.to.intabgrOpaque({r: 0, g: 0, b: 255, a:0x7f}) // -65536
colorutil.rgb.to.uintrgba({r: 0, g: 0, b: 255, a:0x7f}) // 65407
colorutil.rgb.to.intrgba({r: 0, g: 0, b: 255, a:0x7f}) // 65407
// hsl
colorutil.hsl.to.rgb({h: 4/6, s: 1, l: 0.5, a: 1}) // {r: 0, g: 0, b: 255, a: 255}
colorutil.hsl.to.hsv({h: 4/6, s: 1, l: 0.5, a: 1}) // {h: 0.6666666666666666, s: 1, v: 1, a: 1}
colorutil.hsl.to.csshsl({h: 4/6, s: 1, l: 0.5, a: 1}) // "hsl(240,100%,50%)"
colorutil.hsl.to.csshsla({h: 4/6, s: 1, l: 0.5, a: 1}) // "hsla(240,100%,50%,1)"
// hsv
colorutil.hsv.to.rgb({h: 4/6, s: 1, v: 1, a: 1}) // {r: 0, g: 0, b: 255, a: 255}
colorutil.hsv.to.hsl({h: 4/6, s: 1, v: 1, a: 1}) // {h: 0.6666666666666666, s: 1, l: 0.5, a: 1}
// hex (sub type of rgb)
colorutil.hex.to.rgb("#0000ff") // {r: 0, g: 0, b: 255, a: 255}
colorutil.hex.to.rgb("#0000ff", 0x7f) // {r: 0, g: 0, b: 255, a: 127}
colorutil.hex.to.int("#0000ff") // 255
colorutil.hex.to.cssrgb("#0000ff") // "rgb(0,0,255)"
colorutil.hex.to.cssrgba("#0000ff") // "rgba(0,0,255,1)"
colorutil.hex.to.cssrgba("#0000ff", 0x7f) // "rgba(0,0,255,127)"
// int (sub type of rgb)
colorutil.int.to.rgb(0x0000ff) // {r: 0, g: 0, b: 255, a: 255}
colorutil.int.to.rgb(0x0000ff, 0x7f) // {r: 0, g: 0, b: 255, a: 127}
colorutil.int.to.hex(0x0000ff) // "#0000ff"
colorutil.int.to.cssrgb(0x0000ff) // "rgb(0,0,255)"
colorutil.int.to.cssrgba(0x0000ff) // "rgba(0,0,255,1)"
colorutil.int.to.cssrgba(0x0000ff, 0x7f) // "rgba(0,0,255,127)"
// intabgr (sub type of rgb)
colorutil.intrgba.to.rgb(65407) // {r: 0, g: 0, b: 255, a: 127}
// intabgr (subtype of rgb)
colorutil.intabgr.to.rgb(2147418112) // {a: 127, b: 255, g: 0, r: 0}
// cssrgb (subtype of rgb)
colorutil.cssrgb.to.rgb("rgb(0, 0, 255)") // {r: 0, g: 0, b: 255, a: 255}
colorutil.cssrgb.to.rgb("rgb(0, 0, 255)", 0x7f) // {r: 0, g: 0, b: 255, a: 127}
colorutil.cssrgb.to.int("rgb(0, 0, 255)") // 255
colorutil.cssrgb.to.hex("rgb(0, 0, 255)") // "#0000ff"
// cssrgba (subtype of rgb)
colorutil.cssrgba.to.rgb("rgb(0, 0, 255, 0.5)") // {r: 0, g: 0, b: 255, a: 127}
colorutil.cssrgba.to.int("rgb(0, 0, 255, 0.5)") // 255
colorutil.cssrgba.to.hex("rgb(0, 0, 255, 0.5)") // "#0000ff"
// csshsl (subtype of hsl)
colorutil.csshsl.to.hsl("hsl(240, 100%, 50%)") // {h: 0.6666666666666666, s: 1, l: 0.5, a: 1}
colorutil.csshsl.to.hsl("hsl(240, 100%, 50%)", 0.5) // {h: 0.6666666666666666, s: 1, l: 0.5, a: 0.5}
// csshsla (subtype of hsl)
colorutil.csshsla.to.hsl("hsl(240, 100%, 50%, 0.5)") // {h: 0.6666666666666666, s: 1, l: 0.5, a: 0.5}
```
Mass color format conversion with colorutil.convert
When you have a lot of colors that need to be converted then you can use convert function together with the basic conversion functions.
```javascript
let colors = 0xff0000, 0xb2ff00, 0x00ff99, 0x0011ff;
colorutil.convert(colors, colorutil.int.to.rgb) // {r: 255, g: 0, b: 0, a: 255},...
```
Multidimensional arrays are fine as well. Returned array structure is retained.
```javascript
let colors = 0xff0000, 0xb2ff00, 0x00ff99, 0x0011ff;
colorutil.convert(colors, colorutil.int.to.rgb) // {r: 255, g: 0, b: 0, a: 255},...,...
```
Multiple conversion are also supported. Since a color cannot be directly converted e.g. from int to hsv, first convert from int to rgb then from rgb to hsv.
```javascript
let colors = 0xff0000, 0xb2ff00, 0x00ff99, 0x0011ff;
colorutil.convert(colors,
colorutil.int.to.rgb,colorutil.rgb.to.hsv) // [{h: 0, s: 1, v: 1, a: 1},...]colorutil.any is a useful way to do mass conversion for any type of colors, though it is not too fast (colorutil.any does not support 32-bit integers: intabgr, intrgba)
```javascript
let colors =
{h: 1/6, s: 1, v: 1, a: 1},{r: 0, g: 0, b: 255, a: 255},0xb2ff00,"hsl(200, 100%, 50%)"colorutil.color
colorutil.color function creates an immutable Color object which offers getters for each color type and some other usefull features.
| Function | Return value | Description
| --- | --- | ---
| clone() | Color | Creates a clone of a color.
| hue() | Color | Create new color which is the hue color of this color. Returned value is cached.
| hueFromColor(color) | Color | Create clone of this color where hue is shifted to same as with the color in argument.
The first call to a getter will cache the returned value so the following calls will be retrieved from cache.
| Getter | Return value example
| --- | ---
| int | 16711680
| hex | "#ff0000"
| rgb | {r: 255, g: 0, b: 0, a: 255}
| cssrgb | "rgb(255,0,0)"
| cssrgba | "rgba(255,0,0,1)"
| hsl | {h: 0, s: 1, l: 0.5, a: 1}
| csshsl | "hsl(0,100%,50%)"
| csshsla | "hsla(0,100%,50%,1)"
| hsv | {h: 0, s: 1, v: 1, a: 1}
Clone a color
```javascript let color1 = colorutil.color(0xff0000); let color2 = color1.clone(); // also creates a clone let color3 = colorutil.color(color1); ```hue
```javascript colorutil.color("#00aa00").hue().hex // "#00ff00" ```hueFromColor
```javascript let color = colorutil.color("#00aa00"); color.hueFromColor(0x660033).hex // "#aa0055" ```Color component value ranges of object types
| Color component | Value range | --- | --- | rgb.r | \[0,0xff\] or \[0,255\] | rgb.g | 0,0xff or 0,255 | rgb.b | 0,0xff or 0,255 | rgb.a | 0,0xff or 0,255 | hsv.h | 0,1 | hsv.s | 0,1 | hsv.v | 0,1 | hsv.a | 0,1 | hsl.h | 0,1 | hsl.s | 0,1 | hsl.l | 0,1 | hsl.a | 0,1Gradients
Gradients are mainly targeted for retrieving a color from a gradient while the gradient itself may be drawn with other means for example with css. color-util gradient drawing performance on canvas isn't that fast compared to native canvas gradients and css gradients thus these are not suitable for animation or rendering large areas. Alternatives css gradient examples for color picker Examples gradient matrix circular gradient matrix In the example below, if each pixel in 100 x 100 pixel area would be drawn, the result would look like this.
```javascript
// There are couple of different ways to present colors. In this
// example a two dimensional RGB color array is used to create a
// gradient where each corner has of a square has different color value.
let colors =
[{r: 255},{r: 255, g: 255}],[{b: 255},{g: 255, b: 255}]colors: colors,width: 100,height: 100Gradient options
Gradient is created withgradient function. There is a gradient function available for each main color type colorutil.rgb.gradient, colorutil.hsv.gradient and colorutil.hsl.gradient. Gradient's width and height specify the size of the gradient in pixels, rest of the numerical properties are in normalized range 0 to 1.
| | | Default | Description
| --- | --- | --- | ---
| colors | Array | | Array of colors. There are multiple types of data structures. Data structure defines whether the gradient is one or two dimensional.
| type | string | linear | Gradient type. Possible values: linear circular
| defaultColor | Object | {r:0,g:0,b:0,a:255}, {h:0,s:0,l:0,a:1}, {h:0,s:0,v:0,a:1} | Default color used to fill the missing color components in gradient colors. Default color depends on gradient's color type.
| width | number | 100 | Width of the gradient in pixels.
| height | number | 100 | Height of the gradient in pixels.
| centerX | number | 0 | Center position of a gradient. Value 0 is the left edge of the gradient and 1 is the right edge. centerX can be used with linear type of gradients to set point of rotation. This has no effect on circular gradients since the center is always at the center of the circle.
| centerY | number | 0 | Center position of a gradient. Value 0 is the top edge of the gradient and 1 is the bottom edge. centerY can be used with linear type of gradients to set point of rotation. This has no effect on circular gradients since the center is always at the center of the circle.
| scale | number | 1 | Scale of the gradient on both x and y-axises. Value 1 is normal size and 2 is double size.
| scaleX | number | 1 | Scale of the gradient on x-axis.
| scaleY | number | 1 | Scale of the gradient on y-axis.
| translateX | number | 0 | Translate gradient along x-axis. Value 0.5 is half the gradient width, value 1 is gradient width etc.
| translateY | number | 0 | Translate gradient along y-axis. Value 0.5 is half the gradient height, value 1 is gradient height etc.
| centralize | number | false | Automatically adjusts the center and translation to centralize gradient. Translation will translate relative to the center point.
| rotation | number | 0 | Rotation of the gradient. Value in range 0 to 1 where 0.25 is 90 degrees and 0.5 is 180 degrees. Gradient is rotated around the center point and can be adjusted with centerX and centerY.
| repeatX | function | colorutil.repeat.repeat | X repetition of gradient when calculating a color that is out of normal range 0 to 1.
| repeatY | function | colorutil.repeat.repeat | Y repetition of gradient when calculating a color that is out of normal range 0 to 1.
Gradient color data structures
There are couple of supported data structures. You may choose the one you like.gradient function converts the data internally to structure 1 or structure 2.
In the examples below RGB colors are used, but the same structures are supported by HSV and HSL gradients. RGB colors consist of four components (r, g, b, a). If any of the component is missing from color object, default value is used. Default values can be changed with colorutil.rgb.gradient function's defaultColor property.
x and y properties within color object are color stops; they indicate the position of a color within a gradient. x and y properties are also optional. If they are missing colorutil.rgb.gradient will generate them. You may leave some or all of the stops unspecified in which case the colors are distributed evenly. Value of x and y properties range from 0 to 1.
Data structure 1
One dimensional gradient from red to green. ```javascript{x:0, r: 255},{x:1: g: 255}Data structure 2
Two dimensional structure where top is gradient from red to green, bottom is gradient from blue to transparent. ```javascript{y: 0,colors: [{x:0, r: 255},{x:1, g: 255}]},{y: 1,colors: [{x:0, b: 255},{x:1, a: 0}]}Data structure 3
Two dimensional structure. This example produces exact same gradient as structure 2 above. With this structure it is not possible to specify y-stops. Colors are distributed evenly on the y-axis. ```javascript[{x:0, r: 255},{x:1, g: 255}],[{x:0, b: 255},{x:1, a: 0}]Data structure 4
Two dimensional structure. This example produces exact same gradient as structure 2 above. Notice that this structure is similar to structure 1, but the difference is that this is two-dimensional. This data structure is identified as two-dimensional if it has at least one y property specified within the structure, otherwise it is understood as one dimensional. ```javascript{x:0, y:0, r: 255},{x:1, y:0, g: 255},{x:0, y:1, b: 255},{x:1, y:1, a: 0}Change history
- 2.2.2
* remove benchmarks from this project- 2.2.0
* GradientData can be used as a data source for gradient functions.* Added `colorutil.rgb.draw`, `colorutil.hsl.draw`, `colorutil.hsv.draw` to draw the cradient on canvas.- 2.1.0
* Added gradient data conversion functions available: `colorutil.rgb.gradientData`, `colorutil.hsl.gradientData`, `colorutil.hsv.gradientData`* `addDefaultColors` removed from gradient functions. Those are always added.- 2.0.0
* Gradients are accessed with `gradient` method of a color type.* Gradient color stops* Gradient data validation* Multiple types of gradient data structures allowed* HSL & HSV gradients* Gradient scaling, translate and centralize* Default gradient color* `colorutil.color` added to help with conversions* Renaming of properties functions and classes.* Removed for-of loops to get rid of the need for polyfills on IE11.* Basically nothing is backward compatible with version 1.0.0. Probably no-one is using version 1, but if you do, I feel your pain.- 1.0.0
* No code changes to previous version. I just like creating new releases.- 0.6.0
* hueColors -> getHueColors() & return value changed from array of numbers to array of rgb objects.* shorten function names: getGradientColor -> gradientColor, getMatrixColor -> matrixColor, convertTo2StopGradient -> twoStopGradient* No interface changes after this release.* hue shortcut method for getting hue color* more strict test functions for Rgb, Hsv and Hsl* toUint32BigEndian and toInt32BigEndian renamed to toUint32b and toInt32b* ColorUtil.int32.toRgb and ColorUtil.int32b.toRgb added* twoStopGradient changed to private* circleGradientColor and circleMatrixColor functions added* gradient rotation* convert function bug fix.- 0.5.0
* benchmarks and some optimizations added* `getGradientColor` and `getGradientMatrixColor` conversion arguments removed -> input and output is now only rgb object notation.* Removed endianness check from `toUint32` and `toInt32` conversion functions -> endianness check should be done manually if required.* Split `toUint32` and `toInt32` to `toUint32`, `toUint32Opaque`, `toUint32BigEndian`, `toInt32`, `toInt32Opaque`, `toInt32BigEndian`.* Default alpha values removed when converting from rgb to rgb sub-type.* `getGradientMatrixColor` renamed to `getMatrixColor`* `getSystemEndian` function changed to `endian` property* change `toRgbString` and `toHslString` to `toRgbString`, `toRgbaString`, `toHslString` and `toHslaString`* add any.toHslString, any.toHslaString- 0.4.0
* ColorUtil.any conversion functions.* Hue range changed to 0-1.* Convert function can convert single color.* RgbString spaces allowed.* HslString conversion functions.* RgbString regexp fixed.* Rounding removed when converting to Rgb object.- 0.3.0
* Rgb -> Hsv -> Rgb* fix rgb.toHsl conversion negative hue value- 0.2.0
* Rgb -> Hsl -> Rgb* backward compatibility broken (e.g. ColorUtil.obj -> ColorUtil.rgb)- 0.1.2
* Rgb color conversion functions, gradient and gradient matrix