SassColor

Sass's Farbtyp.

Unabhängig davon, welche Darstellung ursprünglich zur Erstellung dieser Farbe verwendet wurde, sind alle ihre Kanäle zugänglich.

Hierarchie

Konstruktoren

constructor

Accessor

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

Methoden

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

Konstruktoren

constructor

  • Erstellt eine RGB-Farbe.

    Wenn space fehlt, sollte nur undefined verwendet werden, um anzuzeigen, dass alpha nicht übergeben wurde. Wenn stattdessen null verwendet wird, wird es als fehlende Komponente behandelt. Weitere Einzelheiten finden Sie in den Breaking Changes.

    Wenn space definiert ist und null für eine Komponente übergeben wird, wird diese als fehlende Komponente behandelt.

    Wirft

    Error, wenn alpha gesetzt ist und weder null noch eine Zahl zwischen 0 und 1 ist.

    Parameter

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

    Gibt SassColor zurück

constructor

  • Erstellt eine HSL-Farbe.

    Wenn space fehlt, sollte nur undefined verwendet werden, um anzuzeigen, dass alpha nicht übergeben wurde. Wenn stattdessen null verwendet wird, wird es als fehlende Komponente behandelt. Weitere Einzelheiten finden Sie in den Breaking Changes.

    Wenn space definiert ist und null für eine Komponente übergeben wird, wird diese als fehlende Komponente behandelt.

    Wirft

    Error, wenn alpha gesetzt ist und weder null noch eine Zahl zwischen 0 und 1 ist.

    Parameter

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

    Gibt SassColor zurück

constructor

  • Erstellt eine HWB-Farbe.

    Wenn space fehlt, sollte nur undefined verwendet werden, um anzuzeigen, dass alpha nicht übergeben wurde. Wenn stattdessen null verwendet wird, wird es als fehlende Komponente behandelt. Weitere Einzelheiten finden Sie in den Breaking Changes.

    Wenn space definiert ist und null für eine Komponente übergeben wird, wird diese als fehlende Komponente behandelt.

    Wirft

    Error, wenn alpha gesetzt ist und weder null noch eine Zahl zwischen 0 und 1 ist.

    Parameter

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

    Gibt SassColor zurück

constructor

  • Erstellt eine Lab- oder Oklab-Farbe.

    Wenn null für eine Komponente übergeben wird, wird sie als fehlende Komponente behandelt.

    Wirft

    Error, wenn alpha gesetzt ist und weder null noch eine Zahl zwischen 0 und 1 ist.

    Parameter

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

    Gibt SassColor zurück

constructor

  • Erstellt eine LCH- oder Oklch-Farbe.

    Wenn null für eine Komponente übergeben wird, wird sie als fehlende Komponente behandelt.

    Wirft

    Error, wenn alpha gesetzt ist und weder null noch eine Zahl zwischen 0 und 1 ist.

    Parameter

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

    Gibt SassColor zurück

constructor

  • Erstellt eine Farbe in einem vordefinierten RGB-Farbraum.

    Wenn null für eine Komponente übergeben wird, wird sie als fehlende Komponente behandelt.

    Wirft

    Error, wenn alpha gesetzt ist und weder null noch eine Zahl zwischen 0 und 1 ist.

    Parameter

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

    Gibt SassColor zurück

constructor

  • Erstellt eine Farbe in einem vordefinierten XYZ-Farbraum.

    Wenn null für eine Komponente übergeben wird, wird sie als fehlende Komponente behandelt.

    Wirft

    Error, wenn alpha gesetzt ist und weder null noch eine Zahl zwischen 0 und 1 ist.

    Parameter

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

    Gibt SassColor zurück

Accessor

alpha

asList

  • get asList(): List<Value>

  • Dieser Wert als Liste.

    Alle SassScript-Werte können als Listen verwendet werden. Maps zählen als Listen von Paaren, und alle anderen Werte zählen als Listen mit einem einzelnen Wert.

    Gibt List<Value> zurück

    Eine unveränderliche Liste aus dem immutable-Paket.

blackness

blue

channels

channelsOrNull

green

