SassColor
Иерархия
-
Value
- SassColor
Индекс
Конструкторы
Аксессоры
Методы
Конструкторы
constructor
-
new SassColor(options: {
alpha?: null | number;
blue: null | number;
green: null | number;
red: null | number;
space?: "rgb";
}): SassColor -
Создаёт RGB-цвет.
Если
spaceотсутствует, для указания того, чтоalphaне передан, следует использовать толькоundefined. Если вместо этого используется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
-
конструктор
-
new SassColor(options: {
alpha?: null | number;
hue: null | number;
lightness: null | number;
saturation: null | number;
space?: "hsl";
}): SassColor -
Создаёт HSL-цвет.
Если
spaceотсутствует, для указания того, чтоalphaне передан, следует использовать толькоundefined. Если вместо этого используется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
-
constructor
-
new SassColor(options: {
alpha?: null | number;
blackness: null | number;
hue: null | number;
space?: "hwb";
whiteness: null | number;
}): SassColor -
Создаёт цвет HWB.
Если
spaceотсутствует, для обозначения того, чтоalphaне передан, следует использовать толькоundefined. Если вместо этого используется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
-
конструктор
-
new SassColor(options: {
a: null | number;
alpha?: null | number;
b: null | number;
lightness: null | number;
space: ColorSpaceLab;
}): SassColor -
Если для любого компонента передано
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
-
конструктор
-
new SassColor(options: {
alpha?: null | number;
chroma: null | number;
hue: null | number;
lightness: null | number;
space: ColorSpaceLch;
}): SassColor -
Если для любого компонента передано
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
-
конструктор
-
new SassColor(options: {
alpha?: null | number;
blue: null | number;
green: null | number;
red: null | number;
space: "display-p3" | "srgb" | "rec2020" | "a98-rgb" | "display-p3-linear" | "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" | "display-p3-linear" | "prophoto-rgb" | "srgb-linear";
}-
Optionalalpha?: null | number -
blue: null | number
-
green: null | number
-
red: null | number
-
space: "display-p3" | "srgb" | "rec2020" | "a98-rgb" | "display-p3-linear" | "prophoto-rgb" | "srgb-linear"
-
Возвращает SassColor
-
конструктор
-
new 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
- get asList(): List<Value>
-
Это значение в виде списка.
Все значения SassScript можно использовать как списки. Карты считаются списками пар, а все остальные значения — списками из одного элемента.
Возвращает List<Value>
Неизменяемый список из пакета
immutable.
blackness
- get blackness(): number
-
Возвращает number
blue
- get blue(): number
-
Возвращает number
channels
- get channels(): List<number>
-
Список значений цветовых каналов этого цвета (без альфа-канала); отсутствующие каналы преобразуются в
0.Возвращает List<number>
channelsOrNull
- get channelsOrNull(): List<null | number>
-
Список значений цветовых каналов этого цвета (без альфа-канала); отсутствующие каналы преобразуются в
null.Возвращает List<null | number>
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в операторе@ifи других контекстах.Возвращает boolean
lightness
- get lightness(): number
-
Возвращает number
realNull
red
- get red(): number
-
Возвращает 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
-
change
-
change(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
- channel(channel: ChannelName): number
-
Возвращает значение одного указанного
channelэтого цвета; отсутствующие каналы преобразуются в0.Вызывает исключение
Error, еслиchannelне равноalphaили не является каналом в цветовом пространстве этого цвета.Параметры
-
channel: ChannelName
Возвращает number
-
channel
-
channel(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.Если
methodне задан и этот цвет находится в прямоугольном цветовом пространстве (Lab, Oklab, пространства RGB и XYZ),methodпо умолчанию принимает значение цветового пространства этого цвета. В противном случаеmethodпо умолчанию представляет собой разделённый пробелами список, содержащий цветовое пространство этого цвета и строку "shorter".weight— это число от 0 до 1, указывающее, какая доля этого цвета должна присутствовать в результирующем цвете. Если значение не задано, по умолчанию используется 0.5.Параметры
-
color2: SassColor
-
Optionaloptions: {
method?: HueInterpolationMethod;
weight?: number;
}-
Optionalmethod?: HueInterpolationMethod -
Optionalweight?: 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 начинаются с единицы, а индексы JavaScript — с нуля. Индексы 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
-
tryMap
© 2006–2025 the Sass team, and numerous contributors
Licensed under the MIT License.
https://sass-lang.com/documentation/js-api/classes/SassColor
Тип цвета в Sass.
Независимо от того, какое представление изначально использовалось для создания этого цвета, доступны все его каналы.