Ignite UI API Reference

ig.excel.CellFillGradientStop

Immutable class which describes a color transition in a cell fill gradient.

Dependencies

jquery-1.4.4.js
infragistics.util.js
The current widget has no options.
The current widget has no events.
  • &nbspig.excel.CellFillGradientStop

    new $.ig.excel.CellFillGradientStop( color:string, offset:number );

    Creates a new CellFillGradientStop instance.

    • color
    • Type:string
    • The color transition for the gradient stop.
    • offset
    • Type:number
    • The position in the gradient of the color transition for the gradient stop, ranging from 0.0 to 1.0.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException offset is less than 0.0 or greater than 1.0.
    ig.ArgumentException color is the empty or system color or has a non-opaque alpha channel.

    Remarks

    When used in a CellFillLinearGradient, an offset of 0.0 is at the beginning of the gradient and 1.0 is at the end of the gradient. When used in a CellFillRectangularGradient, an offset of 0.0 is at the inner rectangle and 1.0 is at the outer edges of the cell.

  • &nbspig.excel.CellFillGradientStop

    new $.ig.excel.CellFillGradientStop( colorInfo:ig.excel.WorkbookColorInfo, offset:number );

    Creates a new CellFillGradientStop instance.

    • colorInfo
    • Type:ig.excel.WorkbookColorInfo
    • The WorkbookColorInfo describing the color transition for the gradient stop.
    • offset
    • Type:number
    • The position in the gradient of the color transition for the gradient stop, ranging from 0.0 to 1.0.

    Exceptions

    Exception Description
    ig.ArgumentException colorInfo is automatic or a system color.
    ig.ArgumentOutOfRangeException offset is less than 0.0 or greater than 1.0.

    Remarks

    When used in a CellFillLinearGradient, an offset of 0.0 is at the beginning of the gradient and 1.0 is at the end of the gradient. When used in a CellFillRectangularGradient, an offset of 0.0 is at the inner rectangle and 1.0 is at the outer edges of the cell.

  • colorInfo

    .colorInfo( );

    Gets the WorkbookColorInfo describing the color transition for the gradient stop.

  • equals

    .equals( obj:object );
    Return Type:
    boolean
    Return Type Description:
    True if the object is equal to this instance; False otherwise.

    Determines whether the CellFillGradientStop is equal to the specified object.

    • obj
    • Type:object
    • The object to test for equality.
  • getHashCode

    .getHashCode( );
    Return Type:
    number
    Return Type Description:
    A number which can be used to hash this instance.

    Gets the hash code for the CellFillGradientStop.

  • offset

    .offset( );

    Gets the position in the gradient of the color transition for the gradient stop, ranging from 0.0 to 1.0.

    Remarks

    When used in a CellFillLinearGradient, a value of 0.0 is at the beginning of the gradient and 1.0 is at the end of the gradient. When used in a CellFillRectangularGradient, a value of 0.0 is at the inner rectangle and 1.0 is at the outer edges of the cell.

Copyright © 1996 - 2019 Infragistics, Inc. All rights reserved.

#