Class Color

A mutable type representing a color through its RGB components.

Hierarchy

Coords
- Color

Index

Constructors

Properties

black blue blueviolet chartreuse cobalt cyan gray green hotpink lime magenta red slateblue springgreen teal white yellow

Accessors

b blue coords g green length luminance modified r red

Constructors

constructor

new Color(r, g, b): Color
Parameters
- r: number
- g: number
- b: number
Returns Color
Overrides Coords.constructor
- Defined in src/lib/core/Color.ts:120

Properties

`Static`black

black: Color

`Static`blue

blue: Color

`Static`blueviolet

blueviolet: Color

`Static`chartreuse

chartreuse: Color

`Static`cobalt

cobalt: Color

`Static`cyan

cyan: Color

`Static`gray

gray: Color

`Static`green

green: Color

`Static`hotpink

hotpink: Color

`Static`lime

lime: Color

`Static`magenta

magenta: Color

`Static`red

red: Color

`Static`slateblue

slateblue: Color

`Static`springgreen

springgreen: Color

`Static`teal

teal: Color

`Static`white

white: Color

`Static`yellow

yellow: Color

Accessors

b

get b(): number
The blue coordinate (component) of this color. The value is clamped to the range [0,1].

Returns number
- Defined in src/lib/core/Color.ts:183
set b(b): void
Parameters
- b: number
Returns void
- Defined in src/lib/core/Color.ts:186

blue

get blue(): number
Returns number
- Defined in src/lib/core/Color.ts:192
set blue(blue): void
Parameters
- blue: number
Returns void
- Defined in src/lib/core/Color.ts:195

coords

get coords(): T[]
Returns T[]
Inherited from Coords.coords
- Defined in src/lib/math/VectorN.ts:99
set coords(data): void
Parameters
- data: T[]
Returns void
Inherited from Coords.coords
- Defined in src/lib/math/VectorN.ts:102

g

get g(): number
The green coordinate (component) of this color. The value is clamped to the range [0,1].

Returns number
- Defined in src/lib/core/Color.ts:160
set g(g): void
Parameters
- g: number
Returns void
- Defined in src/lib/core/Color.ts:163

green

get green(): number
Returns number
- Defined in src/lib/core/Color.ts:169
set green(green): void
Parameters
- green: number
Returns void
- Defined in src/lib/core/Color.ts:172

length

get length(): number
Returns number
Inherited from Coords.length
- Defined in src/lib/math/VectorN.ts:120

luminance

get luminance(): number
Computes the luminance of this color.

Returns number
- Defined in src/lib/core/Color.ts:265

modified

get modified(): boolean
Returns boolean
Inherited from Coords.modified
- Defined in src/lib/math/VectorN.ts:110
set modified(modified): void
Parameters
- modified: boolean
Returns void
Inherited from Coords.modified
- Defined in src/lib/math/VectorN.ts:113

r

get r(): number
The red coordinate (component) of this color. The value is clamped to the range [0,1].

Returns number
- Defined in src/lib/core/Color.ts:137
set r(r): void
Parameters
- r: number
Returns void
- Defined in src/lib/core/Color.ts:140

red

get red(): number
Returns number
- Defined in src/lib/core/Color.ts:146
set red(red): void
Parameters
- red: number
Returns void
- Defined in src/lib/core/Color.ts:149

Methods

approx

approx(n): Color
Returns a color in which any rgb component whose absolute value is less than pow(10, -n) times the absolute value of the largest coordinate is zero.
Parameters
- n: number
  The exponent used to determine which components are set to zero.
Returns Color
approx(this)
Overrides Coords.approx
- Defined in src/lib/core/Color.ts:207

clone

clone(): Color
Returns Color
a mutable instance of this color.
Overrides Coords.clone
- Defined in src/lib/core/Color.ts:219

copy

copy(color): this
Copies the specified color into this Color instance.
Parameters
- color: {
      b: number;
      g: number;
      r: number;
  }
  The color to be copied.
  - b: number
  - g: number
  - r: number
Returns this
- Defined in src/lib/core/Color.ts:228

equals

equals(other): boolean
Parameters
- other: any
Returns boolean
Inherited from Coords.equals
- Defined in src/lib/math/Coords.ts:37

getComponent

getComponent(index): number
Parameters
- index: number
Returns number
Inherited from Coords.getComponent
- Defined in src/lib/math/VectorN.ts:134

