constructor

• new WorkbookColorTransform(alpha?, luminanceModulation?, luminanceOffset?, shade?): WorkbookColorTransform

• Parameters

  • Optional alpha: number

  • Optional luminanceModulation: number

  • Optional luminanceOffset: number

  • Optional shade: number

  Returns WorkbookColorTransform

• new WorkbookColorTransform(..._rest): WorkbookColorTransform

• Parameters

  • Rest ..._rest: any[]

  Returns WorkbookColorTransform

Static $t

alpha

• get alpha(): 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 number

• set alpha(a): void

• Parameters

  • a: number

  Returns void

luminanceModulation

• get luminanceModulation(): 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 number

• set luminanceModulation(a): void

• Parameters

  • a: number

  Returns void

luminanceOffset

• get luminanceOffset(): 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 number

• set luminanceOffset(a): void

• Parameters

  • a: number

  Returns void

shade

• get shade(): number

• Defines the shading for the associated [[WorkbookColorInfo]] instance, expressed as a fractional number.

  See

  [[alpha]]

  Returns number

• set shade(a): void

• Parameters

  • a: number

  Returns void