SassColor
Иерархия
-
Значение
- SassColor
Индекс
Конструкторы
Свойства доступа
Методы
Конструкторы
конструктор
-
новый SassColor(options: {
alpha?: null | number;
blue: null | number;
green: null | number;
red: null | number;
space?: "rgb";
}): SassColor -
Создаёт цвет RGB.
Если
spaceотсутствует, толькоundefinedдолжно использоваться для указания, чтоalphaне передано. Еслиnullиспользуется вместо этого, он будет обрабатываться как отсутствующий компонент. Смотрите изменения для получения подробностей.Если
spaceопределён, иnullпередано для любого компонента, он будет обработан как отсутствующий компонент.Выбрасывает
Error, еслиalphaзадано и не являетсяnullили числом между0и1.Параметры
-
options: {
alpha?: null | number;
blue: null | number;
green: null | number;
red: null | number;
space?: "rgb";
}-
Optionalalpha?: null | number -
blue: null | number
-
green: null | number
-
red: null | number
-
Optionalspace?: "rgb"
-
Возвращает SassColor
-
конструктор
-
новый SassColor(options: {
alpha?: null | number;
hue: null | number;
lightness: null | number;
saturation: null | number;
space?: "hsl";
}): SassColor -
Создаёт HSL цвет.
Если
spaceотсутствует, то **только**undefinedдолжно использоваться для указания, чтоalphaне передано. Если вместо этого используетсяnull, это будет рассматриваться как отсутствующий компонент. Подробности см. в изменениях.Если
spaceопределено, иnullпередано для любого компонента, это будет рассматриваться как отсутствующий компонент.Выбрасывает
Error, еслиalphaзадано и не являетсяnullили числом от0до1.Параметры
-
options: {
alpha?: null | number;
hue: null | number;
lightness: null | number;
saturation: null | number;
space?: "hsl";
}-
Optionalalpha?: null | number -
hue: null | number
-
lightness: null | number
-
saturation: null | number
-
Optionalspace?: "hsl"
-
Возвращает SassColor
-
конструктор
-
новый SassColor(options: {
alpha?: null | number;
blackness: null | number;
hue: null | number;
space?: "hwb";
whiteness: null | number;
}): SassColor -
Создаёт Цветовой цвет.
Если
spaceотсутствует, то толькоundefinedдолжно использоваться для указания того, чтоalphaне передано. Если используетсяnull, оно будет рассматриваться как отсутствующий компонент. См. изменения в работе для получения подробностей.Если
spaceопределено и для любого компонента переданоnull, то оно будет рассматриваться как отсутствующий компонент.Исключения
Error, еслиalphaустановлено и не являетсяnullили числом между0и1.Параметры
-
options: {
alpha?: null | number;
blackness: null | number;
hue: null | number;
space?: "hwb";
whiteness: null | number;
}-
Optionalalpha?: null | number -
blackness: null | number
-
hue: null | number
-
Optionalspace?: "hwb" -
whiteness: null | number
-
Возвращает SassColor
-
конструктор
-
новый SassColor(options: {
a: null | number;
alpha?: null | number;
b: null | number;
lightness: null | number;
space: ColorSpaceLab;
}): SassColor -
Создаёт цвет в формате Lab или Oklab.
Если для любого компонента передано
null, он будет интерпретирован как отсутствующий компонент.Возможные ошибки
Errorеслиalphaзадан и не являетсяnullили числом между0и1.Параметры
-
options: {
a: null | number;
alpha?: null | number;
b: null | number;
lightness: null | number;
space: ColorSpaceLab;
}-
a: null | number
-
Optionalalpha?: null | number -
b: null | number
-
lightness: null | number
-
space: ColorSpaceLab
-
Возвращает SassColor
-
конструктор
-
новый SassColor(options: {
alpha?: null | number;
chroma: null | number;
hue: null | number;
lightness: null | number;
space: ColorSpaceLch;
}): SassColor -
Создаёт цвет в формате LCH или Oklch.
Если для любого компонента передано значение
null, оно будет обработано как пропущенный компонент.Бросает исключение
Errorеслиalphaзадано и не являетсяnullили числом от0до1.Параметры
-
options: {
alpha?: null | number;
chroma: null | number;
hue: null | number;
lightness: null | number;
space: ColorSpaceLch;
}-
Optionalalpha?: null | number -
chroma: null | number
-
hue: null | number
-
lightness: null | number
-
space: ColorSpaceLch
-
Возвращает SassColor
-
конструктор
-
новый SassColor(options: {
alpha?: null | number;
blue: null | number;
green: null | number;
red: null | number;
space: "display-p3" | "srgb" | "rec2020" | "a98-rgb" | "prophoto-rgb" | "srgb-linear";
}): SassColor -
Создаёт цвет в заданном пространстве RGB цвета.
Если для любого компонента передано
null, оно будет обработано как пропущенный компонент.Возвращает
Error, еслиalphaзадано и не являетсяnullили числом от0до1.Параметры
-
options: {
alpha?: null | number;
blue: null | number;
green: null | number;
red: null | number;
space: "display-p3" | "srgb" | "rec2020" | "a98-rgb" | "prophoto-rgb" | "srgb-linear";
}-
Optionalalpha?: null | number -
blue: null | number
-
green: null | number
-
red: null | number
-
space: "display-p3" | "srgb" | "rec2020" | "a98-rgb" | "prophoto-rgb" | "srgb-linear"
-
Возвращает SassColor
-
конструктор
-
новый SassColor(options: {
alpha?: null | number;
space: ColorSpaceXyz;
x: null | number;
y: null | number;
z: null | number;
}): SassColor -
Создаёт цвет в предопределённом XYZ цветовом пространстве.
Если для любого компонента передано
null, оно будет обрабатываться как отсутствующий компонент.Возбуждает
Error, еслиalphaзадано и не являетсяnullили числом от0до1.Параметры
-
options: {
alpha?: null | number;
space: ColorSpaceXyz;
x: null | number;
y: null | number;
z: null | number;
}-
Optionalalpha?: null | number -
space: ColorSpaceXyz
-
x: null | number
-
y: null | number
-
z: null | number
-
Возвращает SassColor
-
Доступ к данным
alpha
- get alpha(): number
-
Альфа-канал этого цвета, значение от
0до1.Возвращает number
asList
blackness
- get blackness(): number
-
Возвращает number
blue
- get blue(): number
-
Возвращает number
channels
channelsOrNull
green
- get green(): number
-
Возвращает number
hasBrackets
- get hasBrackets(): boolean
-
Указывает, имеет ли это значение в виде списка квадратные скобки.
Все значения SassScript могут быть использованы как списки. Карты считаются списками пар, а все остальные значения — списками с одним элементом.
Возвращает boolean
hue
- get hue(): number
-
Возвращает number
isLegacy
- get isLegacy(): boolean
-
Логическое значение, указывающее, находится ли этот цвет в устаревшем цветовом пространстве (
rgb,hslилиhwb).Возвращает boolean
isTruthy
- get isTruthy(): boolean
-
Является ли значение истинным в операторе
trueи других контекстах.Возвращает boolean
lightness
- get lightness(): number
-
Возвращает number
realNull
red
- get red(): number
-
Красная составляющая этого цвета в цветовом пространстве RGB.
Устарело
Используйте channel вместо этого.
Возвращает number
saturation
- get saturation(): number
-
Возвращает number
separator
- get separator(): ListSeparator
-
Разделитель этого значения в виде списка.
Все значения SassScript могут использоваться в качестве списков. Карты считаются списками пар, а все остальные значения считаются списками с одним значением.
Возвращает ListSeparator
space
- get space(): KnownColorSpace
-
Имя цветового пространства этого цвета.
Возвращает KnownColorSpace
whiteness
- get whiteness(): number
-
Возвращает number
Методы
assertBoolean
- assertBoolean(name?: string): SassBoolean
-
Выбрасывает исключение, если
thisне является SassBoolean.Функции обычно должны использовать isTruthy вместо требования буквальной булевой переменной.
Параметры
-
Optionalname: stringИмя аргумента функции
this, из которого он был получен (без$), если он был получен из аргумента. Используется для вывода сообщений об ошибках.
Возвращает SassBoolean
-
assertCalculation
- assertCalculation(name?: string): SassCalculation
-
Выбрасывает исключение, если
thisне является SassCalculation.Параметры
-
Optionalname: stringИмя аргумента функции
this, из которого он был получен (без$), если он был получен из аргумента. Используется для вывода сообщений об ошибках.
Возвращает SassCalculation
-
assertColor
assertFunction
- assertFunction(name?: string): SassFunction
-
Выбрасывает исключение, если
thisне является SassFunction.Параметры
-
Optionalname: stringИмя аргумента функции
this, из которого он был получен (без$), если он был получен из аргумента. Используется для вывода сообщений об ошибках.
Возвращает SassFunction
-
assertMap
assertMixin
assertNumber
- assertNumber(name?: string): SassNumber
-
Выбрасывает исключение, если
thisне является SassNumber.Параметры
-
Optionalname: stringИмя аргумента функции
this, из которого он был получен (без$), если он был получен из аргумента. Используется для отладки ошибок.
Возвращает SassNumber
-
assertString
- assertString(name?: string): SassString
-
Выбрасывает исключение, если
thisне является SassString.Параметры
-
Optionalname: stringИмя аргумента функции
this, из которого он был получен (без$), если он был получен из аргумента. Используется для отладки ошибок.
Возвращает SassString
-
change
-
change(options: {
alpha: undefined | null | number;
hue: undefined | null | number;
lightness: undefined | null | number;
saturation: undefined | null | number;
} & {
space?: "hsl";
}): SassColor -
Возвращает новый цвет, являющийся результатом изменения одного или нескольких каналов HSL этого цвета.
Выбрасывает исключение
Error, еслиspaceотсутствует, и этот цвет не в пространстве цветов устаревшего формата (rgb,hslилиhwb).Выбрасывает исключение
Error, еслиalphaзадано, и оно не являетсяnullили числом от0до1.Параметры
-
options: {
alpha: undefined | null | number;
hue: undefined | null | number;
lightness: undefined | null | number;
saturation: undefined | null | number;
} & {
space?: "hsl";
}
Возвращает SassColor
-
change
-
change(options: {
alpha: undefined | null | number;
blackness: undefined | null | number;
hue: undefined | null | number;
whiteness: undefined | null | number;
} & {
space?: "hwb";
}): SassColor -
Возвращает новый цвет, являющийся результатом изменения одного или нескольких каналов HWB этого цвета.
Выбрасывает
Error, еслиspaceотсутствует, и этот цвет не находится в пространстве цветов старого формата (rgb,hslилиhwb).Выбрасывает
Error, еслиalphaзадано, и оно не равноnullили числу от0до1.Параметры
-
options: {
alpha: undefined | null | number;
blackness: undefined | null | number;
hue: undefined | null | number;
whiteness: undefined | null | number;
} & {
space?: "hwb";
}
Возвращает SassColor
-
change
-
change(options: {
a: undefined | null | number;
alpha: undefined | null | number;
b: undefined | null | number;
lightness: undefined | null | number;
} & {
space?: ColorSpaceLab;
}): SassColor -
Возвращает новый цвет, являющийся результатом изменения одного или нескольких каналов Lab этого цвета.
Выбрасывает
Error, еслиspaceотсутствует, и этот цвет не находится в пространстве цветов Lab или Oklab.Выбрасывает
Error, еслиalphaзадано, и оно не равноnullили числу от0до1.Параметры
-
options: {
a: undefined | null | number;
alpha: undefined | null | number;
b: undefined | null | number;
lightness: undefined | null | number;
} & {
space?: ColorSpaceLab;
}
Возвращает SassColor
-
change
-
change(options: {
alpha: undefined | null | number;
chroma: undefined | null | number;
hue: undefined | null | number;
lightness: undefined | null | number;
} & {
space?: ColorSpaceLch;
}): SassColor -
Возвращает новый цвет, являющийся результатом изменения одного или нескольких каналов LCH этого цвета.
Бросает исключение
Error, еслиspaceотсутствует, а этот цвет не находится в цветовых пространствах LCH или Oklch.Бросает исключение
Error, еслиalphaзадано и не являетсяnullили числом в диапазоне от0до1.Параметры
-
options: {
alpha: undefined | null | number;
chroma: undefined | null | number;
hue: undefined | null | number;
lightness: undefined | null | number;
} & {
space?: ColorSpaceLch;
}
Возвращает SassColor
-
change
-
change(options: {
alpha: undefined | null | number;
blue: undefined | null | number;
green: undefined | null | number;
red: undefined | null | number;
} & {
space?: ColorSpaceRgb;
}): SassColor -
Возвращает новый цвет, являющийся результатом изменения одного или нескольких каналов RGB этого цвета.
Бросает исключение
Error, еслиspaceотсутствует, а этот цвет не находится в устаревшем цветовом пространстве (rgb,hslилиhwb).Бросает исключение
Error, еслиalphaзадано и не являетсяnullили числом в диапазоне от0до1.Параметры
-
options: {
alpha: undefined | null | number;
blue: undefined | null | number;
green: undefined | null | number;
red: undefined | null | number;
} & {
space?: ColorSpaceRgb;
}
Возвращает SassColor
-
изменить
-
изменить(options: {
alpha: undefined | null | number;
x: undefined | null | number;
y: undefined | null | number;
z: undefined | null | number;
} & {
space?: ColorSpaceXyz;
}): SassColor -
Возвращает новый цвет, являющийся результатом изменения одного или нескольких каналов XYZ этого цвета.
Бросает
Error, еслиspaceотсутствует, а этот цвет не в цветовом пространстве XYZ.Бросает
Error, еслиalphaзадано и не являетсяnullили числом между0и1.Параметры
-
options: {
alpha: undefined | null | number;
x: undefined | null | number;
y: undefined | null | number;
z: undefined | null | number;
} & {
space?: ColorSpaceXyz;
}
Возвращает SassColor
-
канал
- канал(channel: ChannelName): number
-
Возвращает значение одного указанного
channelэтого цвета, с пропускаемыми каналами, преобразованными в0.Бросает
Error, еслиchannelнеalphaили канал в пространстве этого цвета.Параметры
-
channel: ChannelName
Возвращает number
-
канал
-
канал(channel: ChannelNameHsl, options: {
space: "hsl";
}): number -
Возвращает значение одного указанного
channelэтого цвета после преобразования этого цвета в указанноеspace, с пропускаемыми каналами, преобразованными в0.Бросает
Error, еслиchannelнеalphaили канал вspace.Параметры
-
channel: ChannelNameHsl
-
options: {
space: "hsl";
}-
space: "hsl"
-
Возвращает number
-
channel
-
channel(channel: ChannelNameHwb, options: {
space: "hwb";
}): number -
Параметры
-
channel: ChannelNameHwb
-
options: {
space: "hwb";
}-
space: "hwb"
-
Возвращает number
-
channel
-
channel(channel: ChannelNameLab, options: {
space: ColorSpaceLab;
}): number -
Параметры
-
channel: ChannelNameLab
-
options: {
space: ColorSpaceLab;
}-
space: ColorSpaceLab
-
Возвращает number
-
channel
-
channel(channel: ChannelNameLch, options: {
space: ColorSpaceLch;
}): number -
Параметры
-
channel: ChannelNameLch
-
options: {
space: ColorSpaceLch;
}-
space: ColorSpaceLch
-
Возвращает number
-
channel
-
channel(channel: ChannelNameRgb, options: {
space: ColorSpaceRgb;
}): number -
Параметры
-
channel: ChannelNameRgb
-
options: {
space: ColorSpaceRgb;
}-
space: ColorSpaceRgb
-
Возвращает number
-
channel
-
channel(channel: ChannelNameXyz, options: {
space: ColorSpaceXyz;
}): number -
Параметры
-
channel: ChannelNameXyz
-
options: {
space: ColorSpaceXyz;
}-
space: ColorSpaceXyz
-
Возвращает number
-
equals
get
- get(index: number): undefined | Value
-
Возвращает значение по индексу
indexв этом значении как список илиundefined, еслиindexнедействителен для этого списка.Все значения SassScript могут использоваться в качестве списков. Карты считаются списками пар, а все другие значения считаются одноэлементными списками.
Это сокращенная запись для
this.asList.get(index), хотя в некоторых случаях она может быть более эффективной.Этот метод использует те же соглашения об индексации, что и пакет
immutable: в отличие от Sass, индекс первого элемента равен 0, но, как и в Sass, отрицательные числа индексируют с конца списка.Параметры
-
index: number
Возвращает undefined | Value
-
hashCode
- hashCode(): number
-
Возвращает хэш-код, который можно использовать для хранения
thisв хэш-таблице.Возвращает number
interpolate
-
interpolate(color2: SassColor, options?: {
method?: HueInterpolationMethod;
weight?: number;
}): SassColor -
Возвращает цвет, находящийся между этим цветом и
color2согласноmethod, как определено в процедуре интерполяции цвета CSS Color 4 color interpolation.Если
methodотсутствует, а этот цвет находится в прямоугольной цветовой системе (Lab, Oklab, RGB и XYZ),methodпо умолчанию принимает цветовую систему этого цвета. В противном случае,methodпо умолчанию принимает список, разделенный пробелами, содержащий цветовую систему этого цвета и строку "shorter".weight— это число от 0 до 1, которое указывает, насколько этот цвет должен присутствовать в результирующем цвете. Если он опущен, он по умолчанию равен 0,5.Параметры
-
color2: SassColor
-
Параметры options: {
method?: HueInterpolationMethod;
weight?: number;
}-
Метод method?: HueInterpolationMethod
-
Весовой коэффициент weight?: number
-
Возвращает SassColor
-
isChannelMissing
- isChannelMissing(channel: ChannelName): boolean
-
Возвращает логическое значение, указывающее, является ли заданное значение канала отсутствующим каналом.
Параметры
-
channel: ChannelName
Возвращает boolean
-
isChannelPowerless
- isChannelPowerless(channel: ChannelName): boolean
-
Возвращает логическое значение, указывающее, является ли заданный
channelбессильным в этом цвете. Это специальное состояние, определенное для отдельных цветовых пространств, которое указывает, что значение канала не повлияет на отображение цвета.Параметры
-
channel: ChannelName
Возвращает boolean
-
isChannelPowerless
-
isChannelPowerless(channel: ChannelNameHsl, options?: {
space: "hsl";
}): boolean -
Параметры
-
channel: ChannelNameHsl
-
Optionaloptions: {
space: "hsl";
}-
space: "hsl"
-
Возвращает boolean
-
isChannelPowerless
-
isChannelPowerless(channel: ChannelNameHwb, options?: {
space: "hwb";
}): boolean -
Параметры
-
channel: ChannelNameHwb
-
Optionaloptions: {
space: "hwb";
}-
space: "hwb"
-
Возвращает boolean
-
isChannelPowerless
-
isChannelPowerless(channel: ChannelNameLab, options?: {
space: ColorSpaceLab;
}): boolean -
Параметры
-
channel: ChannelNameLab
-
Optionaloptions: {
space: ColorSpaceLab;
}-
space: ColorSpaceLab
-
Возвращает boolean
-
isChannelPowerless
-
isChannelPowerless(channel: ChannelNameLch, options?: {
space: ColorSpaceLch;
}): boolean -
Параметры
-
channel: ChannelNameLch
-
Optionaloptions: {
space: ColorSpaceLch;
}-
space: ColorSpaceLch
-
Возвращает boolean
-
isChannelPowerless
-
isChannelPowerless(channel: ChannelNameRgb, options?: {
space: ColorSpaceRgb;
}): boolean -
Параметры
-
channel: ChannelNameRgb
-
Optionaloptions: {
space: ColorSpaceRgb;
}-
space: ColorSpaceRgb
-
Возвращает boolean
-
isChannelPowerless
-
isChannelPowerless(channel: ChannelNameXyz, options?: {
space: ColorSpaceXyz;
}): boolean -
Параметры
-
channel: ChannelNameXyz
-
Optionaloptions: {
space: ColorSpaceXyz;
}-
space: ColorSpaceXyz
-
Возвращает boolean
-
isInGamut
- isInGamut(space?: KnownColorSpace): boolean
-
Возвращает булево значение, указывающее, находится ли данный цвет в гамме (в отличие от наличия одного или нескольких каналов вне границ) для указанного
spaceили текущей цветовой модели, еслиspaceне указано.Параметры
-
Optionalspace: KnownColorSpace
Возвращает boolean
-
sassIndexToListIndex
- sassIndexToListIndex(sassIndex: Value, name?: string): number
-
Преобразует
sassIndexв индекс в стиле JavaScript для списка, возвращаемого asList.Индексы Sass имеют базу 1, а индексы JavaScript — базу 0. Индексы Sass также могут быть отрицательными для индексирования с конца списка.
Возбуждает
ErrorЕслиsassIndexне число, если это число не целое или если это целое не является допустимым индексом для asList.Параметры
-
sassIndex: Value
Индекс в стиле Sass для этого как список.
-
Optionalname: stringИмя аргумента функции
sassIndex(без$), если он пришел из аргумента. Используется для отладки ошибок.
Возвращает number
-
toGamut
-
toGamut(options: {
method: GamutMapMethod;
space?: KnownColorSpace;
}): SassColor -
Возвращает копию этого цвета, изменённую так, что он находится в гамме для указанного
space— или текущей цветовой модели, еслиspaceне указано — с помощьюmethodдля отображения цветов вне гаммы в требуемой гамме.Параметры
-
options: {
method: GamutMapMethod;
space?: KnownColorSpace;
}-
method: GamutMapMethod
-
Optionalspace?: KnownColorSpace
-
Возвращает SassColor
-
toSpace
- toSpace(space: KnownColorSpace): SassColor
-
Возвращает новый цвет, являющийся результатом преобразования этого цвета в указанную
space.Параметры
-
space: KnownColorSpace
Возвращает SassColor
-
© 2006–2025 the Sass team, and numerous contributors
Licensed under the MIT License.
https://sass-lang.com/documentation/js-api/classes/SassColor
Тип цвета Sass.
Независимо от того, какая запись была первоначально использована для создания этого цвета, доступны все его каналы.