Class HslColorHelper

HSL色処理ヘルパークラス HSL値を保持し、RGBに変換などする

Hierarchy

HslColorHelper

Index

Constructors

Properties

Accessors

h l s

Methods

_toRgbHex toCssColorStyle toRgbHex toRgbHexString fromRgb fromRgbHex fromRgbString hslToRgb normalizeHue parseRgbString

Constructors

constructor

new HslColorHelper(h??: number, s??: number, l??: number): HslColorHelper
Parameters
- Optional h: number = 0
- Optional s: number = 0.5
- Optional l: number = 0.5
Returns HslColorHelper
- Defined in math/ColorHelper.ts:36

Properties

_h

_h: number

hue: 0 ~ 1

_l

_l: number

luminescence: 0 ~ 1

_s

_s: number

saturation: 0 ~ 1

Accessors

h

get h(): number
hue: clamped to 0 ~ 1

Returns number
- Defined in math/ColorHelper.ts:76
set h(v: number): void
Parameters
- v: number
Returns void
- Defined in math/ColorHelper.ts:79

l

get l(): number
luminescence: clamped to 0 ~ 1

Returns number
- Defined in math/ColorHelper.ts:98
set l(v: number): void
Parameters
- v: number
Returns void
- Defined in math/ColorHelper.ts:101

s

get s(): number
saturation: clamped to 0 ~ 1

Returns number
- Defined in math/ColorHelper.ts:87
set s(v: number): void
Parameters
- v: number
Returns void
- Defined in math/ColorHelper.ts:90

Methods

`Private` _toRgbHex

_toRgbHex(): string
Returns string
- Defined in math/ColorHelper.ts:42

toCssColorStyle

toCssColorStyle(): string
Returns string
- Defined in math/ColorHelper.ts:69

toRgbHex

toRgbHex(): number
現在のHSL値をRGB16進数Number型で返す

Returns number
- Defined in math/ColorHelper.ts:65

toRgbHexString

toRgbHexString(): string
現在のHSL値を#ffee11のような形式のRGB文字列で返す

Returns string
- Defined in math/ColorHelper.ts:58

`Static` fromRgb

fromRgb(r: number, g: number, b: number): HslColorHelper
RGB数値（10進数, 0 ~ 255）からインスタンス生成

See
https://stackoverflow.com/a/9493060

Returns
HslColorHelper instance
Parameters
- r: number
  
  Normalized to 0 ~ 255
- g: number
  
  Normalized to 0 ~ 255
- b: number
  
  Normalized to 0 ~ 255
Returns HslColorHelper
- Defined in math/ColorHelper.ts:138

`Static` fromRgbHex

fromRgbHex(rgbHex: number): HslColorHelper
RGB数値(10進数)からインスタンス生成

Example
```
const color = HslColorHelper.fromRgbHex(16777215); // #ffffff
console.log(color.l === 1);
```
Returns
HslColorHelper instance
Parameters
- rgbHex: number
Returns HslColorHelper
- Defined in math/ColorHelper.ts:214

`Static` fromRgbString

fromRgbString(rgbStr: string): HslColorHelper
RGB文字列からインスタンス生成

Example
```
const color = HslColorHelper.fromRgbString("ff0000")
console.log(color.h === 0); // Red
```
Returns
HslColorHelper instance
Parameters
- rgbStr: string
Returns HslColorHelper
- Defined in math/ColorHelper.ts:200

`Static` hslToRgb

hslToRgb(h: number, s: number, l: number): ColorCodeTupple
0 ~ 1範囲のHSL値を同じく 0 ~ 1範囲のRGB値に変換

See
https://stackoverflow.com/a/9493060
Parameters
- h: number
  
  0 ~ 1
- s: number
  
  0 ~ 1
- l: number
  
  0 ~ 1
Returns ColorCodeTupple
- Defined in math/ColorHelper.ts:114

`Static` normalizeHue

normalizeHue(v: number): number
Convert hue value from degree(0 ~ 360) to 0 ~ 0.1
Parameters
- v: number
Returns number
- Defined in math/ColorHelper.ts:225

`Static` parseRgbString

parseRgbString(rgbStr: string): ColorCodeTupple
RGB文字列をパースし、[r, g, b]型の数値（10進数）配列を返すハッシュ（"#"）つきでもOK

Example
```
HslColorHelper.parseRgbString("#ff00fe"); // [255, 0, 254]
```
Returns
HslColorHelper instance
Parameters
- rgbStr: string
Returns ColorCodeTupple
- Defined in math/ColorHelper.ts:179

Generated using TypeDoc