SassColor

Sass 的 颜色类型。

无论最初使用什么表示形式来创建此颜色，其所有通道都可访问。

层次结构

构造函数

constructor

访问器

alpha asList blackness blue channels channelsOrNull green hasBrackets hue isLegacy isTruthy lightness realNull red saturation separator space whiteness

方法

assertBoolean assertCalculation assertColor assertFunction assertMap assertMixin assertNumber assertString change channel equals get hashCode interpolate isChannelMissing isChannelPowerless isInGamut sassIndexToListIndex toGamut toSpace tryMap

构造函数

构造函数

  • 创建一个 RGB 颜色。

    如果 space 缺失，则**仅**应使用 undefined 来指示未传递 alpha。如果改为使用 null，则将其视为 缺失的组件。有关详细信息，请参阅 重大更改。

    如果定义了 space 并为任何组件传递了 null，则将其视为 缺失的组件。

    抛出

    如果设置了 alpha 且它不是 null 或 0 到 1 之间的一个数字，则抛出 Error。

    参数

    • options: {
          alpha?: null | number;
          blue: null | number;
          green: null | number;
          red: null | number;
          space?: "rgb";
      }
      • 可选 alpha?: null | number
      • blue: null | number
      • green: null | number
      • red: null | number
      • 可选 space?: "rgb"

    返回 SassColor

构造函数

  • 创建一个 HSL 颜色。

    如果 space 缺失，则**仅**应使用 undefined 来指示未传递 alpha。如果改为使用 null，则将其视为 缺失的组件。有关详细信息，请参阅 重大更改。

    如果定义了 space 并为任何组件传递了 null，则将其视为 缺失的组件。

    抛出

    如果设置了 alpha 且它不是 null 或 0 到 1 之间的一个数字，则抛出 Error。

    参数

    • options: {
          alpha?: null | number;
          hue: null | number;
          lightness: null | number;
          saturation: null | number;
          space?: "hsl";
      }
      • 可选 alpha?: null | number
      • hue: null | number
      • lightness: null | number
      • saturation: null | number
      • 可选 space?: "hsl"

    返回 SassColor

构造函数

  • 创建一个 HWB 颜色。

    如果 space 缺失，则**仅**应使用 undefined 来指示未传递 alpha。如果改为使用 null，则将其视为 缺失的组件。有关详细信息，请参阅 重大更改。

    如果定义了 space 并为任何组件传递了 null，则将其视为 缺失的组件。

    抛出

    如果设置了 alpha 且它不是 null 或 0 到 1 之间的一个数字，则抛出 Error。

    参数

    • options: {
          alpha?: null | number;
          blackness: null | number;
          hue: null | number;
          space?: "hwb";
          whiteness: null | number;
      }
      • 可选 alpha?: null | number
      • blackness: null | number
      • hue: null | number
      • 可选 space?: "hwb"
      • whiteness: null | number

    返回 SassColor

构造函数

  • 创建一个 Lab 或 Oklab 颜色。

    如果为任何组件传递了 null，则将其视为 缺失的组件。

    抛出

    如果设置了 alpha 且它不是 null 或 0 到 1 之间的一个数字，则抛出 Error。

    参数

    • options: {
          a: null | number;
          alpha?: null | number;
          b: null | number;
          lightness: null | number;
          space: ColorSpaceLab;
      }
      • a: null | number
      • 可选 alpha?: null | number
      • b: null | number
      • lightness: null | number
      • space: ColorSpaceLab

    返回 SassColor

构造函数

  • 创建一个 LCH 或 Oklch 颜色。

    如果为任何组件传递了 null，则将其视为 缺失的组件。

    抛出

    如果设置了 alpha 且它不是 null 或 0 到 1 之间的一个数字，则抛出 Error。

    参数

    • options: {
          alpha?: null | number;
          chroma: null | number;
          hue: null | number;
          lightness: null | number;
          space: ColorSpaceLch;
      }
      • 可选 alpha?: null | number
      • chroma: null | number
      • hue: null | number
      • lightness: null | number
      • space: ColorSpaceLch

    返回 SassColor

