Class HSL

Hierarchy (View Summary, Expand)

Color
- HSL

Index

Constructors

Properties

a h l s HSL HSV random RGB

Methods

asArray asHex asHSL asHSV asRGB asString blend brightness clone contrast darken fade gamma invert invertLuminosity lighten rotateHue round saturate setHue tint toHSL toHSV toRGB parse

Constructors

constructor

new HSL(h: number, s: number, l: number, a?: number): HSL
Parameters
- h: number
- s: number
- l: number
- a: number = 1
Returns HSL
Overrides Color.constructor
- Defined in color/hsl.ts:12

Properties

`Readonly`a

a: number = 1

`Readonly`h

h: number = 0

`Readonly`l

l: number = 0

`Readonly`s

s: number = 0

`Static`HSL

HSL: typeof HSL

`Static`HSV

HSV: typeof HSV

`Static`random

random: (options?: RandomColorOptions) => HSV

`Static`RGB

RGB: typeof RGB

Methods

asArray

asArray(): [number, number, number, number]
Returns [number, number, number, number]
Overrides Color.asArray
- Defined in color/hsl.ts:20

asHex

asHex(): string
Returns string
Inherited from Color.asHex
- Defined in color/abstract.ts:14

asHSL

asHSL(): HSL
Returns HSL
Overrides Color.asHSL
- Defined in color/hsl.ts:45

asHSV

asHSV(): HSV
Returns HSV
Overrides Color.asHSV
- Defined in color/hsl.ts:53

asRGB

asRGB(): RGB
Returns RGB
Overrides Color.asRGB
- Defined in color/hsl.ts:60

asString

asString(): string
Returns string
Overrides Color.asString
- Defined in color/hsl.ts:37

blend

blend(value: number, blendColor: Color): RGB
Parameters
- value: number
- blendColor: Color
Returns RGB
Inherited from Color.blend
- Defined in color/abstract.ts:78

brightness

brightness(value: number): RGB
Parameters
- value: number
Returns RGB
Inherited from Color.brightness
- Defined in color/abstract.ts:62

clone

clone(): HSL
Returns HSL
Overrides Color.clone
- Defined in color/hsl.ts:33

contrast

contrast(value: number): RGB
Parameters
- value: number
Returns RGB
Inherited from Color.contrast
- Defined in color/abstract.ts:58

darken

darken(value: number): RGB
Parameters
- value: number
Returns RGB
Inherited from Color.darken
- Defined in color/abstract.ts:70

fade

fade(value: number): HSL
Parameters
- value: number
Returns HSL
Overrides Color.fade
- Defined in color/hsl.ts:119

gamma

gamma(value: number): RGB
Parameters
- value: number
Returns RGB
Inherited from Color.gamma
- Defined in color/abstract.ts:50

invert

invert(): RGB
Returns RGB
Inherited from Color.invert
- Defined in color/abstract.ts:54

invertLuminosity

invertLuminosity(): HSL
Returns HSL
Overrides Color.invertLuminosity
- Defined in color/hsl.ts:107

lighten

lighten(value: number): RGB
Parameters
- value: number
Returns RGB
Inherited from Color.lighten
- Defined in color/abstract.ts:66

rotateHue

rotateHue(offset: number): HSL
Parameters
- offset: number
Returns HSL
Overrides Color.rotateHue
- Defined in color/hsl.ts:111

round

round(): HSL
Returns HSL
Overrides Color.round
- Defined in color/hsl.ts:24

saturate

saturate(ratio: number): HSL
Parameters
- ratio: number
Returns HSL
Overrides Color.saturate
- Defined in color/hsl.ts:115

setHue

setHue(value: number): HSV
Parameters
- value: number
Returns HSV
Inherited from Color.setHue
- Defined in color/abstract.ts:82

tint

tint(value: number, tintColor: Color): RGB
Parameters
- value: number
- tintColor: Color
Returns RGB
Inherited from Color.tint
- Defined in color/abstract.ts:74

toHSL

toHSL(): HSL
Returns HSL
Overrides Color.toHSL
- Defined in color/hsl.ts:49

toHSV

toHSV(): HSV
Returns HSV
Inherited from Color.toHSV
- Defined in color/abstract.ts:30

toRGB

toRGB(): RGB
Returns RGB
Inherited from Color.toRGB
- Defined in color/abstract.ts:34

`Static`parse

parse(input: string | Color): HSL
Parameters
- input: string | Color
Returns HSL
Overrides Color.parse
- Defined in color/hsl.ts:89