Класс Color

Класс для работы с цветами.

Индекс

Конструкторы

Свойства

colors options convertHexToHsl convertHexToRgb convertHslToHex convertHslToRgb convertRgbToHex convertRgbToHsl isValidHex isValidHsl isValidRgb overlapColors

Методы

computeHex computeHsl hex hsl isDark isLight luminance rgb computeLuminance computeOpaqueColorLuminance convertUnknownToRgb create generateRandomColor

Конструкторы

`Protected`constructor

new Color(
color: RGBA,
options: PrecisionOptions,
): Universe.Platform.UtilColor.Color
Параметры
- color: RGBA
- options: PrecisionOptions
Возвращает Universe.Platform.UtilColor.Color

Свойства

`Protected`colors

colors: { hex: `#${string}` | null; hsl: Required<HSL> | null; rgb: RGBA }

`Protected`options

options: PrecisionOptions

`Static`convertHexToHsl

convertHexToHsl: (
color: `#${string}`,
options?: PrecisionOptions & AlphaPrecisionOptions,
) => Required<HSL>

Преобразует цвет из формата HEX в HSL.

Объявление типа

- (
  color: `#${string}`,
  options?: PrecisionOptions & AlphaPrecisionOptions,
  ): Required<HSL>
- Параметры
  - color: `#${string}`
    Цвет в формате HEX.
  - Optionaloptions: PrecisionOptions & AlphaPrecisionOptions
    Параметры точности и альфа-канала.
  Возвращает Required<HSL>

`Static`convertHexToRgb

convertHexToRgb: ConvertHexToRgb

Преобразует цвет из формата HEX в RGB.

`Static`convertHslToHex

convertHslToHex: (color: HSL) => `#${string}`

Преобразует цвет из формата HSL в HEX.

Объявление типа

- (color: HSL): `#${string}`
- Параметры
  - color: HSL
    Цвет в формате HSL.
  Возвращает `#${string}`

`Static`convertHslToRgb

convertHslToRgb: ConvertHslToRgb

Преобразует цвет из формата HSL в RGB.

`Static`convertRgbToHex

convertRgbToHex: ConvertRgbToHex

Преобразует цвет из формата RGB в HEX.

`Static`convertRgbToHsl

convertRgbToHsl: ConvertRgbToHsl

Преобразует цвет из формата RGB в HSL.

`Static`isValidHex

isValidHex: (color: unknown) => color is `#${string}`

Проверяет, является ли значение корректным HEX-цветом.

`Static`isValidHsl

isValidHsl: (color: unknown) => color is HSL

Проверяет, является ли значение корректным HSL-цветом.

`Static`isValidRgb

isValidRgb: (color: unknown) => color is RGB

Проверяет, является ли значение корректным RGB-цветом.

`Static`overlapColors

overlapColors: OverlapColors

Накладывает один цвет на другой.

Методы

`Protected`computeHex

computeHex(): `#${string}`
Возвращает `#${string}`

`Protected`computeHsl

computeHsl(): Required<HSL>
Возвращает Required<HSL>

hex

hex(): `#${string}`
Возвращает цвет в формате HEX (выполняет вычисление при первом вызове).

Возвращает `#${string}`

hsl

hsl(): Required<HSL>
Возвращает цвет в формате HSL (выполняет вычисление при первом вызове).

Возвращает Required<HSL>

isDark

isDark(options?: LuminanceOptions): boolean
Определяет, является ли цвет темным.
Параметры
- Optionaloptions: LuminanceOptions
  Параметры яркости.
Возвращает boolean

isLight

isLight(options?: LuminanceOptions): boolean
Определяет, является ли цвет светлым.
Параметры
- Optionaloptions: LuminanceOptions
  Параметры яркости.
Возвращает boolean

luminance

luminance(options?: LuminanceOptions): number
Рассчитывает яркость текущего цвета.
Параметры
- Optionaloptions: LuminanceOptions
  Параметры яркости.
Возвращает number

rgb