hasBrackets

  • get hasBrackets(): boolean

  • Ob dieser Wert als Liste Klammern hat.

    Alle SassScript-Werte können als Listen verwendet werden. Maps zählen als Listen von Paaren, und alle anderen Werte zählen als Listen mit einem einzelnen Wert.

    Gibt boolean zurück

hue

isLegacy

  • get isLegacy(): boolean

  • Ein Boolean, der angibt, ob diese Farbe in einem älteren Farbraum liegt (rgb, hsl oder hwb).

    Gibt boolean zurück

isTruthy

  • get isTruthy(): boolean

  • Ob der Wert in einer @if-Anweisung und anderen Kontexten als true zählt.

    Gibt boolean zurück

Helligkeit

realNull

rot

sättigung

separator

  • get separator(): ListSeparator

  • Der Trenner für diesen Wert als Liste.

    Alle SassScript-Werte können als Listen verwendet werden. Maps zählen als Listen von Paaren, und alle anderen Werte zählen als Listen mit einem einzelnen Wert.

    Gibt ListSeparator zurück

space

whiteness

Methoden

assertBoolean

  • Wirft einen Fehler, wenn this kein SassBoolean ist.

    ⚠️ Vorsicht!

    Funktionen sollten generell isTruthy verwenden und keine booleschen Literale erzwingen.

    Parameter

    • Optional name: string

      Der Name des Funktionsarguments, von dem this stammt (ohne das $), falls es von einem Argument stammt. Wird für die Fehlermeldung verwendet.

    Gibt SassBoolean zurück

assertCalculation

assertColor

assertFunction

assertMap

  • Wirft einen Fehler, wenn this kein SassMap ist.

    Parameter

    • Optional name: string

      Der Name des Funktionsarguments, von dem this stammt (ohne das $), falls es von einem Argument stammt. Wird für die Fehlermeldung verwendet.

    Gibt SassMap zurück

assertMixin

assertNumber

assertString

change

  • Gibt eine neue Farbe zurück, die das Ergebnis der Änderung eines oder mehrerer HSL-Kanäle dieser Farbe ist.

    Wirft

    Error, wenn space fehlt und diese Farbe nicht in einem Legacy-Farbraum liegt (rgb, hsl oder hwb).

    Wirft

    Error, wenn alpha gesetzt ist und weder null noch eine Zahl zwischen 0 und 1 ist.

    Parameter

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

    Gibt SassColor zurück

change

  • Gibt eine neue Farbe zurück, die das Ergebnis der Änderung eines oder mehrerer HWB-Kanäle dieser Farbe ist.

    Wirft

    Error, wenn space fehlt und diese Farbe nicht in einem Legacy-Farbraum liegt (rgb, hsl oder hwb).

    Wirft

    Error, wenn alpha gesetzt ist und weder null noch eine Zahl zwischen 0 und 1 ist.

    Parameter

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

    Gibt SassColor zurück

change

  • Gibt eine neue Farbe zurück, die das Ergebnis der Änderung eines oder mehrerer Lab-Kanäle dieser Farbe ist.

    Wirft

    Error, wenn space fehlt und diese Farbe nicht im Lab- oder Oklab-Farbraum liegt.

    Wirft

    Error, wenn alpha gesetzt ist und weder null noch eine Zahl zwischen 0 und 1 ist.

    Parameter

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

    Gibt SassColor zurück

change

  • Gibt eine neue Farbe zurück, die das Ergebnis der Änderung eines oder mehrerer LCH-Kanäle dieser Farbe ist.

    Wirft

    Error, wenn space fehlt und diese Farbe nicht im LCH- oder Oklch-Farbraum liegt.

    Wirft

    Error, wenn alpha gesetzt ist und weder null noch eine Zahl zwischen 0 und 1 ist.

    Parameter

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

    Gibt SassColor zurück

change

  • Gibt eine neue Farbe zurück, die das Ergebnis der Änderung eines oder mehrerer RGB-Kanäle dieser Farbe ist.

    Wirft

    Error, wenn space fehlt und diese Farbe nicht in einem Legacy-Farbraum liegt (rgb, hsl oder hwb).

    Wirft

    Error, wenn alpha gesetzt ist und weder null noch eine Zahl zwischen 0 und 1 ist.

    Parameter

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

    Gibt SassColor zurück

