Class ColorInfo

GetHashCode

• GetHashCode(): number

  Returns the hash code for this instance.

  Returns number

  A 32-bit signed integer that is the hash code for this instance.

ToString

• ToString(): string

  Returns the fully qualified type name of this instance.

  Returns string

  The fully qualified type name.

constructor

• new ColorInfo(argb: number | Int32): ColorInfo

  Initializes a new instance of the Spotfire.Dxp.Framework.Styles.ColorInfo struct from an integer value.

  Parameters

  • argb: number | Int32

    The color as an int containing a, r, g and b values.

  Returns ColorInfo

  Since

  2.0

• new ColorInfo(source: ColorInfo, a: number | Single): ColorInfo

  Initializes a new instance of the Spotfire.Dxp.Framework.Styles.ColorInfo struct using another one as source but with a new alpha. Clamps the alpha to [0, 1].

  Parameters

  • source: ColorInfo

    The prototype color.

  • a: number | Single

    The alpha component.

  Returns ColorInfo

  Since

  2.0

• new ColorInfo(
      r: number | Int32,
      g: number | Int32,
      b: number | Int32,
  ): ColorInfo

  Initializes a new instance of the Spotfire.Dxp.Framework.Styles.ColorInfo struct. Clamps the color components to the range [0, 255] and sets alpha to 1.

  Parameters

  • r: number | Int32

    The red component.

  • g: number | Int32

    The green component.

  • b: number | Int32

    The blue component.

  Returns ColorInfo

  Since

  2.0

• new ColorInfo(
      r: number | Byte,
      g: number | Byte,
      b: number | Byte,
      a: number | Byte,
  ): ColorInfo

  Initializes a new instance of the Spotfire.Dxp.Framework.Styles.ColorInfo struct.

  Parameters

  • r: number | Byte

    The red component.

  • g: number | Byte

    The green component.

  • b: number | Byte

    The blue component.

  • a: number | Byte

    The alpha component.

  Returns ColorInfo

  Since

  2.0

• new ColorInfo(
      r: number | Byte,
      g: number | Byte,
      b: number | Byte,
      a: number | Single,
  ): ColorInfo

  Initializes a new instance of the Spotfire.Dxp.Framework.Styles.ColorInfo struct. Clamps the alpha to [0, 1].

  Parameters

  • r: number | Byte

    The red component.

  • g: number | Byte

    The green component.

  • b: number | Byte

    The blue component.

  • a: number | Single

    The alpha component. Clamped to [0, 1].

  Returns ColorInfo

  Since

  2.0

• new ColorInfo(
      r: number | Int32,
      g: number | Int32,
      b: number | Int32,
      a: number | Single,
  ): ColorInfo

  Initializes a new instance of the Spotfire.Dxp.Framework.Styles.ColorInfo struct. Clamps the color components to the range [0, 255] and alpha to [0, 1].

  Parameters

  • r: number | Int32

    The red component.

  • g: number | Int32

    The green component.

  • b: number | Int32

    The blue component.

  • a: number | Single

    The alpha component.

  Returns ColorInfo

  Since

  2.0

Static ReadonlyTransparent

A

• get A(): number

  Gets the alpha value of this color.

  Returns number

  Since

  2.0

B

• get B(): number

  Gets the blue value of this color.

  Returns number

  Since

  2.0

G

• get G(): number

  Gets the green value of this color.

  Returns number

  Since

  2.0

IsOpaque

• get IsOpaque(): boolean

  Gets a value indicating whether this instance is completely opaque.

  Returns boolean

  Since

  2.0

IsTransparent

• get IsTransparent(): boolean

  Gets a value indicating whether this instance is completely transparent.

  Returns boolean

  Since

  2.0

R

• get R(): number

  Gets the red value of this color.

  Returns number

  Since

  2.0

Equals

• Equals(obj: any): boolean

  Determines whether the specified object is equal to the current object.

  Parameters

  • obj: any

    The object to compare with the current object.

  Returns boolean

  true if the specified object is equal to the current object; otherwise, false.

• Equals(obj: any): boolean

  Indicates whether this instance and a specified object are equal.

  Parameters

  • obj: any

    The object to compare with the current instance.

  Returns boolean

  true if obj and this instance are the same type and represent the same value; otherwise, false.

• Equals(other: ColorInfo): boolean

  Indicates whether the current object is equal to another object of the same type.

  Parameters

  • other: ColorInfo

    An object to compare with this object.

  Returns boolean

  true if the current object is equal to the other parameter; otherwise, false.

  Since

  2.0

ToArgb

• ToArgb(): number

  Converts this color to an integer.

  Returns number

  Color as an integer made up from a, r, g, b values.

  Since

  2.0

ToColor

• ToColor(): Color

  Creates a font from current settings.

  Returns Color

  A font. The caller is responsible for disposing it when done.

  Since

  2.0