构造函数

  • 在预定义的 RGB 颜色空间中创建一个颜色。

    如果为任何组件传递了 null，则将其视为 缺失的组件。

    抛出

    如果设置了 alpha 且它不是 null 或 0 到 1 之间的一个数字，则抛出 Error。

    参数

    • options: {
          alpha?: null | number;
          blue: null | number;
          green: null | number;
          red: null | number;
          space: "display-p3" | "srgb" | "rec2020" | "a98-rgb" | "prophoto-rgb" | "srgb-linear";
      }
      • 可选 alpha?: null | number
      • blue: null | number
      • green: null | number
      • red: null | number
      • space: "display-p3" | "srgb" | "rec2020" | "a98-rgb" | "prophoto-rgb" | "srgb-linear"

    返回 SassColor

构造函数

  • 在预定义的XYZ 色彩空间中创建颜色。

    如果为任何组件传递了 null，则将其视为 缺失的组件。

    抛出

    如果设置了 alpha 且它不是 null 或 0 到 1 之间的一个数字，则抛出 Error。

    参数

    • options: {
          alpha?: null | number;
          space: ColorSpaceXyz;
          x: null | number;
          y: null | number;
          z: null | number;
      }
      • 可选 alpha?: null | number
      • space: ColorSpaceXyz
      • x: null | number
      • y: null | number
      • z: null | number

    返回 SassColor

访问器

alpha

asList

blackness

blue

channels

channelsOrNull

green

hasBrackets

  • get hasBrackets(): boolean

  • 此值作为列表是否带括号。

    所有 SassScript 值都可以用作列表。映射计为成对的列表，所有其他值计为单值列表。

    返回 boolean

hue

isLegacy

  • get isLegacy(): boolean

  • 一个布尔值，指示此颜色是否处于旧版色彩空间（rgb、hsl 或 hwb）。

    返回 boolean

isTruthy

  • get isTruthy(): boolean

  • 该值在 @if 语句和其他上下文中是否计为 true。

    返回 boolean

lightness

realNull

red

saturation

separator

space

whiteness

方法

assertBoolean

assertCalculation

assertColor

assertFunction

assertMap

assertMixin

assertNumber

assertString

change

  • 返回一个新的颜色，它是更改此颜色的一个或多个HSL 通道的结果。

    抛出

    如果 space 缺失且此颜色不在传统颜色空间（rgb、hsl 或 hwb）中，则会引发 Error。

    抛出

    如果设置了 alpha 且它不是 null 或 0 到 1 之间的一个数字，则抛出 Error。

    参数

    • options: {
          alpha: undefined | null | number;
          hue: undefined | null | number;
          lightness: undefined | null | number;
          saturation: undefined | null | number;
      } & {
          space?: "hsl";
      }

    返回 SassColor

change

  • 返回一个新的颜色，它是更改此颜色的一个或多个HWB 通道的结果。

    抛出

    如果 space 缺失且此颜色不在传统颜色空间（rgb、hsl 或 hwb）中，则会引发 Error。

    抛出

    如果设置了 alpha 且它不是 null 或 0 到 1 之间的一个数字，则抛出 Error。

    参数

    • options: {
          alpha: undefined | null | number;
          blackness: undefined | null | number;
          hue: undefined | null | number;
          whiteness: undefined | null | number;
      } & {
          space?: "hwb";
      }

    返回 SassColor

change

  • 返回一个新的颜色，它是更改此颜色的一个或多个 Lab 通道的结果。

    抛出

    如果 space 缺失且此颜色不在 Lab 或 Oklab 颜色 空间中，则会引发 Error。

    抛出

    如果设置了 alpha 且它不是 null 或 0 到 1 之间的一个数字，则抛出 Error。

    参数

    • options: {
          a: undefined | null | number;
          alpha: undefined | null | number;
          b: undefined | null | number;
          lightness: undefined | null | number;
      } & {
          space?: ColorSpaceLab;
      }

    返回 SassColor

change

  • 返回一个新的颜色，它是更改此颜色的一个或多个LCH 通道的结果。

    抛出

    如果 space 缺失且此颜色不在LCH或 Oklch 颜色 空间中，则会引发 Error。

    抛出

    如果设置了 alpha 且它不是 null 或 0 到 1 之间的一个数字，则抛出 Error。

    参数

    • options: {
          alpha: undefined | null | number;
          chroma: undefined | null | number;
          hue: undefined | null | number;
          lightness: undefined | null | number;
      } & {
          space?: ColorSpaceLch;
      }

    返回 SassColor