change

  • Gibt eine neue Farbe zurück, die das Ergebnis der Änderung eines oder mehrerer XYZ-Kanäle dieser Farbe ist.

    Wirft

    Error, wenn space fehlt und diese Farbe nicht in einem XYZ-Farbraum liegt.

    Wirft

    Error, wenn alpha gesetzt ist und weder null noch eine Zahl zwischen 0 und 1 ist.

    Parameter

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

    Gibt SassColor zurück

channel

channel

  • Gibt den Wert eines einzelnen angegebenen channel dieser Farbe zurück, nachdem diese Farbe in den angegebenen space konvertiert wurde, wobei fehlende Kanäle zu 0 konvertiert werden.

    Wirft

    Error, wenn channel nicht alpha oder ein Kanal in space ist.

    Parameter

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

    Gibt number zurück

channel

channel

channel

channel

channel

equals

get

  • Gibt den Wert am Index index in diesem Wert als Liste zurück, oder undefined, wenn index für diese Liste ungültig ist.

    Alle SassScript-Werte können als Listen verwendet werden. Maps zählen als Listen von Paaren, und alle anderen Werte zählen als Listen mit einem einzelnen Wert.

    Dies ist eine Kurzform für this.asList.get(index), obwohl es in manchen Fällen effizienter sein kann.

    ⚠️ Vorsicht!

    Diese Methode verwendet dieselben Indexierungs-Konventionen wie das immutable-Paket: Im Gegensatz zu Sass ist der Index des ersten Elements 0, aber wie bei Sass werden negative Zahlen vom Ende der Liste indiziert.

    Parameter

    • index: number

    Gibt undefined | Value zurück

hashCode

interpolate

  • Gibt eine Farbe zurück, die halbwegs zwischen dieser Farbe und color2 liegt, gemäß method, wie in der CSS Color 4 Farbinterpolationsprozedur definiert. 

    Wenn method fehlt und diese Farbe in einem rechteckigen Farbraum liegt (Lab, Oklab, RGB und XYZ), wird method standardmäßig auf den Farbraum dieser Farbe gesetzt. Andernfalls wird method standardmäßig auf eine durch Leerzeichen getrennte Liste gesetzt, die den Farbraum dieser Farbe und den String "shorter" enthält.

    Das weight ist eine Zahl zwischen 0 und 1, die angibt, wie viel dieser Farbe in der resultierenden Farbe enthalten sein soll. Wenn es weggelassen wird, ist der Standardwert 0,5.

    Parameter

    Gibt SassColor zurück

isChannelMissing

isChannelPowerless

  • Gibt einen booleschen Wert zurück, der angibt, ob ein bestimmter channel in dieser Farbe powerless ist. Dies ist ein spezieller Zustand, der für einzelne Farbräume definiert ist und angibt, dass der Wert eines Kanals die Anzeige einer Farbe nicht beeinflusst. 

    Parameter

    Gibt boolean zurück

isChannelPowerless

isChannelPowerless

isChannelPowerless

isChannelPowerless

isChannelPowerless

isChannelPowerless

isInGamut

  • Gibt einen booleschen Wert zurück, der angibt, ob diese Farbe im Gamut liegt (im Gegensatz zu einer oder mehreren ihrer Kanäle außerhalb der Grenzen) für den angegebenen space, oder ihren aktuellen Farbraum, wenn space nicht angegeben ist.

    Parameter

    Gibt boolean zurück

sassIndexToListIndex

  • Konvertiert sassIndex in einen JavaScript-konformen Index für die Liste, die von asList zurückgegeben wird.

    Sass-Indizes sind einstellig, während JavaScript-Indizes nullbasiert sind. Sass-Indizes können auch negativ sein, um vom Ende der Liste zu indizieren.

    Wirft

    Error Wenn sassIndex keine Zahl ist, wenn diese Zahl keine ganze Zahl ist oder wenn diese ganze Zahl kein gültiger Index für asList ist.

    Parameter

    • sassIndex: Value

      Der Sass-Index für diesen Wert als Liste.

    • Optional name: string

      Der Name des Arguments sassIndex (ohne das $), wenn es von einem Argument stammt. Wird für die Fehlerberichterstattung verwendet.

    Gibt number zurück

toGamut

toSpace

tryMap