Class: ColorKit

Constructors

new ColorKit()

new ColorKit(color): ColorKit

Parameters

Parameter	Type
`color`	`undefined` \| `string` \| `Color` \| `ColorKit`

Returns

ColorKit

Defined in

submodules/univer/packages/core/src/shared/color/color-kit.ts:236 (opens in a new tab)

Accessors

isValid

get isValid(): boolean

Returns

boolean

Defined in

submodules/univer/packages/core/src/shared/color/color-kit.ts:271 (opens in a new tab)

Methods

darken()

darken(amount): ColorKit

Parameters

Parameter	Type	Default value
`amount`	`number`	`10`

Returns

ColorKit

Defined in

submodules/univer/packages/core/src/shared/color/color-kit.ts:340 (opens in a new tab)

getAlpha()

getAlpha(): number

Returns

number

Defined in

submodules/univer/packages/core/src/shared/color/color-kit.ts:374 (opens in a new tab)

getBrightness()

getBrightness(): number

Returns

number

Defined in

submodules/univer/packages/core/src/shared/color/color-kit.ts:368 (opens in a new tab)

getLuminance()

getLuminance(): number

Returns

number

Defined in

submodules/univer/packages/core/src/shared/color/color-kit.ts:354 (opens in a new tab)

isDark()

isDark(): boolean

Returns

boolean

Defined in

submodules/univer/packages/core/src/shared/color/color-kit.ts:378 (opens in a new tab)

isLight()

isLight(): boolean

Returns

boolean

Defined in

submodules/univer/packages/core/src/shared/color/color-kit.ts:382 (opens in a new tab)

lighten()

lighten(amount): ColorKit

Parameters

Parameter	Type	Default value
`amount`	`number`	`10`

Returns

ColorKit

Defined in

submodules/univer/packages/core/src/shared/color/color-kit.ts:330 (opens in a new tab)

setAlpha()

setAlpha(value): ColorKit

Parameters

Parameter	Type
`value`	`number`

Returns

ColorKit

Defined in

submodules/univer/packages/core/src/shared/color/color-kit.ts:350 (opens in a new tab)

toHexString()

toHexString(allowShort?): string

Parameters

Parameter	Type
`allowShort`?	`boolean`

Returns

string

Defined in

submodules/univer/packages/core/src/shared/color/color-kit.ts:291 (opens in a new tab)

toHsl()

toHsl(): IHslColor

Returns

IHslColor

Defined in

submodules/univer/packages/core/src/shared/color/color-kit.ts:326 (opens in a new tab)

toHsv()

toHsv(): IHsvColor

Returns

IHsvColor

Defined in

submodules/univer/packages/core/src/shared/color/color-kit.ts:322 (opens in a new tab)

toRgb()

toRgb(): IRgbColor

Returns

IRgbColor

Defined in

submodules/univer/packages/core/src/shared/color/color-kit.ts:275 (opens in a new tab)

toRgbString()

toRgbString(): string

Returns

string

Defined in

submodules/univer/packages/core/src/shared/color/color-kit.ts:279 (opens in a new tab)

toString()

toString(): string

Returns

string

Defined in

submodules/univer/packages/core/src/shared/color/color-kit.ts:287 (opens in a new tab)

getContrastRatio()

static getContrastRatio(foreground, background): number

Parameters

Parameter	Type
`foreground`	`string` \| `Color` \| `ColorKit`
`background`	`string` \| `Color` \| `ColorKit`

Returns

number

Defined in

submodules/univer/packages/core/src/shared/color/color-kit.ts:228 (opens in a new tab)

mix()

static mix(
   color1, 
   color2, 
   amount): ColorKit

Parameters

Parameter	Type
`color1`	`string` \| `Color` \| `ColorKit`
`color2`	`string` \| `Color` \| `ColorKit`
`amount`	`number`

Returns

ColorKit

Defined in

submodules/univer/packages/core/src/shared/color/color-kit.ts:204 (opens in a new tab)

Colorbuilder Commandservice