Defines color transforms for a WorkbookColorInfo instance.

This class is immutable.

Color transforms are not applicable to all contexts within which a WorkbookColorInfo is used; currently they are only used by charts.

See

Hierarchy

Hierarchy

  • Base
    • WorkbookColorTransform

Constructors

  • Parameters

    • Optional alpha: number
    • Optional luminanceModulation: number
    • Optional luminanceOffset: number
    • Optional shade: number

    Returns WorkbookColorTransform

  • Parameters

    • Rest ..._rest: any[]

    Returns WorkbookColorTransform

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get alpha(): null | number
  • Defines the value of the alpha channel for the associated WorkbookColorInfo instance, expressed as a number between 0 and 1.

    Use this property to control the transparency of the associated color.

    For example, to make the associated color 50% transparent, assign a value of .5 to this property.

    Assigning a value of null to this property implies that the associated color has no specific alpha channel setting, i.e., the associated color is fully opaque.

    Returns null | number

  • set alpha(a: null | number): void
  • Parameters

    • a: null | number

    Returns void

  • get luminanceModulation(): null | number
  • Defines the luminance modulation for the associated WorkbookColorInfo instance, expressed as a fractional number.

    Luminance is also referred to as brightness.

    This property specifies the amount by which the luminance of the associated base color is increased. For example, a value of .5 yields a 50% reduction in luminance. A value of 1.0 implies no change in luminance. A value greater than 1.0 implies an increase in luminance; for example, a value of 2.0 doubles the luminance.

    Assigning a value of null to this property implies that the associated color has no specific luminance modulation.

    Luminance modulation is applied by converting the base color from RGB to HSL, then multiplying the luminance channel by the value of this property, then converting back to RGB.

    See

    luminanceOffset

    Returns null | number

  • set luminanceModulation(a: null | number): void
  • Parameters

    • a: null | number

    Returns void

  • get luminanceOffset(): null | number
  • Defines the luminance offset for the associated WorkbookColorInfo instance, expressed as a fractional number.

    Luminance is also referred to as brightness.

    The luminance offset is applied by converting the base color from RGB to HSL, then the value of this property to the luminance channel, then converting back to RGB.

    Assigning a value of null to this property implies that the associated color has no specific luminance offset.

    See

    luminanceModulation

    Returns null | number

  • set luminanceOffset(a: null | number): void
  • Parameters

    • a: null | number

    Returns void

  • get shade(): null | number
  • Defines the shading for the associated WorkbookColorInfo instance, expressed as a fractional number.

    See

    alpha

    Returns null | number

  • set shade(a: null | number): void
  • Parameters

    • a: null | number

    Returns void

Methods

  • Parameters

    • other: any

    Returns boolean

  • Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns number

  • Parameters

    • a: any
    • b: any

    Returns boolean