Class Color

constructor

• new Color(colorData: ColorData | Color, platform?: string): Color

  Parameters

  • colorData: ColorData | Color
  • Optionalplatform: string

  Returns Color

a

b

g

isVariable

OptionallinkedVariableSourceId

Optionalname

OptionaloriginalName

r

OptionalsourceId

StaticALLOWED_FIELDS

• get ALLOWED_FIELDS(): string[]

  Returns string[]

blend

• blend(c: ColorData | Color): Color

  Blends another color with this one via alpha compositing

  Parameters

  • c: ColorData | Color

    Color object to be blended

  Returns Color

  A new blended color

equals

• equals(c: ColorData | Color): boolean

  Checks whether some other color is equal to this one

  Parameters

  • c: ColorData | Color

    Color object to be compared

  Returns boolean

  Whether the colors are equal

getFormattedName

• getFormattedName(namingScheme?: NamingScheme): undefined | string

  Gets the formatted name of the color using the specified naming scheme

  Parameters

  • OptionalnamingScheme: NamingScheme

    The naming scheme to use

  Returns undefined | string

  Formatted color name

hexBase

• hexBase(): string

  Returns the base hex string without the # prefix

  Returns string

  Hex string without prefix

toHex

• toHex(): HexColor

  Return the hex representation of the color

  Returns HexColor

  Object with hex components

toHexString

• toHexString(): string

  Converts the color to a hexadecimal string

  Returns string

  Hexadecimal color string

toHSL

• toHSL(): HSLColor

  Return the HSLA representation of the color

  Returns HSLColor

  HSL object

toHSLString

• toHSLString(): string

  Gets the HSLA values as a CSS string

  Returns string

  CSS compatible hsla string

toRGBAString

• toRGBAString(): string

  Gets the RGBA values as a CSS string

  Returns string

  CSS compatible rgba (or rgb if alpha is below 1.0) string

StaticblendAll

• blendAll(colors: (ColorData | Color)[]): Color

  Blends a list of colors

  Parameters

  • colors: (ColorData | Color)[]

    List of color objects to be blended

  Returns Color

  A new blended color

StaticfromJSON

• fromJSON(json: string): Color

  Creates a Color instance from a JSON string

  Parameters

  • json: string

    JSON string representing a color

  Returns Color

  A new Color instance