ig.excel.GradientStop

Describes the location and color of a transition point in a gradient.

Dependencies

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.

  • ig.excel.GradientStop
    Constructor

    new $.ig.excel.GradientStop( color:ig.excel.WorkbookColorInfo, position:number );

    Creates a new GradientStop instance with the specified color and position.

    • color
    • Type:ig.excel.WorkbookColorInfo
    • A WorkbookColorInfo instance which defines the color for this stop.
    • position
    • Type:number
    • A value between 0 and 1 which defines the relative position within the fill area up to which this stop is applied.

    See Also

  • color

    .color( );
    Return Type:
    ig.excel.WorkbookColorInfo
    Return Type Description:
    Returns a WorkbookColorInfo.

    Returns the color for this gradient stop.

    See Also

  • position

    .position( );

    Returns the position of this gradient stop, as a number between 0 and 1.

    Remarks

    The value assigned to the Position property represents a fraction of the area to which the gradient is applied.

    For example, to add two stops of equal length, create one GradientStop with a position of .5 and another with a position of 1.0.

    The first stop extends from the origin to the halfway point of the fill area, and the second extends from the end of the first to the endpoint of the area to be filled. For three uniform stops, use .33. .67, and 1.0 as the respective positions; for four, use .25, .5, .75, and 1.0, etc.

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