HslColor class

A color in the HSL color space.

The HSL color space contains channels for hue, saturation, and lightness.

Implemented types

• ColorModel

Available extensions

• LerpToColor
• ToColor
• ToColorModel

Constructors

HslColor(num hue, num saturation, num lightness, [int alpha = 255])

A color in the HSL color space.

const

HslColor.extrapolate(List<double> values)

Constructs a HslColor from a list of hsl values on a 0 to 1 scale.

factory

HslColor.from(ColorModel color)

Constructs a HslColor from color.

factory

HslColor.fromColor(Color color)

Constructs a HslColor from color.

factory

HslColor.fromHex(String hex)

Constructs a HslColor from a RGB hex color.

factory

HslColor.fromList(List<num> values)

Constructs a HslColor from a list of hsl values.

factory

HslColor.random({num minHue = 0, num maxHue = 360, num minSaturation = 0, num maxSaturation = 100, num minLightness = 0, num maxLightness = 100, int? seed})

Generates a HslColor at random.

factory

Properties

a → double

The alpha channel of this color.

final, inherited

alpha → int

The alpha value of this color.

final, inherited

b → double

The blue channel of this color.

final, inherited

blue → int

The blue value of this color.

no setter, inherited

chroma → double

Calculates a value representing this color's lightness on a linear scale.

no setter, inherited

colorSpace → ColorSpace

The color space of this color.

final, inherited

g → double

The green channel of this color.

final, inherited

green → int

The green value of this color.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

hex → String

Returns this as a hexidecimal string.

no setter, inherited

hue → num

The hue value of this color.

final, inherited

inverted → HslColor

Adjusts this colors hue by 180 degrees while inverting the saturation and lightness values.

no setter

isBlack → bool

Returns true if this color is pure black.

no setter, inherited

isMonochromatic → bool

Returns true if this color is monochromatic.

no setter, inherited

isWhite → bool

Returns true if this color is pure white.

no setter, inherited

lightness → num

The lightness value of this color.

final, inherited

opacity → double

The alpha value as a double normalized to a 0.0 to 1.0 range.

no setter, inherited

opposite → HslColor

Returns the color with the hue opposite of this colors'.

no setter

r → double

The red channel of this color.

final, inherited

red → int

The red value of this color.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

saturation → num

The saturation value of this color.

final, inherited

value → int

A 32 bit value representing this color.

no setter, override

Methods

castTo(ColorModel other) → ColorModel

Converts this color to other's color space.

inherited

computeLuminance() → double

Returns a brightness value between 0 for darkest and 1 for lightest.

inherited

convert(ColorModel other) → HslColor

Converts other to this color's color space.

cooler(num amount, {bool relative = true}) → HslColor

Adjusts the hue of this color by amount towards 270 degrees, capping the value at 270.

copyWith({num? hue, num? saturation, num? lightness, int? alpha}) → HslColor

Returns a copy of this color modified with the provided values.

distanceTo(ColorModel color) → double

Returns the distance between this color's hue and color's hue in degrees.

inherited

equals(ColorModel color) → bool

Compares colors in the RGB color space.

inherited

interpolate(Color end, double step) → Color

Available on Color, provided by the LerpToColor extension

Interpolates to the defined step between this color and end.

interpolate(ColorModel end, double step) → HslColor

Interpolates to step between this and end.

lerpTo(ColorModel color, int steps, {ColorSpace? colorSpace, bool excludeOriginalColors = false}) → List<HslColor>

Returns the interpolated steps between this color and color.

lerpTo(Color color, int steps, {ColorSpace? colorSpace, bool excludeOriginalColors = false}) → List<Color>

Available on Color, provided by the LerpToColor extension

Returns the interpolated steps between this color and color.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

rotateHue(num amount) → HslColor

Rotates the hue of this color by amount in degrees.

rotateHueRad(double amount) → HslColor

Rotates the hue of this color by amount in radians.

toARGB32() → int

Returns a 32-bit value representing this color.

inherited

toCmykColor() → CmykColor

Available on Color, provided by the ToColorModel extension

Returns this color as a CmykColor.

toCmykColor() → CmykColor

Converts this to the CMYK color space.

inherited

toColor() → Color

Available on ColorModel, provided by the ToColor extension

Returns this as a Color, converting the color to RGB if necessary.

toColorModel() → ColorModel

Available on Color, provided by the ToColorModel extension

If this is a ColorModel, return this, otherwise construct a new RgbColor from this Color.

toFactoredList() → List<double>

Returns a fixed-length list containing the hue, saturation, and lightness values factored to be on 0 to 1 scale.

inherited

toFactoredListWithAlpha() → List<double>

Returns a fixed-length list containing the hue, saturation, lightness, and alpha values factored to be on 0 to 1 scale.

inherited

toHsbColor() → HsbColor

Converts this to the HSV color space.

inherited

toHsbColor() → HsbColor

Available on Color, provided by the ToColorModel extension

Returns this color as a HsbColor.

toHsiColor() → HsiColor

Converts this to the HSI color space.

inherited

toHsiColor() → HsiColor

Available on Color, provided by the ToColorModel extension

Returns this color as a HsiColor.

toHslColor() → HslColor

Converts this to the HSL color space.

toHslColor() → HslColor

Available on Color, provided by the ToColorModel extension

Returns this color as a HslColor.

toHspColor() → HspColor

Converts this to the HSP color space.

inherited

toHspColor() → HspColor

Available on Color, provided by the ToColorModel extension

Returns this color as a HspColor.

toLabColor() → LabColor

Converts this to the LAB color space.

inherited

toLabColor() → LabColor

Available on Color, provided by the ToColorModel extension

Returns this color as a LabColor.

toList() → List<num>

Returns a fixed-length list containing the hue, saturation, and lightness values, in that order.

inherited

toListWithAlpha() → List<num>

Returns a fixed-length list containing the hue, saturation, lightness, and alpha values, in that order.

inherited

toOklabColor() → OklabColor

Converts this to the Oklab color space.

inherited

toOklabColor() → OklabColor

Available on Color, provided by the ToColorModel extension

Returns this color as an OklabColor.

toRgbColor() → RgbColor

Converts this to the RGB color space.

inherited

toRgbColor() → RgbColor

Available on Color, provided by the ToColorModel extension

Returns this color as a RgbColor.

toString() → String

A string representation of this object.

inherited

toXyzColor() → XyzColor

Converts this to the XYZ color space.

inherited

toXyzColor() → XyzColor

Available on Color, provided by the ToColorModel extension

Returns this color as a XyzColor.

warmer(num amount, {bool relative = true}) → HslColor

Adjusts the hue of this color by amount towards 90 degrees, capping the value at 90.

withAlpha(int alpha) → HslColor

Returns this HslColor modified with the provided alpha value.

withBlue(num blue) → HslColor

Returns a new color that matches this color with the blue channel replaced with b (which ranges from 0 to 255).

override

withChroma(double chroma) → HslColor

Converts this color to the Oklab color space, calculates and applies a new lightness value from the proivded chroma value, and converts it back to the original color space.

withGreen(num green) → HslColor

Returns a new color that matches this color with the green channel replaced with g (which ranges from 0 to 255).

override

withHue(num hue) → HslColor

Returns this HslColor modified with the provided hue value.

withOpacity(double opacity) → HslColor

Returns this ColorModel with the provided opacity value.

withRed(num red) → HslColor

Returns a new color that matches this color with the red channel replaced with r (which ranges from 0 to 255).

override

withValues(List<num> values) → HslColor

Returns a color in this color's color space with the values provided.

Operators

operator ==(Object other) → bool

The equality operator.

inherited