rgb(): { a: number; b: number; g: number; r: number }
Возвращает цвет в формате RGB.

Возвращает { a: number; b: number; g: number; r: number }

`Static`computeLuminance

computeLuminance(color: RGB, options?: LuminanceOptions): number
Вычисляет яркость цвета с учетом альфа-канала при необходимости.
Параметры
- color: RGB
  Цвет в формате RGB.
- Optionaloptions: LuminanceOptions
  Параметры яркости.
Возвращает number

`Protected` `Static`computeOpaqueColorLuminance

computeOpaqueColorLuminance(color: RGB): number
Параметры
- color: RGB
Возвращает number

`Static`convertUnknownToRgb

convertUnknownToRgb(
color: unknown,
options?: PrecisionOptions & AlphaPrecisionOptions,
): Required<RGB> | null
Преобразует неизвестный цвет в RGB.
Параметры
- color: unknown
  Исходный цвет.
- Optionaloptions: PrecisionOptions & AlphaPrecisionOptions
  Параметры точности и альфа-канала.
Возвращает Required<RGB> | null

`Static`create

create(
color: unknown,
options?: PrecisionOptions & AlphaPrecisionOptions,
): Universe.Platform.UtilColor.Color | null
Создает экземпляр класса Color на основании переданного цвета.
Параметры
- color: unknown
  Исходный цвет.
- Optionaloptions: PrecisionOptions & AlphaPrecisionOptions
  Параметры точности и альфа-канала.
Возвращает Universe.Platform.UtilColor.Color | null

`Static`generateRandomColor

generateRandomColor(
randomizeAlpha?: boolean,
): Universe.Platform.UtilColor.Color | null
Генерирует рандомный цвет
Параметры
- OptionalrandomizeAlpha: boolean
  должен ли быть задействован альфа-канал
Возвращает Universe.Platform.UtilColor.Color | null

Класс Color

Индекс

Конструкторы

Свойства

Методы

Конструкторы

Protectedconstructor

Параметры

Возвращает Universe.Platform.UtilColor.Color

Свойства

Protectedcolors

Protectedoptions

StaticconvertHexToHsl

Объявление типа

Параметры

Возвращает Required<HSL>

StaticconvertHexToRgb

StaticconvertHslToHex

Объявление типа

Параметры

Возвращает `#${string}`

StaticconvertHslToRgb

StaticconvertRgbToHex

StaticconvertRgbToHsl

StaticisValidHex

StaticisValidHsl

StaticisValidRgb

StaticoverlapColors

Методы

ProtectedcomputeHex

Возвращает `#${string}`

ProtectedcomputeHsl

Возвращает Required<HSL>

hex

Возвращает `#${string}`

hsl

Возвращает Required<HSL>

isDark

Параметры

Возвращает boolean

isLight

Параметры

Возвращает boolean

luminance

Параметры

Возвращает number

rgb

Возвращает { a: number; b: number; g: number; r: number }

StaticcomputeLuminance

Параметры

Возвращает number

Protected StaticcomputeOpaqueColorLuminance

Параметры

Возвращает number

StaticconvertUnknownToRgb

Параметры

Возвращает Required<RGB> | null

Staticcreate

Параметры

Возвращает Universe.Platform.UtilColor.Color | null

StaticgenerateRandomColor

Параметры

Возвращает Universe.Platform.UtilColor.Color | null

Настройки

На этой странице

`Protected`constructor

`Protected`colors

`Protected`options

`Static`convertHexToHsl

`Static`convertHexToRgb

`Static`convertHslToHex

`Static`convertHslToRgb

`Static`convertRgbToHex

`Static`convertRgbToHsl

`Static`isValidHex

`Static`isValidHsl

`Static`isValidRgb

`Static`overlapColors

`Protected`computeHex

`Protected`computeHsl

`Static`computeLuminance

`Protected` `Static`computeOpaqueColorLuminance

`Static`convertUnknownToRgb

`Static`create

`Static`generateRandomColor