Ignite UI API Reference

ig.excel.CellFillRectangularGradient

An immutable object which represents a rectangular gradient fill for a cell.

Dependencies

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

    new $.ig.excel.CellFillRectangularGradient( left:number, top:number, right:number, bottom:number, stops:ig.excel.CellFillGradientStop[] );

    Creates a new CellFillRectangularGradient instance.

    • left
    • Type:number
    • The left edge of the inner rectangle of the gradient, ranging from 0.0 (the left of the cell) to 1.0 (the right of the cell).
    • top
    • Type:number
    • The top edge of the inner rectangle of the gradient, ranging from 0.0 (the top of the cell) to 1.0 (the bottom of the cell).
    • right
    • Type:number
    • The right edge of the inner rectangle of the gradient, ranging from 0.0 (the left of the cell) to 1.0 (the right of the cell).
    • bottom
    • Type:number
    • The bottom edge of the inner rectangle of the gradient, ranging from 0.0 (the top of the cell) to 1.0 (the bottom of the cell).
    • stops
    • Type:ig.excel.CellFillGradientStop[]
    • Two or more gradient stops which describe the color transitions and their positions within the gradient.

    Exceptions

    Exception Description
    ig.ArgumentOutOfRangeException left, top, right, or bottom are less than 0.0 or greater than 1.0.
    ig.ArgumentException stops contains less than two gradient stops. There must be at least two stops to define the gradient.

    Remarks

    The rectangular gradient is defined by specifying an inner rectangle and a set of gradient stops. The gradient goes from the edges of the inner rectangle to the edges of the cell. If the inner rectangle does not have a height or width of 0, the color of the first gradient stop will be filled in the center of the inner rectangle.

    The inner rectangle is defined by the left, top, right, and bottom parameters. They are relative values ranging from 0.0 to 1.0 and they go from the top/left to the bottom/right. So, for example, to specify a gradient that goes out from the center, all values would be 0.5. Or to specify a gradient which goes out from the bottom-left corner of the cell, the following values would be used: left = 0.0, top = 1.0, right = 0.0, bottom = 1.0.

  • bottom

    .bottom( );

    Gets the bottom edge of the inner rectangle of the gradient, ranging from 0.0 (the top of the cell) to 1.0 (the bottom of the cell).

  • equals

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

    Determines whether the CellFillRectangularGradient 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 CellFillRectangularGradient.

  • left

    .left( );

    Gets the left edge of the inner rectangle of the gradient, ranging from 0.0 (the left of the cell) to 1.0 (the right of the cell).

  • right

    .right( );

    Gets the right edge of the inner rectangle of the gradient, ranging from 0.0 (the left of the cell) to 1.0 (the right of the cell).

  • top

    .top( );

    Gets the top edge of the inner rectangle of the gradient, ranging from 0.0 (the top of the cell) to 1.0 (the bottom of the cell).

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

#