change

  • 返回一个新的颜色，它是更改此颜色的一个或多个RGB 通道的结果。

    抛出

    如果 space 缺失且此颜色不在传统颜色空间（rgb、hsl 或 hwb）中，则会引发 Error。

    抛出

    如果设置了 alpha 且它不是 null 或 0 到 1 之间的一个数字，则抛出 Error。

    参数

    • options: {
          alpha: undefined | null | number;
          blue: undefined | null | number;
          green: undefined | null | number;
          red: undefined | null | number;
      } & {
          space?: ColorSpaceRgb;
      }

    返回 SassColor

change

  • 返回一个新的颜色，它是更改此颜色的一个或多个XYZ 通道的结果。

    抛出

    如果 space 缺失且此颜色不在XYZ颜色 空间中，则会引发 Error。

    抛出

    如果设置了 alpha 且它不是 null 或 0 到 1 之间的一个数字，则抛出 Error。

    参数

    • options: {
          alpha: undefined | null | number;
          x: undefined | null | number;
          y: undefined | null | number;
          z: undefined | null | number;
      } & {
          space?: ColorSpaceXyz;
      }

    返回 SassColor

通道

通道

  • 将此颜色转换为指定的 space 后，返回此颜色的单个指定 channel 的值，其中缺少的通道转换为 0。

    抛出

    如果 channel 不是 alpha 或 space 中的通道，则会引发 Error。

    参数

    • channel: ChannelNameHsl
    • options: {
          space: "hsl";
      }
      • space: "hsl"

    返回 number

通道

通道

通道

通道

通道

equals

get

  • 返回此值作为列表中索引 index 处的值，如果 index 对此列表无效，则返回 undefined。

    所有 SassScript 值都可以用作列表。映射计为成对的列表，所有其他值计为单值列表。

    这是 this.asList.get(index) 的简写，尽管在某些情况下它可能更有效。

    ⚠️ 注意！

    此方法使用与 immutable 包相同的索引约定：与 Sass 不同，第一个元素的索引为 0，但与 Sass 类似，负数从列表的末尾开始索引。

    参数

    • index: number

    返回 undefined | Value

hashCode

interpolate

  • 根据 CSS 颜色 4 颜色插值过程中的 method，返回此颜色与 color2 之间的部分颜色。

    如果 method 缺失并且此颜色位于矩形颜色空间（Lab、Oklab、RGB 和 XYZ 空间）中，则 method 默认为此颜色的颜色空间。否则，method 默认为包含此颜色的颜色空间和字符串“shorter”的空间分隔列表。

    weight 是一个介于 0 和 1 之间的数字，表示结果颜色中应该包含多少此颜色。如果省略，则默认为 0.5。

    参数

    返回 SassColor

isChannelMissing

isChannelPowerless

  • 返回一个布尔值，指示给定的channel在此颜色中是否无效。这是一种为各个颜色空间定义的特殊状态，它表示通道的值不会影响颜色的显示方式。

    参数

    返回 boolean

isChannelPowerless

isChannelPowerless

isChannelPowerless

isChannelPowerless

isChannelPowerless

isChannelPowerless

isInGamut

  • 返回一个布尔值，指示此颜色是否在色域内（与其一个或多个通道超出范围相反），用于指定的space，或者如果未指定space则为其当前颜色空间。

    参数

    返回 boolean

sassIndexToListIndex

  • 将sassIndex转换为由asList返回的列表中的JavaScript样式索引。

    Sass索引基于1，而JavaScript索引基于0。Sass索引也可能是负数，以便从列表的末尾进行索引。

    抛出

    错误如果sassIndex不是数字，如果该数字不是整数，或者如果该整数不是asList的有效索引。

    参数

    • sassIndex: Value

      作为列表的Sass样式索引。

    • 可选 name: string

      如果sassIndex来自参数，则其来自的函数参数名称（不带$），用于错误报告。

    返回 number

toGamut

toSpace

tryMap