Module Utils/ColorUtils

Functions

colorMix

colorMix(color1: IRgb | IHsl, color2: IRgb | IHsl, size1: number, size2: number): IRgb

- Defined in src/Utils/ColorUtils.ts:524
Parameters
- color1: IRgb | IHsl
- color2: IRgb | IHsl
- size1: number
- size2: number
Returns IRgb

colorToHsl

colorToHsl(color: undefined | string | IColor, index?: number, useIndex?: boolean): IHsl | undefined

- Defined in src/Utils/ColorUtils.ts:161
Gets the particles color

Parameters
- color: undefined | string | IColor
  
  the input color to convert in IHsl object
- Optional index: number
  
  the array index, if needed
- useIndex: boolean = true
  
  set to false to ignore the index parameter
Returns IHsl | undefined
the IHsl object

colorToRgb

colorToRgb(input?: string | IColor, index?: number, useIndex?: boolean): IRgb | undefined

- Defined in src/Utils/ColorUtils.ts:113
Gets the particles color

Parameters
- Optional input: string | IColor
  
  the input color to convert in IRgb object
- Optional index: number
  
  the array index, if needed
- useIndex: boolean = true
  
  set to false to ignore the index parameter
Returns IRgb | undefined

getHslAnimationFromHsl

getHslAnimationFromHsl(hsl: IHsl, animationOptions: undefined | HslAnimation, reduceFactor: number): IParticleHslAnimation

- Defined in src/Utils/ColorUtils.ts:598
Parameters
- hsl: IHsl
- animationOptions: undefined | HslAnimation
- reduceFactor: number
Returns IParticleHslAnimation

getHslFromAnimation

getHslFromAnimation(animation?: IParticleHslAnimation): IHsl | undefined

- Defined in src/Utils/ColorUtils.ts:588
Parameters
- Optional animation: IParticleHslAnimation
Returns IHsl | undefined

getLinkColor

getLinkColor(p1: IParticle, p2?: IParticle, linkColor?: string | IRgb): IRgb | undefined

- Defined in src/Utils/ColorUtils.ts:543
Parameters
- p1: IParticle
- Optional p2: IParticle
- Optional linkColor: string | IRgb
Returns IRgb | undefined

getLinkRandomColor

getLinkRandomColor(optColor: string | IColor, blink: boolean, consent: boolean): IRgb | string | undefined

- Defined in src/Utils/ColorUtils.ts:564
Parameters
- optColor: string | IColor
- blink: boolean
- consent: boolean
Returns IRgb | string | undefined

getRandomRgbColor

getRandomRgbColor(min?: number): IRgb

- Defined in src/Utils/ColorUtils.ts:484
Returns a random (IRgb) color

Parameters
- Optional min: number
  
  the minimum value for the color
Returns IRgb
the random (IRgb) color

getStyleFromHsl

getStyleFromHsl(color: IHsl, opacity?: number): string

- Defined in src/Utils/ColorUtils.ts:510
Gets a CSS style string from a IHsl object and opacity value

Parameters
- color: IHsl
  
  the IHsl input color
- Optional opacity: number
  
  the opacity value
Returns string
the CSS style string

getStyleFromHsv

getStyleFromHsv(color: IHsv, opacity?: number): string

- Defined in src/Utils/ColorUtils.ts:520
Gets a CSS style string from a IHsv object and opacity value

Parameters
- color: IHsv
  
  the IHsv input color
- Optional opacity: number
  
  the opacity value
Returns string
the CSS style string

getStyleFromRgb

getStyleFromRgb(color: IRgb, opacity?: number): string

- Defined in src/Utils/ColorUtils.ts:500
Gets a CSS style string from a IRgb object and opacity value

Parameters
- color: IRgb
  
  the IRgb input color
- Optional opacity: number
  
  the opacity value
Returns string
the CSS style string

hslToHsv

hslToHsv(hsl: IHsl): IHsv

