ig.excel.WorkbookColorTransform
Remarks
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.
Dependencies
-
ig.excel.WorkbookColorTransform
Constructor- new $.ig.excel.WorkbookColorTransform( [alpha:number], [luminanceModulation:number], [luminanceOffset:number], [shade:number] );
Creates a new WorkbookColorTransform instance with the specified color transform values.
- alpha
- Type:number
- Optional
- The value of the WorkbookColorTransform.alpha property or null.
- luminanceModulation
- Type:number
- Optional
- The value of the WorkbookColorTransform.luminanceModulation property or null.
- luminanceOffset
- Type:number
- Optional
- The value of the WorkbookColorTransform.luminanceOffset property or null.
- shade
- Type:number
- Optional
- The value of the WorkbookColorTransform.shade property or null.
Exceptions
Exception Description ig.ArgumentOutOfRangeException alpha is outside the range of 0 to 1.0, inclusive. Remarks
This class is immutable; as such, all properties are read-only.
Property values can only be specified at the time of instance creation.
See Also
-
alpha
- .alpha( );
Defines the value of the alpha channel for the associated WorkbookColorInfo instance, expressed as a number between 0 and 1.
Remarks
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.
-
luminanceModulation
- .luminanceModulation( );
Defines the luminance modulation for the associated WorkbookColorInfo instance, expressed as a fractional number.
Remarks
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.
-
luminanceOffset
- .luminanceOffset( );
Defines the luminance offset for the associated WorkbookColorInfo instance, expressed as a fractional number.
Remarks
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.
-
shade
- .shade( );
Defines the shading for the associated WorkbookColorInfo instance, expressed as a fractional number.