Class HSV

Represents a color in the HSV (Hue, Saturation, Value) color space. Extends the base Color class.

Hierarchy (View Summary)

Color
- HSV

Index

Constructors

Methods

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

Properties

a h s v HSL HSV parse RGB

Constructors

constructor

new HSV(h: number, s: number, v: number, a?: number): HSV
Constructs a new HSV color.
Parameters
- h: number
  The hue component, in the range [0, 360].
- s: number
  The saturation component, in the range [0, 100].
- v: number
  The value (brightness) component, in the range [0, 100].
- a: number = 1
  The alpha (opacity) component, in the range [0, 1]. Defaults to 1.
Returns HSV
Overrides Color.constructor
- Defined in src/color/hsv.ts:38

Methods

asArray

asArray(): [number, number, number, number]
Returns the HSV color as an array of numbers.

Returns [number, number, number, number]
An array containing the hue, saturation, value, and alpha components.
Overrides Color.asArray
- Defined in src/color/hsv.ts:50

asHex

asHex(): string
Converts the color to a hexadecimal string.

Returns string
The hexadecimal representation of the color.
Inherited from Color.asHex
- Defined in src/color/abstract.ts:48

asHSL

asHSL(): HSL
Converts the HSV color to an HSL color.

Returns HSL
An HSL representation of the color.
Overrides Color.asHSL
- Defined in src/color/hsv.ts:87

asHSV

asHSV(): HSV
Returns the current HSV color.

Returns HSV
The current HSV color.
Overrides Color.asHSV
- Defined in src/color/hsv.ts:104

asRGB

asRGB(): RGB
Converts the HSV color to an RGB color.

Returns RGB
An RGB representation of the color.
Overrides Color.asRGB
- Defined in src/color/hsv.ts:120

asString

asString(): string
Returns the color as a string representation.

Returns string
A string representation of the color.
Overrides Color.asString
- Defined in src/color/hsv.ts:71

blend

blend(value: number, blendColor: Color): RGB
Blends the color with another color.
Parameters
- value: number
  The blend ratio.
- blendColor: Color
  The color to blend with.
Returns RGB
A new RGB color that is blended.
Inherited from Color.blend
- Defined in src/color/abstract.ts:183

brightness

brightness(value: number): RGB
Adjusts the brightness of the color.
Parameters
- value: number
  The brightness adjustment value.
Returns RGB
A new RGB color with adjusted brightness.
Inherited from Color.brightness
- Defined in src/color/abstract.ts:145

clone

clone(): HSV
Creates a new HSV color that is a copy of the current color.

Returns HSV
A new HSV color that is a clone of the current color.
Overrides Color.clone
- Defined in src/color/hsv.ts:79

contrast

contrast(value: number): RGB
Adjusts the contrast of the color.
Parameters
- value: number
  The contrast adjustment value.
Returns RGB
A new RGB color with adjusted contrast.
Inherited from Color.contrast
- Defined in src/color/abstract.ts:136

darken

darken(value: number): RGB
Darkens the color by a given value.
Parameters
- value: number
  The amount to darken the color.
Returns RGB
A new RGB color that is darkened.
Inherited from Color.darken
- Defined in src/color/abstract.ts:163

fade

fade(value: number): HSV
Fades the color by a given value.
Parameters
- value: number
  The amount to fade the color by, in the range [0, 1].
Returns HSV
A new HSV color with the alpha component faded by the given value.
Overrides Color.fade
- Defined in src/color/hsv.ts:156

gamma

gamma(value: number): RGB
Applies gamma correction to the color.
Parameters
- value: number
  The gamma correction value.
Returns RGB
A new RGB color with gamma correction applied.
Inherited from Color.gamma
- Defined in src/color/abstract.ts:119

invert

invert(): RGB
Inverts the color.

Returns RGB
A new RGB color with inverted values.
Inherited from Color.invert
- Defined in src/color/abstract.ts:127

invertLuminosity

