chroma.js
\nchroma.js is a small-ish zero-dependency JavaScript library (13.5kB) for all kinds of color conversions and color scales.
\n![\"Build](\"https://api.travis-ci.com/gka/chroma.js.svg?branch=master\")
Quick-start
\nHere are a couple of things chroma.js can do for you:
\n- \n
- read colors from a wide range of formats \n
- analyze and manipulate colors \n
- convert colors into wide range of formats \n
- linear and bezier interpolation in different color spaces \n
Here's an example for a simple read / manipulate / output chain:
\nchroma('pink').darken().saturate(2).hex()\nAside from that, chroma.js can also help you generate nice colors using various methods, for instance to be used in color palette for maps or data visualization.
\nchroma.scale(['#fafa6e', '#2A4858'])\n .mode('lch').colors(6)\nchroma.js has a lot more to offer, but that's the gist of it.
\nInstallation
\nFor Node.js: Install the chroma-js npm module using your favorite package manager:
npm install chroma-js\n# pnpm add chroma-js\n# yarn add chroma-js\nThen import the module into your JavaScript:
\nimport chroma from 'chroma-js';\nIf you just want to use parts of chroma.js and not bundle the entire package, you can import directly from chroma-js/src/* to benefit from treeshaking. For instance, the following import would only result in a 1.24kB bundle increase:
import deltaE from 'chroma-js/src/utils/deltaE.js\nAnd for browsers, download chroma.min.js or use the hosted version on unpkg.com.
You can also just import chroma.js as ES module, as demonstrated in this StackBlitz.
\nTo use chroma.js in Observable notebooks, you can import it like this:
\nimport { chroma } from "@gka/chroma-js"\nThe interactive documentation continues below (and there's a static version, too) for usage examples. Or use it from SASS using chromatic-sass!
\nAPI
\nchroma
\n(color)
\nThe first step is to get your color into chroma.js. That's what the generic constructor chroma() does. This function attempts to guess the format of the input color for you. For instance, it will recognize any named color from the W3CX11 specification:
chroma('hotpink')\nIf there's no matching named color, chroma.js checks for a hexadecimal string. It ignores case, the # sign is optional, and it can recognize the shorter three letter format as well. So, any of these are valid hexadecimal representations: #ff3399, FF3399, #f39, etc.
chroma('#ff3399');\nchroma('F39');\nIn addition to hex strings, hexadecimal numbers (in fact, just any number between 0 and 16777215) will be recognized, too.
chroma(0xff3399)\nYou also can pass RGB values individually. Each parameter must be within 0..255. You can pass the numbers as individual arguments or as an array.
chroma(0xff, 0x33, 0x99);\nchroma(255, 51, 153);\nchroma([255, 51, 153]);\nYou can construct colors from different color spaces by passing the name of color space as the last argument. Here we define the same color in HSL by passing the hue angle (0-360) and percentages for saturation and l*ightness:
\nchroma(330, 1, 0.6, 'hsl')\nNew (since 2.0): you can also construct colors by passing an plain JS object with attributes corresponding to a color space supported by chroma.js:
\nchroma({ h:120, s:1, l:0.75});\nchroma({ l:80, c:25, h:200 });\nchroma({ c:1, m:0.5, y:0, k:0.2});\nchroma.valid
\nAlso new: you can use chroma.valid to try if a color argument can be correctly parsed as color by chroma.js:
chroma.valid('red');\nchroma.valid('bread');\nchroma.valid('#F0000D');\nchroma.valid('#FOOOOD');\nchroma.hsl
\n(hue, saturation, lightness)
\nAlternatively, every color space has its own constructor function under the chroma namespace. For a list of all supported color spaces, check the appendix.
chroma.hsl(330, 1, 0.6)\nchroma.hsv
\n(hue, saturation, value)
\nchroma.lab
\n(Lightness, a, b)
\nCIE Lab color space. To calculate the lightness value of a color, the CIE Lab color space uses a reference white point. This reference white point defines what is considered to be "white" in the color space. By default chroma.js is using the D65 reference point.
\nchroma.lab(40, -20, 50);\nchroma.lab(50, -20, 50);\nchroma.lab(80, -20, 50);\nchroma.setLabWhitePoint
\n(whitePoint)
\nSets the current CIE Lab white reference point.
\nPossible values:
\n| \n | \n |
|---|---|
D50 | \nRepresents the color temperature of daylight at 5000K. | \n
D55 | \nRepresents mid-morning or mid-afternoon daylight at 5500K. | \n
D65 | \nRepresents average daylight at 6500K. | \n
A | \nRepresents the color temperature of a typical incandescent light bulb at approximately 2856K. | \n
B | \nRepresents noon daylight with a color temperature of approximately 4874K. | \n
C | \nRepresents average or north sky daylight; it's a theoretical construct, not often used in practical applications. | \n
F2 | \nRepresents cool white fluorescent light. | \n
F7 | \nThis is a broad-band fluorescent light source with a color temperature of approximately 6500K. | \n
F11 | \nThis is a narrow tri-band fluorescent light source with a color temperature of approximately 4000K. | \n
E | \nRepresents an equal energy white point, where all wavelengths in the visible spectrum are equally represented. | \n
chroma('hotpink').lab();\nchroma.setLabWhitePoint('F2');\nchroma('hotpink').lab();\nchroma.getLabWhitePoint
\nReturns the name of the currently set CIE Lab white reference point.
\nchroma.getLabWhitePoint();\nchroma.lch
\n(Lightness, chroma, hue)
\nThe range for lightness and chroma depend on the hue, but go roughly from 0..100-150. The range for hue is 0..360.
chroma.lch(80, 40, 130);\nchroma(80, 40, 130, 'lch');\nchroma.hcl
\n(hue, chroma, lightness)
\nYou can use hcl instead of Lch. Lightness and hue channels are switched to be more consistent with HSL.
\nchroma.hcl(130, 40, 80);\nchroma(130, 40, 80, 'hcl');\nchroma.oklab
\n(Lightness, a, b)
\n\nchroma.oklab(0.4,-0.2,0.5);\nchroma.oklab(0.5,-0.2,0.5);\nchroma.oklab(0.8,-0.2,0.5);\nchroma.oklch
\n(Lightness, chromacity, hue)
\nchroma.oklch(0.5, 0.2, 240);\nchroma(0.8, 0.12, 60, 'oklch');\nchroma.cmyk
\n(cyan, magenta, yellow, black)
\nEach between 0 and 1.
\nchroma.cmyk(0.2, 0.8, 0, 0);\nchroma(0.2, 0.8, 0, 0, 'cmyk');\nchroma.gl
\n(red, green, blue, [alpha])
\nGL is a variant of RGB(A), with the only difference that the components are normalized to the range of 0..1.
chroma.gl(0.6, 0, 0.8);\nchroma.gl(0.6, 0, 0.8, 0.5);\nchroma(0.6, 0, 0.8, 'gl');\nchroma.temperature
\n(K)
\nReturns a color from the color temperature scale. Based on Neil Bartlett's implementation.
\nchroma.temperature(2000); // candle light\nchroma.temperature(3500); // sunset\nchroma.temperature(6500); // daylight\nThe effective temperature range goes from 0 to about 30000 Kelvin,
f = function(i) {\n return chroma.temperature(i * 30000)\n}\nchroma.mix
\n(color1, color2, ratio=0.5, mode='lrgb')
\nMixes two colors. The mix ratio is a value between 0 and 1.
\nchroma.mix('red', 'blue');\nchroma.mix('red', 'blue', 0.25);\nchroma.mix('red', 'blue', 0.75);\nThe color mixing produces different results based the color space used for interpolation.
\nchroma.mix('red', 'blue', 0.5, 'rgb');\nchroma.mix('red', 'blue', 0.5, 'hsl');\nchroma.mix('red', 'blue', 0.5, 'lab');\nchroma.mix('red', 'blue', 0.5, 'lch');\nchroma.mix('red', 'blue', 0.5, 'lrgb');\nchroma.average
\n(colors, mode='lrgb', weights=[])
\nSimilar to chroma.mix, but accepts more than two colors. Simple averaging of R,G,B components and the alpha channel.
colors = ['#ddd', 'yellow', 'red', 'teal'];\nchroma.average(colors); // lrgb\nchroma.average(colors, 'rgb');\nchroma.average(colors, 'lab');\nchroma.average(colors, 'lch');\nAlso works with alpha channels.
\nchroma.average(['red', 'rgba(0,0,0,0.5)']).css();\nAs of version 2.1 you can also provide an array of weights to
compute a weighted average of colors.
colors = ['#ddd', 'yellow', 'red', 'teal'];\nchroma.average(colors, 'lch'); // unweighted\nchroma.average(colors, 'lch', [1,1,2,1]);\nchroma.average(colors, 'lch', [1.5,0.5,1,2.3]);\nchroma.blend
\n(color1, color2, mode)
\nBlends two colors using RGB channel-wise blend functions. Valid blend modes are multiply, darken, lighten, screen, overlay, burn, and dodge.
chroma.blend('4CBBFC', 'EEEE22', 'multiply');\nchroma.blend('4CBBFC', 'EEEE22', 'darken');\nchroma.blend('4CBBFC', 'EEEE22', 'lighten');\nchroma.random
\n(rng = Math.random)
\nCreates a random color by generating a random hexadecimal string. You can also pass a custom random number generator function as first argument.
\nchroma.random();\nchroma.random();\nchroma.random();\nchroma.contrast
\n(color1, color2)
\nComputes the WCAG contrast ratio between two colors. A minimum contrast of 4.5:1 is recommended to ensure that text is still readable against a background color.
\n// contrast smaller than 4.5 = too low\nchroma.contrast('pink', 'hotpink');\n// contrast greater than 4.5 = high enough\nchroma.contrast('pink', 'purple');\nchroma.contrastAPCA
\n(text, background)
\nNew (3.1): Computes the APCA contrast ratio of a text color against its background color. The basic idea is that you check the contrast between the text and background color and then use this lookup table to find the minimum font size you're allowed to use (given the font weight and purpose of the text).
\n![this lookup table](\"https://raw.githubusercontent.com/Myndex/apca-w3/master/images/APCAlookupByContrast.jpeg\"){kind=link}
chroma.contrastAPCA('hotpink', 'pink');\nchroma.contrastAPCA('purple', 'pink');\nRead more about how to interpret and use this metric at APCA Readability Criterion. Please note that the APCA algorithm is still in beta and may change be subject to changes in the future.
\nchroma.distance
\n(color1, color2, mode='lab')
\nComputes the Euclidean distance between two colors in a given color space (default is Lab).
chroma.distance('#fff', '#ff0', 'rgb');\nchroma.distance('#fff', '#f0f', 'rgb');\nchroma.distance('#fff', '#ff0');\nchroma.distance('#fff', '#f0f');\nchroma.deltaE
\n(color1, color2, Kl=1, Kc=1, Kh=1)
\nComputes color difference as developed by the International Commission on Illumination (CIE) in 2000. The implementation is based on the formula from Bruce Lindbloom. Resulting values range from 0 (no difference) to 100 (maximum difference), and are a metric for how the human eye percieves color difference. The optional parameters Kl, Kc, and Kh may be used to adjust weightings of lightness, chroma, and hue.
\nchroma.deltaE('#ededee', '#ededee');\nchroma.deltaE('#ededee', '#edeeed');\nchroma.deltaE('#ececee', '#eceeec');\nchroma.deltaE('#e9e9ee', '#e9eee9');\nchroma.deltaE('#e4e4ee', '#e4eee4');\nchroma.deltaE('#e0e0ee', '#e0eee0');\nchroma.deltaE('#000000', '#ffffff');\n\nchroma.brewer
\nchroma.brewer is an map of ColorBrewer palettes that are included in chroma.js for convenience. chroma.scale uses the colors to construct.
\nchroma.brewer.OrRd\nNote that chroma.js only includes the 9-step versions of the palettes (11 steps for the diverging palettes). So, for instance, if you use chroma.js to construct a 5-color palette, they will be different from the "official" 5-color palettes in ColorBrewer (which have lower contrast).
\nchroma.scale('RdBu').colors(5);\n// offical 5-color RdBu:\n['#ca0020', '#f4a582', '#f7f7f7', '#92c5de', '#0571b0']\nOne way to compensate for this would be to "slice off" the extreme colors:
\nchroma\n .scale(chroma.brewer.RdBu.slice(1,-1))\n .colors(5);\nOf course you can also just construct the scale from the official 5-step colors that you can copy and paste from colorbrewer2.org:
\nchroma.scale(['#ca0020', '#f4a582', '#f7f7f7', '#92c5de', '#0571b0'])\nYou can access a list of all available palettes via Object.keys(chroma.brewer):
Object.keys(chroma.brewer)\n// ['OrRd', 'PuBu', 'BuPu', 'Oranges', 'BuGn', 'YlOrBr', 'YlGn', 'Reds', 'RdPu', 'Greens', 'YlGnBu', 'Purples', 'GnBu', 'Greys', 'YlOrRd', 'PuRd', 'Blues', 'PuBuGn', 'Viridis', 'Spectral', 'RdYlGn', 'RdBu', 'PiYG', 'PRGn', 'RdYlBu', 'BrBG', 'RdGy', 'PuOr', 'Set2', 'Accent', 'Set1', 'Set3', 'Dark2', 'Paired', 'Pastel2', 'Pastel1']\nchroma.limits
\n(data, mode, n)
\nA helper function that computes class breaks for you, based on data. It supports the modes equidistant (e), quantile (q), logarithmic (l), and k-means (k). Let's take a few numbers as sample data.
\nvar data = [2.0,3.5,3.6,3.8,3.8,4.1,4.3,4.4,\n 4.6,4.9,5.2,5.3,5.4,5.7,5.8,5.9,\n 6.2,6.5,6.8,7.2,8];\nequidistant breaks are computed by dividing the total range of the data into _n_ groups of equal size.
\nchroma.limits(data, 'e', 4);\nIn the quantile mode, the input domain is divided by quantile ranges.
\nchroma.limits(data, 'q', 4);\nlogarithmic breaks are equidistant breaks but on a logarithmic scale.
\nchroma.limits(data, 'l', 4);\nk-means break is using the 1-dimensional k-means clustering algorithm to find (roughly) _n_ groups of "similar" values. Note that this k-means implementation does not guarantee to find exactly _n_ groups.
\nchroma.limits(data, 'k', 4);\ncolor
\ncolor.alpha
\n(a)
\nGet and set the color opacity using color.alpha.
chroma('red').alpha(0.5);\nchroma('rgba(255,0,0,0.35)').alpha();\ncolor.darken
\n(value=1)
\nOnce loaded, chroma.js can change colors. One way we already saw above, you can change the lightness.
\nchroma('hotpink').darken();\nchroma('hotpink').darken(2);\nchroma('hotpink').darken(2.6);\ncolor.brighten
\n(value=1)
\nSimilar to darken, but the opposite direction
chroma('hotpink').brighten();\nchroma('hotpink').brighten(2);\nchroma('hotpink').brighten(3);\ncolor.saturate
\n(value=1)
\nChanges the saturation of a color by manipulating the Lch chromaticity.
\nchroma('slategray').saturate();\nchroma('slategray').saturate(2);\nchroma('slategray').saturate(3);\ncolor.desaturate
\n(value=1)
\nSimilar to saturate, but the opposite direction.
chroma('hotpink').desaturate();\nchroma('hotpink').desaturate(2);\nchroma('hotpink').desaturate(3);\ncolor.mix
\n(targetcolor, ratio=0.5, mode='lrgb')
\nMix this color with a target color. The mix ratio is a value between 0 and 1. This is the same as chroma.mix but with the first parameter already set. As such, the color space used can be adjusted.
chroma('hotpink').mix('blue');\nchroma('hotpink').mix('blue', 0.25);\nchroma('hotpink').mix('blue', 0.75, 'lab');\ncolor.shade
\n(ratio=0.5, mode='lrgb')
\nProduce a shade of the color. This is syntactic sugar for color.mix with a target color of black.
chroma('hotpink').shade(0.25);\nchroma('hotpink').shade(0.5);\nchroma('hotpink').shade(0.75);\ncolor.tint
\n(ratio=0.5, mode='lrgb')
\nProduce a tint of the color. This is syntactic sugar for color.mix with a target color of white.
chroma('hotpink').tint(0.25);\nchroma('hotpink').tint(0.5);\nchroma('hotpink').tint(0.75);\ncolor.set
\n(channel, value)
\nChanges a single channel and returns the result a new chroma object.
// change hue to 0 deg (=red)\nchroma('skyblue').set('hsl.h', 0);\n// set chromaticity to 30\nchroma('hotpink').set('lch.c', 30);\nRelative changes work, too:
\n// half Lab lightness\nchroma('orangered').set('lab.l', '*0.5');\n// double Lch saturation\nchroma('darkseagreen').set('lch.c', '*2');\ncolor.get
\n(channel)
\nReturns a single channel value.
\nchroma('orangered').get('lab.l');\nchroma('orangered').get('hsl.l');\nchroma('orangered').get('rgb.g');\ncolor.luminance
\n([lum, mode='rgb'])
\nIf called without arguments color.luminance returns the relative brightness, according to the WCAG definition. Normalized to 0 for darkest black and 1 for lightest white.
chroma('white').luminance();\nchroma('aquamarine').luminance();\nchroma('hotpink').luminance();\nchroma('darkslateblue').luminance();\nchroma('black').luminance();\nchroma.js also allows you to adjust the luminance of a color. The source color will be interpolated with black or white until the correct luminance is found.
\n// set lumincance to 50% for all colors\nchroma('white').luminance(0.5);\nchroma('aquamarine').luminance(0.5);\nchroma('hotpink').luminance(0.5);\nchroma('darkslateblue').luminance(0.5);\nBy default, this interpolation is done in RGB, but you can interpolate in different color spaces by passing them as second argument:
\nchroma('aquamarine').luminance(0.5); // rgb\nchroma('aquamarine').luminance(0.5, 'lab');\nchroma('aquamarine').luminance(0.5, 'hsl');\ncolor.hex
\n(mode='auto|rgb|rgba|argb')
\nFinally, chroma.js allows you to output colors in various color spaces and formats. Most often you will want to output the color as hexadecimal string.
\nchroma('orange').hex()\nNote that as of version 1.4.0 the default mode is "auto" which means that the hex string will include the alpha channel if it's less than 1. If you don't want the alpha channel to be included you must explicitly set the mode to "rgb" now:
\nchroma('orange').hex();\nchroma('orange').alpha(0.5).hex();\nchroma('orange').alpha(0.5).hex('rgb');\nYou can use .hex('argb') in case you need to encode the color with the alpha channel as first byte rather than the last:
chroma('orange').hex('argb');; // '#ffffa500'\ncolor.name
\nReturns the named color. Falls back to hexadecimal RGB string, if the color isn't present.
\nchroma('#ffa500').name();\nchroma('#ffa505').name();\ncolor.css
\nReturns a CSS string representation that can be used as CSS-color definition.
\nchroma('teal').css();\nchroma('teal').alpha(0.5).css();\nBy default chroma is using the rgb() color space, but you can pass a color space name as first argument. Accepted color spaces are rgb, hsl, lab, lch, oklab, and oklch.
chroma('teal').css('hsl');\nchroma('teal').css('lab');\nchroma('teal').css('oklch');\ncolor.rgb
\n(round=true)
\nReturns an array with the red, green, and blue component, each as number within the range 0..255. Chroma internally stores RGB channels as floats but rounds the numbers before returning them. You can pass false to prevent the rounding.
chroma('orange').rgb();\nchroma('orange').darken().rgb();\nchroma('orange').darken().rgb(false);\ncolor.rgba
\n(round=true)
\nJust like color.rgb but adds the alpha channel to the returned array.
chroma('orange').rgba();\nchroma('hsla(20, 100%, 40%, 0.5)').rgba();\ncolor.hsl
\nReturns an array with the hue, saturation, and lightness component. Hue is the color angle in degree (0..360), saturation and lightness are within 0..1. Note that for hue-less colors (black, white, and grays), the hue component will be NaN.
chroma('orange').hsl();\nchroma('white').hsl();\ncolor.hsv
\nReturns an array with the hue, saturation, and value components. Hue is the color angle in degree (0..360), saturation and value are within 0..1. Note that for hue-less colors (black, white, and grays), the hue component will be NaN.
chroma('orange').hsv();\nchroma('white').hsv();\ncolor.hsi
\nReturns an array with the hue, saturation, and intensity components, each as number between 0 and 255. Note that for hue-less colors (black, white, and grays), the hue component will be NaN.
chroma('orange').hsi();\nchroma('white').hsi();\ncolor.lab
\nReturns an array with the L, a, and b components.
\nchroma('orange').lab()\ncolor.lch
\nReturns an array with the Lightness, chroma, and hue components.
\nchroma('skyblue').lch()\ncolor.hcl
\nAlias of lch, but with the components in reverse order.
\nchroma('skyblue').hcl()\ncolor.oklab
\nReturns an array with the L, a, and b components in the OKLab color space.
\nchroma('orange').oklab()\ncolor.oklch
\nReturns an array with the Lightness, chroma, and hue components in the OKLch color space.
\nchroma('skyblue').oklch()\ncolor.num
\nReturns the numeric representation of the hexadecimal RGB color.
\nchroma('#000000').num();\nchroma('#0000ff').num();\nchroma('#00ff00').num();\nchroma('#ff0000').num();\ncolor.temperature
\nEstimate the temperature in Kelvin of any given color, though this makes the only sense for colors from the temperature gradient above.
\nchroma('#ff3300').temperature();\nchroma('#ff8a13').temperature();\nchroma('#ffe3cd').temperature();\nchroma('#cbdbff').temperature();\nchroma('#b3ccff').temperature();\ncolor.gl
\nLike RGB, but in the channel range of [0..1] instead of [0..255]
chroma('33cc00').gl();\ncolor.clipped
\nWhen converting colors from CIELab color spaces to RGB the color channels get clipped to the range of [0..255]. Colors outside that range may exist in nature but are not displayable on RGB monitors (such as ultraviolet). you can use color.clipped to test if a color has been clipped or not.
[c = chroma.hcl(50, 40, 20), c.clipped()];\n[c = chroma.hcl(50, 40, 40), c.clipped()];\n[c = chroma.hcl(50, 40, 60), c.clipped()];\n[c = chroma.hcl(50, 40, 80), c.clipped()];\n[c = chroma.hcl(50, 40, 100), c.clipped()];\nAs a bonus feature you can access the unclipped RGB components using color._rgb._unclipped.
chroma.hcl(50, 40, 100).rgb();\nchroma.hcl(50, 40, 100)._rgb._unclipped;\ncolor scales
\nchroma.scale
\n(colors=['white', 'black'])
\nA color scale, created with chroma.scale, is a function that maps numeric values to a color palette. The default scale has the domain 0..1 and goes from white to black.
f = chroma.scale();\nf(0.25);\nf(0.5);\nf(0.75);\nYou can pass an array of colors to chroma.scale. Any color that can be read by chroma() will work here, too. If you pass more than two colors, they will be evenly distributed along the gradient.
chroma.scale(['yellow', '008ae5']);\nchroma.scale(['yellow', 'red', 'black']);\nscale.domain
\n(domain)
\nYou can change the input domain to match your specific use case. If called with no arguments, scale.domain returns the original array of positions along the scale where the color ramp was sampled.
// default domain is [0,1]\nchroma.scale(['yellow', '008ae5']);\n// set domain to [0,100]\nchroma.scale(['yellow', '008ae5']).domain([0,100]);\nYou can use the domain to set the exact positions of each color.
\n// default domain is [0,1]\nchroma.scale(['yellow', 'lightgreen', '008ae5'])\n .domain([0,0.25,1]);\nscale.mode
\n(mode)
\nAs with chroma.mix, the result of the color interpolation will depend on the color mode in which the channels are interpolated. The default mode is RGB:
chroma.scale(['yellow', '008ae5']);\nThis is often fine, but sometimes, two-color RGB gradients goes through kind of grayish colors, and Lab interpolation produces better results:
chroma.scale(['yellow', 'navy']);\nchroma.scale(['yellow', 'navy']).mode('lab');\nAlso note how the RGB interpolation can get very dark around the center. You can achieve better results using linear RGB interpolation:
\nchroma.scale(['#f00', '#0f0']);\nchroma.scale(['#f00', '#0f0']).mode('lrgb');\nOther useful interpolation modes could be HSL or Lch, though both tend to produce too saturated / glowing gradients.
chroma.scale(['yellow', 'navy']).mode('lab');\nchroma.scale(['yellow', 'navy']).mode('hsl');\nchroma.scale(['yellow', 'navy']).mode('lch');\nscale.gamma
\nGamma-correction can be used to "shift" a scale's center more the the beginning (gamma < 1) or end (gamma > 1), typically used to "even" the lightness gradient. Default is 1.
\nchroma.scale('YlGn').gamma(0.5);\nchroma.scale('YlGn').gamma(1);\nchroma.scale('YlGn').gamma(2);\nscale.correctLightness
\nThis makes sure the lightness range is spread evenly across a color scale. Especially useful when working with multi-hue color scales, where simple gamma correction can't help you very much.
\nchroma.scale(['black', 'red', 'yellow', 'white']);\n\nchroma.scale(['black', 'red', 'yellow', 'white'])\n .correctLightness();\nscale.cache
\n(true|false)
\nBy default chroma.scale instances will cache each computed value => color pair. You can turn off the cache by setting
chroma.scale(['yellow', '008ae5']).cache(false);\nscale.padding
\n(pad)
\nReduces the color range by cutting of a fraction of the gradient on both sides. If you pass a single number, the same padding will be applied to both ends.
\nchroma.scale('RdYlBu');\nchroma.scale('RdYlBu').padding(0.15);\nchroma.scale('RdYlBu').padding(0.3);\nchroma.scale('RdYlBu').padding(-0.15);\nAlternatively you can specify the padding for each sides individually by passing an array of two numbers.
\nchroma.scale('OrRd');\nchroma.scale('OrRd').padding([0.2, 0]);\nscale.colors
\n(num, format='hex')
\nYou can call scale.colors(n) to quickly grab n equi-distant colors from a color scale. If called with no arguments, scale.colors returns the original array of colors used to create the scale.
chroma.scale('OrRd').colors(5);\nchroma.scale(['white', 'black']).colors(12);\nIf you want to return chroma instances just pass null as format.
scale.classes
\n(numOrArray)
\nIf you want the scale function to return a distinct set of colors instead of a continuous gradient, you can use scale.classes. If you pass a number the scale will broken into equi-distant classes:
// continuous\nchroma.scale('OrRd');\n// class breaks\nchroma.scale('OrRd').classes(5);\nchroma.scale('OrRd').classes(8);\nYou can also define custom class breaks by passing them as array:
\nchroma.scale('OrRd').classes([0,0.3,0.55,0.85,1]);\nscale.nodata
\n(color)
\nWhen you pass a non-numeric value like null or undefined to a chroma.scale, "#cccccc" is returned as fallback or "no data" color. You can change the no-data color:
chroma.scale('OrRd')(null);\nchroma.scale('OrRd')(undefined);\nchroma.scale('OrRd').nodata('#eee')(null);\nchroma.brewer
\nchroma.js includes the definitions from ColorBrewer2.org. Read more about these colors in the corresponding paper by Mark Harrower and Cynthia A. Brewer.
\nchroma.scale('YlGnBu');\nchroma.scale('Spectral');\nTo reverse the colors you could simply reverse the domain:
\nchroma.scale('Spectral').domain([1,0]);\nYou can access the colors directly using chroma.brewer.
chroma.brewer.OrRd\nchroma.bezier
\n(colors)
\nchroma.bezier returns a function that bezier-interpolates between colors in Lab space. The input range of the function is [0..1].
// linear interpolation\nchroma.scale(['yellow', 'red', 'black']);\n// bezier interpolation\nchroma.bezier(['yellow', 'red', 'black']);\nYou can convert an bezier interpolator into a chroma.scale instance
\nchroma.bezier(['yellow', 'red', 'black'])\n .scale()\n .colors(5);\ncubehelix
\nchroma.cubehelix
\n(start=300, rotations=-1.5, hue=1, gamma=1, lightness=[0,1])
\nDave Green's cubehelix color scheme!!
\n// use the default helix...\nchroma.cubehelix();\n// or customize it\nchroma.cubehelix()\n .start(200)\n .rotations(-0.5)\n .gamma(0.8)\n .lightness([0.3, 0.8]);\ncubehelix.start
\n(hue)
\nstart color for hue rotation, default=300
![hue rotation](\"http://en.wikipedia.org/wiki/Hue#/media/File:HueScale.svg\"){kind=link}
chroma.cubehelix().start(300);\nchroma.cubehelix().start(200);\ncubehelix.rotations
\n(num)
\nnumber (and direction) of hue rotations (e.g. 1=360°, 1.5=540°`), default=-1.5
chroma.cubehelix().rotations(-1.5);\nchroma.cubehelix().rotations(0.5);\nchroma.cubehelix().rotations(3);\ncubehelix.hue
\n(numOrRange)
\nhue controls how saturated the colour of all hues are. either single value or range, default=1
\nchroma.cubehelix();\nchroma.cubehelix().hue(0.5);\nchroma.cubehelix().hue([1,0]);\ncubehelix.gamma
\n(factor)
\ngamma factor can be used to emphasise low or high intensity values, default=1
\nchroma.cubehelix().gamma(1);\nchroma.cubehelix().gamma(0.5);\ncubehelix.lightness
\n(range)
\nlightness range: default: [0,1] (black -> white)
\nchroma.cubehelix().lightness([0,1]);\nchroma.cubehelix().lightness([1,0]);\nchroma.cubehelix().lightness([0.3,0.7]);\ncubehelix.scale
\nYou can call cubehelix.scale() to use the cube-helix through the chroma.scale interface.
chroma.cubehelix()\n .start(200)\n .rotations(-0.35)\n .gamma(0.7)\n .lightness([0.3, 0.8])\n .scale() // convert to chroma.scale\n .correctLightness()\n .colors(5);\nChangelog
\n3.2.0
\n- \n
- scale.domain now returns the original domain array when called with no arguments \n
3.1.3
\n- \n
- updated dependencies \n
3.1.2
\n- \n
- fixed a bug in Lch interpolation of hue-less colors \n
3.1.1
\n- \n
- fix: allow deep-imports in vite projects \n
3.1.0
\n- \n
- feat: parse
'transparent'as black with 0% opacity - resolves #280 \n - make it easier to access colorbrewer palette names - resolves #314 \n
- docs: explain differences to official colorbrewer scales - resolves #316 \n
- fix: correct parsing of modern css colors with percentage alpha - resolves #297 \n
- fix: css output for hue-less colors in lch() and oklch() - resolves #357 \n
3.0.0
\n- \n
- 🎉 NEW: Add support for modern CSS color spaces. This means you can now export and parse CSS colors in
lab(),lch(),oklab(),oklch()space. \n - 🎉 NEW: you can now control the standard white reference point for the CIE Lab and CIE Lch color spaces via
setLabWhitePoint. \n - Breaking:
color.css()will no longer return legacy CSS colors likergb(255, 255, 0)but use modern CSS colors likergb(255 255 0)instead. \n - fix: you can now use chroma.js both via the default export as well as named exports in ES6. \n
- fix: switch to W3C implementation of OKLab color space \n
2.6.0
\n- \n
- 🎉 NEW: add
color.shade(),color.tint(). \n - fix: remove false w3c color cornflower \n
2.5.0
\n- \n
- refactored code base to ES6 modules \n
2.4.0
\n- \n
- add support for Oklab and Oklch color spaces \n
2.3.0
\n- \n
- use binom of degree n in chroma.bezier \n
2.2.0
\n- \n
- use Delta e2000 for chroma.deltaE #269 \n
2.0.3
\n- \n
- hsl2rgb will, like other x2rgb conversions now set the default alpha to 1 \n
2.0.2
\n- \n
- use a more mangle-safe check for Color class constructor to fix issues with uglifyjs and terser \n
2.0.1
\n- \n
- added
chroma.valid()for checking if a color can be parsed by chroma.js \n
2.0.0
\n- \n
- chroma.js has been ported from CoffeeScript to ES6! This means you can now import parts of chroma in your projects! \n
- changed HCG input space from [0..360,0..100,0..100] to [0..360,0..1,0..1] (to be in line with HSL) \n
- added new object unpacking (e.g.
hsl2rgb({h,s,l})) \n - changed default interpolation to
lrgbin mix/interpolate and average. \n - if colors can't be parsed correctly, chroma will now throw Errors instead of silently failing with console.errors \n
1.4.1
\n- \n
- chroma.scale() now interprets
nullas NaN and returns the fallback color. Before it had interpretednullas0\n - added
scale.nodata()to allow customizing the previously hard-coded fallback (aka "no data") color #cccccc \n
1.4.0
\n- \n
- color.hex() now automatically sets the mode to 'rgba' if the colors alpha channel is < 1. so
chroma('rgba(255,0,0,.5)').hex()will now return"#ff000080"instead of"#ff0000". if this is not what you want, you must explicitly set the mode torgbusing.hex("rgb"). \n - bugfix in chroma.average in LRGB mode (#187) \n
- chroma.scale now also works with just one color (#180) \n
1.3.5
\n- \n
- added LRGB interpolation \n
1.3.4
\n- \n
- passing null as mode in scale.colors will return chroma objects \n
1.3.3
\n- \n
- added color.clipped \n
- added chroma.distance \n
- added chroma.deltaE \n
- color.set now returns a new chroma instance \n
- chroma.scale now allows disabling of internal cache \n
- chroma.average now works with any color mode \n
- added unit tests for color conversions \n
- use hex colors as default string representation \n
- RGB channels are now stored as floats internally for higher precision \n
- bugfix with cubehelix and constant lightness \n
- bugfix in chroma.limits quantiles \n
- bugfix when running scale.colors(1) \n
- bugfix in hsi2rgb color conversion \n
1.2.2
\n- \n
- scale.colors() now returns the original colors instead of just min/max range \n
1.2.0
\n- \n
- added chroma.average for averaging colors \n
1.1.0
\n- \n
- refactored chroma.scale \n
- changed behaviour of scale.domain \n
- added scale.classes \n
- added scale.padding \n
1.0.2
\n- \n
- standardized alpha channel construction \n
- chroma.bezier automatically returns chroma.scale \n
1.0.1
\n- \n
- added simple color output to chroma.scale().colors() \n
1.0.0
\n- \n
- numeric interpolation does what it should \n
- refactored and modularized code base \n
- changed argument order of Color::interpolate \n