isLocked

isLocked(): boolean
Determines whether this Lockable is locked. If the Lockable is in the unlocked state then it is mutable. If the Lockable is in the locked state then it is immutable.

Returns boolean
Inherited from Coords.isLocked
- Defined in src/lib/math/VectorN.ts:84

lerp

lerp(target, α): Color
Linearly interpolates from this color to the specified color.
Parameters
- target: {
      b: number;
      g: number;
      r: number;
  }
  The color returned when α = 1.
  - b: number
  - g: number
  - r: number
- α: number
  The parameter that determines the composition of the color.
Returns Color
this + (target - this) * α
- Defined in src/lib/core/Color.ts:251

lock

lock(): number
Locks this Lockable (preventing any further mutation), and returns a token that may be used to unlock it.

Returns number
Inherited from Coords.lock
- Defined in src/lib/math/VectorN.ts:88

pop

pop(): number
Returns number
Inherited from Coords.pop
- Defined in src/lib/math/VectorN.ts:141

push

push(value): number
Parameters
- value: number
Returns number
Inherited from Coords.push
- Defined in src/lib/math/VectorN.ts:156

scale

scale(α): Color
Parameters
- α: number
Returns Color
- Defined in src/lib/core/Color.ts:272

setComponent

setComponent(index, value): void
Parameters
- index: number
- value: number
Returns void
Inherited from Coords.setComponent
- Defined in src/lib/math/VectorN.ts:174

toArray

toArray(array?, offset?): number[]
Parameters
- array: number[] = []
- offset: number = 0
Returns number[]
Inherited from Coords.toArray
- Defined in src/lib/math/VectorN.ts:192

toExponential

toExponential(fractionDigits?): string
Parameters
- OptionalfractionDigits: number
Returns string
- Defined in src/lib/core/Color.ts:284

toFixed

toFixed(fractionDigits?): string
Parameters
- OptionalfractionDigits: number
Returns string
- Defined in src/lib/core/Color.ts:289

toLocaleString

toLocaleString(): string
Returns string
Inherited from Coords.toLocaleString
- Defined in src/lib/math/VectorN.ts:204

toPrecision

toPrecision(precision?): string
Parameters
- Optionalprecision: number
Returns string
- Defined in src/lib/core/Color.ts:294

toString

toString(radix?): string
Parameters
- Optionalradix: number
Returns string
A string representation of this color.
Overrides Coords.toString
- Defined in src/lib/core/Color.ts:301

unlock

unlock(token): void
Unlocks this Lockable (allowing mutation), using a token that was obtained from a preceding lock method call.
Parameters
- token: number
Returns void
Inherited from Coords.unlock
- Defined in src/lib/math/VectorN.ts:92

`Static`copy

copy(color): Color
Parameters
- color: {
      b: number;
      g: number;
      r: number;
  }
  The color to be copied.
  - b: number
  - g: number
  - r: number
Returns Color
A mutable copy of the specified color.
- Defined in src/lib/core/Color.ts:309

`Static`fromHSL

fromHSL(H, S, L): Color
Converts an angle, radius, height to a color on a color wheel.
Parameters
- H: number
- S: number
- L: number
Returns Color
- Defined in src/lib/core/Color.ts:350

`Static`fromRGB

fromRGB(r, g, b): Color
Constructs a new mutable instance of Color from the rgb components. The components are clamped to the range [0, 1].
Parameters
- r: number
  The red component.
- g: number
  The green component.
- b: number
  The blue component.
Returns Color
- Defined in src/lib/core/Color.ts:390

`Static`lerp

lerp(a, b, α): Color
Parameters
- a: {
      b: number;
      g: number;
      r: number;
  }
  - b: number
  - g: number
  - r: number
- b: {
      b: number;
      g: number;
      r: number;
  }
  - b: number
  - g: number
  - r: number
- α: number
Returns Color
- Defined in src/lib/core/Color.ts:407

`Static`luminance

luminance(r, g, b): number
Parameters
- r: number
- g: number
- b: number
Returns number
- Defined in src/lib/core/Color.ts:319

`Static`mustBe

mustBe(name, color): Color
Parameters
- name: string
- color: Color
Returns Color
- Defined in src/lib/core/Color.ts:411

`Static`random

random(): Color
Creates a color in which the red, green, and blue properties lie in the range [0, 1].

Returns Color
- Defined in src/lib/core/Color.ts:422