Class HslColor

Hierarchy

Color
- HslColor

Index

Constructors

constructor

Properties

Accessors

lightness

Methods

Constructors

constructor

new HslColor(h: number, s: number, l: number, a?: number): HslColor

Overrides Color.constructor
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:14
Parameters
- h: number
- s: number
- l: number
- Optional a: number
Returns HslColor

Properties

Readonly a

a: number

Readonly h

h: number

Readonly l

l: number

Readonly s

s: number

Readonly stringValue

stringValue: undefined | string

Static Brighter

Brighter: number

Static Darker

Darker: number

Accessors

lightness

get lightness(): number

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:23
Returns number

Methods

alpha

alpha(): number
alpha(a: number): HslColor

Overrides Color.alpha
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:21
Returns number
Overrides Color.alpha
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:22
Parameters
- a: number
Returns HslColor

combine

combine(that: AnyColor, scalar?: number): HslColor

Overrides Color.combine
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:26
Parameters
- that: AnyColor
- Optional scalar: number
Returns HslColor

contrast

contrast(k?: number): Color

Inherited from Color.contrast
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/color/Color.d.ts:20
Parameters
- Optional k: number
Returns Color

darker

darker(k?: number): HslColor

Overrides Color.darker
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:28
Parameters
- Optional k: number
Returns HslColor

debug

debug(output: Output<unknown>): void

Overrides Color.debug
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:38
Parameters
- output: Output<unknown>
Returns void

equals

equals(that: unknown): boolean

Overrides Color.equals
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:36
Parameters
- that: unknown
Returns boolean

equivalentTo

equivalentTo(that: unknown, epsilon?: number): boolean

Overrides Color.equivalentTo
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:35
Parameters
- that: unknown
- Optional epsilon: number
Returns boolean

hashCode

hashCode(): number

Overrides Color.hashCode
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:37
Returns number

hsl

hsl(): HslColor

Overrides Color.hsl
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:31
Returns HslColor

interpolateTo

interpolateTo(that: HslColor): Interpolator<HslColor>
interpolateTo(that: Color): Interpolator<Color>
interpolateTo(that: unknown): null | Interpolator<Color>

Overrides Color.interpolateTo
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:32
Parameters
- that: HslColor
Returns Interpolator<HslColor>
Overrides Color.interpolateTo
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:33
Parameters
- that: Color
Returns Interpolator<Color>
Overrides Color.interpolateTo
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:34
Parameters
- that: unknown
Returns null | Interpolator<Color>

isDefined

isDefined(): boolean

Overrides Color.isDefined
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:16
Returns boolean

lighter

lighter(k?: number): HslColor

Overrides Color.lighter
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:27
Parameters
- Optional k: number
Returns HslColor

plus

plus(that: AnyColor): HslColor

Overrides Color.plus
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:24
Parameters
- that: AnyColor
Returns HslColor

rgb

rgb(): RgbColor

Overrides Color.rgb
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:30
Returns RgbColor

times

times(scalar: number): HslColor

Overrides Color.times
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:25
Parameters
- scalar: number
Returns HslColor

toHexString

toHexString(): string

Overrides Color.toHexString
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:39
Returns string

toString

toString(): string

Overrides Color.toString
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:41
Returns string

Static black

black(alpha?: number): HslColor

Overrides Color.black
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:43
Parameters
- Optional alpha: number
Returns HslColor

Static forName

forName(name: string): null | Color

Inherited from Color.forName
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/color/Color.d.ts:36
Parameters
- name: string
Returns null | Color

Static form

form(): Form<Color, AnyColor>

Inherited from Color.form
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/color/Color.d.ts:43
Returns Form<Color, AnyColor>

Static fromAny

fromAny(value: AnyHslColor): HslColor

Overrides Color.fromAny
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:46
Parameters
- value: AnyHslColor
Returns HslColor

Static fromInit

fromInit(value: HslColorInit): HslColor

Overrides Color.fromInit
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:45
Parameters
- value: HslColorInit
Returns HslColor

Static fromValue

fromValue(value: Value): null | HslColor

Overrides Color.fromValue
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:47
Parameters
- value: Value
Returns null | HslColor

Static hsl

hsl(h: AnyAngle, s: number, l: number, a?: number): HslColor

Inherited from Color.hsl
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/color/Color.d.ts:35
Parameters
- h: AnyAngle
- s: number
- l: number
- Optional a: number
Returns HslColor

Static isAny

isAny(value: unknown): value is AnyHslColor

Overrides Color.isAny
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:50
Parameters
- value: unknown
Returns value is AnyHslColor

Static isInit

isInit(value: unknown): value is HslColorInit

Overrides Color.isInit
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:49
Parameters
- value: unknown
Returns value is HslColorInit

Static parse

parse(str: string): HslColor

Overrides Color.parse
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:48
Parameters
- str: string
Returns HslColor

Static rgb

rgb(r: number, g: number, b: number, a?: number): RgbColor

Inherited from Color.rgb
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/color/Color.d.ts:34
Parameters
- r: number
- g: number
- b: number
- Optional a: number
Returns RgbColor

Static transparent

transparent(): HslColor

Overrides Color.transparent
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:42
Returns HslColor

Static white

white(alpha?: number): HslColor

Overrides Color.white
- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/hsl/HslColor.d.ts:44
Parameters
- Optional alpha: number
Returns HslColor

Generated using TypeDoc