Asial Blog

Recruit! Asialで一緒に働きませんか?

色の処理に特化した軽量ライブラリ「Chroma.js」

カテゴリ :
フロントエンド(HTML5)
タグ :
JavaScript
こんにちは、古見澤(コミザワ)です。最近は寒いですね。
自宅に加湿器を導入して潤いが増した一方、結露が酷くて窓際や玄関がカビそうで困ってます。

さて今回は Chroma.js という色に関するJSライブラリに触れる機会があったのですが、日本語の記事が殆ど見つからなかったため、この紹介をしようと思います。

Chroma.js とは



色を補正したり、色空間の変換をしたり、カラースケールを設定して色を得る事ができる、色に関する振る舞いに特化した軽量(32.8 KB)なJSライブラリです。
多くの色空間に対応しており、CSSやJavaScriptで扱いやすい形で色情報を取得することができます。
ソースはgit上にあり、ライセンスは BSD license です。

Chroma.js

サンプル




下の例は色の補正機能を使い、X11カラーのpink(#ffc0cb)をベースに、明るさを下げ、彩度を上げ、出来上がった色を16進数で返しています。
  1. var myColor = chroma('').darken().saturate(2).hex();
  2. console.log(myColor); // ""
次の例は、テストの点数を表にしたときに背景色に使う色を取得するものです。
仮に60点を合格点として背景色を白とし、そこから0点に近づくほど濃い青色が、100点に近づくほど濃い赤色を返すサンプルです。
  1. var scores = [80, 98, 92, 75, 60, 74, 68, 90, 55, 76, 38], // テストの点数
  2.     scale = chroma.scale(['', '', '']).domain([0, 60, 100]);
  3.  
  4. scores.forEach(function(value){
  5.   var bgColor = scale(value);
  6.   // 取得した色を使って描画したり、プロパティに代入したり
  7.   
  8.   // ひとまず表示してみる
  9.   document.write('<span style="background-color:' + bgColor + '; padding:6px">' + value + '</span> ');
  10. });
実行結果:

導入



npmでインストールできます。
  1. npm install chroma-js
readmeには書いてありませんが、bowerにもありました。
  1. bower install chroma-js
あとは本体である chroma.min.js だけ直接ダウンロードしても大丈夫。

主な機能



以下に一部取り上げます、全ての情報はドキュメントを参照ください。見た目にも綺麗です。

コンストラクタ



  1. chroma('hotpink');              // X11カラーの名称には全て対応
  2. chroma('#ff3399');              // RRGGBBの6桁、3桁も対応。
  3. chroma('F39');                  // # はあっても無くてもよく、大文字小文字も区別しない
  4. chroma(0xff3399);               // 16進数でもOK
  5. chroma(255, 51, 153);           // RGBをそれぞれ1つずつ渡すのもOK
  6. chroma([255, 51, 153]);         // RGBを配列にして渡すのもOK
  7.  
  8. chroma(330, 1, 0.6, 'hsl');     // 最後の引数に明示的な色空間の指定が可能 省略時はRGB
  9. chroma.hsl(330, 1, 0.6);        // 色空間名のfunctionを通しても作成可能
  10.  
  11. chroma(80, 40, 130, 'lch');     // LCH
  12. chroma.lch(80, 40, 130);        // 同等
  13.  
  14. chroma(130, 40, 80, 'hcl');     // 上のLCHとはHとLの順序が逆なだけで、他は同じ
  15. chroma.hcl(130, 40, 80);        // 同等
  16.  
  17. chroma(0.2, 0.8, 0, 0, 'cmyk'); // CMYK
  18. chroma.cmyk(0.2, 0.8, 0, 0);    // 同等
  19.  
  20. chroma(0.6, 0, 0.8, 'gl');      // RGBとほぼ同じだが、引数の値の範囲が 0..1 となる
  21. chroma.gl(0.6, 0, 0.8);         // 同等
  22. chroma.gl(0.6, 0, 0.8, 0.5);    // また、オプションとして4番目の引数にアルファチャンネルを指定できる

色を混ぜる


  1. chroma.mix('', '');        //  赤に青を混ぜる
  2. chroma.mix('', '', 0.25);  //  3番目の引数で割合を指定可能、省略時は0.5。
  3.  
  4. // 混ぜあわせた結果は色空間によって変わる。4番目の引数で色空間を指定可能、省略時はrgb。
  5. chroma.mix('', '', 0.5, 'rgb'); //  
  6. chroma.mix('', '', 0.5, 'hsl'); //  
  7. chroma.mix('', '', 0.5, 'lab'); //  
  8. chroma.mix('', '', 0.5, 'lch'); //  
  9.  
  10. // blend functionという形で、いくつか最初から用意されているものもある。
  11. // 利用可能なのは multiply, darken, lighten, screen, overlay, burn, dogde の7つ。
  12. chroma.blend('', '', 'multiply'); //  乗算
  13. chroma.blend('', '', 'darken');   //  比較(暗)
  14. chroma.blend('', '', 'lighten');  //  比較(明)
  15. chroma.blend('', '', 'screen');   //  スクリーン
  16. chroma.blend('', '', 'overlay');  //  オーバーレイ
  17. chroma.blend('', '', 'burn');     //  焼き込み
  18. chroma.blend('', '', 'dogde');    //  覆い焼き

ランダムな色を作成する


  1. chroma.random();

明るさの上げ下げ


  1. chroma('').darken();    //  暗くする
  2. chroma('').darken(2);   //  暗くする、引数で調整可能。省略時は1。
  3. chroma('').brighten();  //  明るくする

彩度の上げ下げ


  1. chroma('').saturate();   //  彩度を上げる
  2. chroma('').saturate(2);  //  彩度を上げる、引数で調整可能、省略時は1
  3.  
  4. chroma('').desaturate();  //  彩度を下げる
  5. chroma('').desaturate(2); //  彩度を下げる、引数で調整可能、省略時は1
  6. chroma('').desaturate(3); //  同上

色情報の変更


  1. // 絶対指定の他、相対指定も可能
  2. chroma('').set('hsl.h', 0);         // HSLのHの値を0にする
  3. chroma('').set('lch.c', 30);        // LCHのCの値を30にする
  4. chroma('').set('lab.l', '*0.5');  // LABのLの値を半分にする
  5. chroma('').set('lch.c', '*2'); // LCHのCの値を2倍にする

情報の取得


  1. // 色の特定パラメータを取得する場合
  2. chroma('').get('lab.l'); // 57.582
  3. chroma('').get('hsl.l'); // 0.5
  4. chroma('').get('rgb.g'); // 69
  5.  
  6. // 16進数の文字列を取得
  7. chroma('').hex(); // "#ffa500"
  8.  
  9. // RGBか、HSL表記の文字列を返す
  10. chroma('').css();            // "rgb(0,128,128)" 省略時はRGB
  11. chroma('').alpha(0.5).css(); // "rgba(0,128,128,0.5)"
  12. chroma('').css('hsl');       // "hsl(180,100%,25.1%)"
  13.  
  14. // 各色空間毎の値を配列で返す
  15. chroma('').rgb();       // [255,165,0]
  16. chroma('').hsl();       // [38.82,1,0.5]
  17. chroma('').hsv();       // [38.82,1,1]
  18. chroma('').hsi();       // [39.64,1,0.55]
  19. chroma('').lab();       // [74.94,23.93,78.95]
  20. chroma('').lch();      // [79.21,25.94,235.11]
  21. chroma('').hcl();      // [235.11,25.94,79.21]

コントラストを取得


  1. // 2色間のコントラストを取得。
  2. // 例えば背景色と白色を比較し、値が小さい(=文字が見づらい)場合は文字色を白くするといった判定に使える
  3. chroma.contrast('', ''); // 1.5379867185268434
  4. chroma.contrast('', ''); // 8.592471358428805
コントラスト比は最低でも4.5:1を目安にすれば大丈夫そうです。

カラースケールの作成



カラースケールはこのライブラリの主要機能の一つで、冒頭のサンプルにおいてテスト点数に応じて様々な濃さの赤や青を取得する際に利用しました。
グラデーションやヒートマップのように、特定の色との間の微妙な色合いを求めるのに便利です。

基本的な使い方



chroma.scale でスケールを作成し、スケールに対して数値(ドメイン)を指定することで色を取り出します。
  1. // 引数無しのデフォルトでは 白→黒 、0~1の範囲(ドメイン)で作成される。
  2. f = chroma.scale(); 
  3. f(0.25);  // 
  4. f(0.5);   // 
  5. f(0.75);  // 
上の例だと、白(#FFFFFF)から黒(#000000)のスケールを定義し、0が白、1が黒となります。
つまり0.5は白と黒の丁度中間、0.75は中間と黒の間の色です。

スケール作成時の引数に配列を渡すことにより、スケールの色を定義できます。
  1. chroma.scale(['', '']); 
上の例では 黄 → 緑 に移り変わるカラースケールを定義しています。

スケールの範囲はデフォルトで0~1ですが、自分で定義することも可能です。
以下の例では 黄 ~ 緑 を 0 ~ 100の範囲で定義しています。色を取り出す時の引数の範囲が広がります。
  1. chroma.scale(['', ''])).domain([0, 100]); 
冒頭のサンプルでは、テストの点数と対応させるために、0~100に設定していました。

複数色からなるカラースケールと、ドメインの区切り設定



色は2色でなくてもよく、例えば以下の例では 黄 → 緑 → 白 という3色の定義です。
  1. chroma.scale(['', '', '']); 
0で黄、0.5で緑、1で白。なので、0.25は黄と緑の中間、0.75は緑と白の中間色が取得できます。

また、以下のように色数に応じたdomainを明示的に指定することで、各領域の区切り位置をずらせます。
  1. chroma.scale(['', '', '']).domain([0, 0.2, 1]);
  2.  // 一つ上の例
  3.  // ずらした例
domainを指定しなかった場合、緑は0.5の位置でしたが、この場合は0.2の位置が緑になります。

色空間による違い



カラースケールの色変化は色空間によって変わります。利用する色空間を指定する場合はmode関数で指定します。
何も指定しない場合のデフォルトはrgbです。
  1. chroma.scale(['', '']); // 省略時はrgb 
  2. chroma.scale(['', '']).mode('lab');   
  3. chroma.scale(['', '']).mode('hsl');   
  4. chroma.scale(['', '']).mode('lch');   

色の区切る個数を指定する



例えば 黄色から緑へのカラースケールを作るけど、使う色はグラデーションみたいではなく、5色だけでいいのに…という時は以下のように書きます
  1. chroma.scale(['', '']).classes(5); 
更に、ぴったり5等分ではなく「10%、20%、40%、20%、10%」みたいに真ん中の層を厚くしたい!という時は、引数を配列にして区切る位置を指定します。
  1. chroma.scale(['', '']).classes([0, 0.1, 0.3, 0.7, 0.9, 1]);
  2.  // 1つ上の例
  3.  // ずらした例

最後に



単なるテキストデータでも、データに応じた色がつくだけで大分印象も変わります。
数字の羅列だけでは伝わりにくい情報も、色で直感的に伝えられるようになる例もあります。
そんなアクセント付けの時に便利なのではないでしょうか。
また、Web上から色を合成したり補正するサービスを作るのにも便利そうです。