invertLuminosity(): HSL
Inverts the luminosity of the color.

Returns HSL
A new HSL color with inverted luminosity.
Inherited from Color.invertLuminosity
- Defined in src/color/abstract.ts:92

lighten

lighten(value: number): RGB
Lightens the color by a given value.
Parameters
- value: number
  The amount to lighten the color.
Returns RGB
A new RGB color that is lightened.
Inherited from Color.lighten
- Defined in src/color/abstract.ts:154

rotateHue

rotateHue(offset: number): HSL
Rotates the hue of the color by a given offset.
Parameters
- offset: number
  The amount to rotate the hue.
Returns HSL
A new HSL color with the hue rotated.
Inherited from Color.rotateHue
- Defined in src/color/abstract.ts:101

round

round(): HSV
Returns a new HSV color with the components rounded to the nearest integer.

Returns HSV
A new HSV color with rounded components.
Overrides Color.round
- Defined in src/color/hsv.ts:58

saturate

saturate(ratio: number): HSL
Saturates the color by a given ratio.
Parameters
- ratio: number
  The ratio to saturate the color.
Returns HSL
A new HSL color with increased saturation.
Inherited from Color.saturate
- Defined in src/color/abstract.ts:110

setHue

setHue(value: number): HSV
Sets the hue component of the color.
Parameters
- value: number
  The new hue value, in the range [0, 360].
Returns HSV
A new HSV color with the updated hue component.
Overrides Color.setHue
- Defined in src/color/hsv.ts:165

tint

tint(value: number, tintColor: Color): RGB
Tints the color by blending it with another color.
Parameters
- value: number
  The blend ratio.
- tintColor: Color
  The color to blend with.
Returns RGB
A new RGB color that is tinted.
Inherited from Color.tint
- Defined in src/color/abstract.ts:173

toHSV

toHSV(): HSV
Returns the current HSV color.

Returns HSV
The current HSV color.
- Defined in src/color/hsv.ts:112

Properties

`Readonly`a

a: number

The alpha (opacity) component of the color, in the range [0, 1].

`Readonly`h

h: number

The hue component of the color, in the range [0, 360].

`Readonly`s

s: number

The saturation component of the color, in the range [0, 100].

`Readonly`v

v: number

The value (brightness) component of the color, in the range [0, 100].

`Static`HSL

HSL: typeof HSL

The HSL color model.

`Static`HSV

HSV: typeof HSV

The HSV color model.

`Static`parse

parse: (input: string | Color) => Color

Parses a color from a string or another Color instance.

Type declaration

- (input: string | Color): Color
- Parameters
  - input: string | Color
    The input color as a string or Color instance.
  Returns Color
  The parsed Color instance.

`Static`RGB

RGB: typeof RGB

The RGB color model.

Class HSV

Hierarchy (View Summary)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns HSV

Methods

asArray

Returns [number, number, number, number]

asHex

Returns string

asHSL

Returns HSL

asHSV

Returns HSV

asRGB

Returns RGB

asString

Returns string

blend

Parameters

Returns RGB

brightness

Parameters

Returns RGB

clone

Returns HSV

contrast

Parameters

Returns RGB

darken

Parameters

Returns RGB

fade

Parameters

Returns HSV

gamma

Parameters

Returns RGB

invert

Returns RGB

invertLuminosity

Returns HSL

lighten

Parameters

Returns RGB

rotateHue

Parameters

Returns HSL

round

Returns HSV

saturate

Parameters

Returns HSL

setHue

Parameters

Returns HSV

tint

Parameters

Returns RGB

toHSV

Returns HSV

Properties

Readonlya

Readonlyh

Readonlys

Readonlyv

StaticHSL

StaticHSV

Staticparse

Type declaration

Parameters

Returns Color

StaticRGB

Settings

On This Page

`Readonly`a

`Readonly`h

`Readonly`s

`Readonly`v

`Static`HSL

`Static`HSV

`Static`parse

`Static`RGB