Last updated

API / geotoolkit / util / HsvColor / HsvColor

Class: HsvColor

util.HsvColor.HsvColor

Specify HSV color, which can be defined as s set of the three color components (Hue, Saturation, Value).

Table of contents

Constructors
[new HsvColor()](/solutions/geotoolkit/apis/classes/geotoolkit.util.hsvcolor.hsvcolor.md#new hsvcolor())[new HsvColor(hue, sat, val)](/solutions/geotoolkit/apis/classes/geotoolkit.util.hsvcolor.hsvcolor.md#new hsvcolor(hue, sat, val))[new HsvColor(rgba)](/solutions/geotoolkit/apis/classes/geotoolkit.util.hsvcolor.hsvcolor.md#new hsvcolor(rgba))
Methods

Contents

Constructors

new HsvColor()

new HsvColor()


new HsvColor(hue, sat, val)

new HsvColor(hue, sat, val)

Parameters

Name Type Description
huenumberhue from 0 to 360
satnumbersat from 0 to 1
valnumberval from 0 to 1

new HsvColor(rgba)

new HsvColor(rgba)

Parameters

Name Type
rgbaRgbaColor
Methods

adjustSaturation

adjustSaturation(delta): HsvColor

Add delta to saturation. Saturation is between 0 and 1

Parameters

Name Type Description
deltanumberdelta value to be added

Returns

HsvColor

this


adjustSaturationByFactor

adjustSaturationByFactor(factor): HsvColor

Multiply saturation factor. Saturation is between 0 and 1

Parameters

Name Type Description
factornumbersaturation factor (between 0 - 1)

Returns

HsvColor

this


adjustValue

adjustValue(delta): HsvColor

Add delta to value. Value is between 0 and 1

Parameters

Name Type Description
deltanumberdelta value to be added

Returns

HsvColor

this


adjustValueByFactor

adjustValueByFactor(factor): HsvColor

Multiply value by factor. Value is between 0 and 1

Parameters

Name Type Description
factornumberfactor to multiply this color by

Returns

HsvColor

this


clone

clone(): HsvColor

Return clone of the color

Returns

HsvColor

clone


getClassName

getClassName(): string

Returns

string


getHue

getHue(): number

Return hue

Returns

number


getSaturation

getSaturation(): number

Return saturation

Returns

number


getValue

getValue(): number

Return value

Returns

number


toRgbaColor

toRgbaColor(): RgbaColor

Convert current value and saturation to RGBA

Returns

RgbaColor


toRgbaString

toRgbaString(): string

Convert color from HSV to RGBA string

Returns

string


getClassName

Static getClassName(): string

Returns

string


getNewColor

Static getNewColor(): string

return new color

Returns

string


setBrightness

Static setBrightness(color, correctionFactor): RgbaColor

Sets brightness

Parameters

Name Type Description
colorRgbaColorcolor
correctionFactornumbercorrection Factor

Returns

RgbaColor

result