Class StypHSL

constructor

• new StypHSL(coords, opts?): StypHSL

• Constructs HSL color value.

  Parameters

  • coords: StypHSL.Coords

    Color coordinates.

  • Optional opts: StypValue.Opts

    Construction options.

  Returns StypHSL

Readonly a

Readonly h

Readonly l

Readonly s

hsl

• get hsl(): this

• This color in HSL coordinates.

  Always the same as this.

  Returns this

rgb

• get rgb(): StypRGB

• This color in RGB coordinates.

  Returns StypRGB

type

• get type(): "hsl"

• Color value type corresponding to color coordinates. Either rgb or hsl

  Returns "hsl"

by

• by(source): StypColor

• Maps the given CSS property value to the value of this one's type. Defaults to this value if mapping is not possible.

  This method allows to use an structured value instance as CSS property mapping.

  Parameters

  • source: StypValue

    A raw property value that should be converted.

  Returns StypColor

  Mapped property value.

is

• is(other): boolean

• Checks whether this value equals to CSS property value.

  Parameters

  • other: StypValue

    CSS property value to compare with.

  Returns boolean

prioritize

• prioritize(priority): StypHSL

• Creates structured CSS value with the given priority.

  Parameters

  • priority: number

    New priority.

  Returns StypHSL

  Either a new value equal to this one but having the given priority, or this one if priority did not change.

set

• set(coords): StypHSL

• Constructs another color value with updated coordinates.

  Parameters

  • coords: Partial<StypHSL.Coords> | ((this, color) => Partial<StypHSL.Coords>)

    Either partial color coordinates to apply or a function returning them and accepting this color instance as its only argument. Missing values are taken from this color.

  Returns StypHSL

  Updated color value.

toString

• toString(): string

• Returns textual representation of this value.

  Textual representation never contains an !important suffix.

  Returns string

  A textual representation of this value to use as CSS property value.