- Defined in src/Utils/ColorUtils.ts:283
Converts a Hue Saturation Lightness (IHsl) object in a IHsv object

Parameters
- hsl: IHsl
  
  the Hue Saturation Lightness (IHsl) object
Returns IHsv
the IHsv object

hslToRgb

hslToRgb(hsl: IHsl): IRgb

- Defined in src/Utils/ColorUtils.ts:231
Converts a Hue Saturation Lightness (IHsl) object in a IRgb object

Parameters
- hsl: IHsl
  
  the Hue Saturation Lightness (IHsl) object
Returns IRgb
the IRgb object

hslaToHsva

hslaToHsva(hsla: IHsla): IHsva

- Defined in src/Utils/ColorUtils.ts:301
Converts a Hue Saturation Lightness (IHsla) object in a IHsva object

Parameters
- hsla: IHsla
  
  the Hue Saturation Lightness (IHsla) object
Returns IHsva
the IHsva object

hslaToRgba

hslaToRgba(hsla: IHsla): IRgba

- Defined in src/Utils/ColorUtils.ts:267
Converts HSLA color to RGBA color

Parameters
- hsla: IHsla
  
  the HSLA color to convert
Returns IRgba
the RGBA color

hsvToHsl

hsvToHsl(hsv: IHsv): IHsl

- Defined in src/Utils/ColorUtils.ts:317
Converts a Hue Saturation Lightness (IHsv) object in a IHsl object

Parameters
- hsv: IHsv
  
  the Hue Saturation Lightness (IHsv) object
Returns IHsl
the IHsl object

hsvToRgb

hsvToRgb(hsv: IHsv): IRgb

- Defined in src/Utils/ColorUtils.ts:351
Converts a Hue Saturation Lightness (IHsv) object in a IRgb object

Parameters
- hsv: IHsv
  
  the Hue Saturation Lightness (IHsv) object
Returns IRgb
the IRgb object

hsvaToHsla

hsvaToHsla(hsva: IHsva): IHsla

- Defined in src/Utils/ColorUtils.ts:335
Converts a Hue Saturation Lightness (IHsva) object in a IHsla object

Parameters
- hsva: IHsva
  
  the Hue Saturation Lightness (IHsva) object
Returns IHsla
the IHsla object

hsvaToRgba

hsvaToRgba(hsva: IHsva): IRgba

- Defined in src/Utils/ColorUtils.ts:418
Converts a Hue Saturation Value (IHsva) object in a IRgba object

Parameters
- hsva: IHsva
  
  the Hue Saturation Value (IHsva) object
Returns IRgba
the IRgba object

rgbToHsl

rgbToHsl(color: IRgb): IHsl

- Defined in src/Utils/ColorUtils.ts:172
Converts rgb color to hsl color

Parameters
- color: IRgb
  
  rgb color to convert
Returns IHsl
hsl color

rgbToHsv

rgbToHsv(rgb: IRgb): IHsv

- Defined in src/Utils/ColorUtils.ts:434
Converts a RGB (IRgb) object in a IHsv object

Parameters
- rgb: IRgb
  
  the RGB (IRgb) object
Returns IHsv
the IHsv object

rgbaToHsva

rgbaToHsva(rgba: IRgba): IHsva

- Defined in src/Utils/ColorUtils.ts:468
Converts a RGB (IRgba) object in a IHsva object

Parameters
- rgba: IRgba
  
  the RGB (IRgba) object
Returns IHsva

stringToAlpha

stringToAlpha(input: string): number | undefined

- Defined in src/Utils/ColorUtils.ts:213
Gets alpha value from string color

Parameters
- input: string
  
  the input color to convert in alpha value
Returns number | undefined
the alpha value

stringToRgb

stringToRgb(input: string): IRgb | undefined

- Defined in src/Utils/ColorUtils.ts:222
Converts hexadecimal string (HTML color code) in a IRgb object

Parameters
- input: string
  
  the hexadecimal string (#f70 or #ff7700)
Returns IRgb | undefined
the IRgb object