Class Color

Capabilities for working with colors.

Advanced color customization and compatibility with CSS and Office color schemes.

Key features include:

Accessing a collection of built-in colors (Named, Scheme, Index).
Creating customized colors with color adjustments.
Defining and and converting between different color models (RGB, HEX, HSL).

See

Implements

IColor

Index

Constructors

Accessors

[toStringTag] isIColor

Methods

adjust getAdjustments getType getVal isEqual toBlackOrWhite toCSS toHex toHSLA toRGBA toString getDefaultSchemeLookup

Constructors

constructor

new Color(
    value: string | IColor | IColor.Definition,
    schemeLookup?: SchemeLookup,
    indexedLookup?: IndexedLookup,
    last?: RGBA,
): Color
Parameters
- value: string | IColor | IColor.Definition
- OptionalschemeLookup: SchemeLookup
- OptionalindexedLookup: IndexedLookup
- last: RGBA = null
Returns Color

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns string

isIColor

get isIColor(): true
For runtime type checking.

Returns true
Implementation of IColor.isIColor

Methods

adjust

adjust(adjustments: Adjustment[]): IColor
Returns a new color that is derived from this color with the adjustments applied.
Parameters
- adjustments: Adjustment[]
  An array of Adjustments
Returns IColor
Implementation of IColor.adjust

getAdjustments

getAdjustments(): readonly Adjustment[]
Return the color adjustments.

Returns readonly Adjustment[]
Implementation of IColor.getAdjustments

getType

getType(): IColor.Type
Return the type of color value used (e.g., scheme, named, index, hsl, rgb, hex).

Returns IColor.Type
Implementation of IColor.getType

getVal

getVal(): string
The base value for the color before adjustments.

Returns string
Implementation of IColor.getVal

isEqual

isEqual(other: any): boolean
Returns true if the other color will resolve to the same rgb values as this color.
Parameters
- other: any
  The other color to compare.
Returns boolean
Implementation of IColor.isEqual

toBlackOrWhite

toBlackOrWhite(darkMode?: boolean, threshold?: number): IColor
Returns the color as either 'black or white' depending on the luminance.
Parameters
- darkMode: boolean = false
- threshold: number = 157
  The threshold to determine if the color is dark or light.
Returns IColor
Implementation of IColor.toBlackOrWhite

toCSS

toCSS(darkMode?: boolean, alpha?: boolean): string
Return a string usable with CSS color properties.
Parameters
- darkMode: boolean = false
  If true dark colors will be used.
- alpha: boolean = true
  If true alpha will be applied.
Returns string
Implementation of IColor.toCSS

toHex

toHex(darkMode?: boolean): HEX
Return a HEX with adjustments applied.
Parameters
- darkMode: boolean = false
Returns HEX
Implementation of IColor.toHex

toHSLA

toHSLA(darkMode?: boolean): HSLA
Return as HSLA with adjustments applied.
Parameters
- darkMode: boolean = false
Returns HSLA
Implementation of IColor.toHSLA

toRGBA

toRGBA(darkMode?: boolean): RGBA
Return as RGBA with adjustments applied.
Parameters
- darkMode: boolean = false
Returns RGBA
Implementation of IColor.toRGBA

toString

toString(): string
Return the color as a string.

Returns string
Remarks
Implementation of IColor.toString

`Static`getDefaultSchemeLookup

getDefaultSchemeLookup(): SchemeLookup
Returns the default color scheme lookup that Colors will use if none is provided.

Returns SchemeLookup