ig.excel.IconSortCondition

Represents a sort condition which will sort cells based on a specific conditioanl formmat icon.

Remarks

This sort condition specifies a single icon. Cells with this icon will be moved to the beginning of the data range for the ascending sort direction and moved to the end of the data range for the descending sort direction. All matching cells will be kept in their same relative order to each other. In addition, all non-matching cells will be kept in their same relative order to each other.

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.IconSortCondition
    Constructor

    new $.ig.excel.IconSortCondition( iconSet:ig.excel.FormatConditionIconSet, iconIndex:number );

    Creates a new IconSortCondition instance.

    • iconSet
    • Type:ig.excel.FormatConditionIconSet
    • The set of icons.
    • iconIndex
    • Type:number
    • The zero-based index of the icon in the iconset by which the cells should be sorted or null for 'NoCellIcon'.
  • ig.excel.IconSortCondition
    Constructor

    new $.ig.excel.IconSortCondition( iconSet:ig.excel.FormatConditionIconSet, iconIndex:number, sortDirection:ig.excel.SortDirection );

    Creates a new IconSortCondition instance.

    • iconSet
    • Type:ig.excel.FormatConditionIconSet
    • The set of icons.
    • iconIndex
    • Type:number
    • The zero-based index of the icon in the iconset by which the cells should be sorted or null for 'NoCellIcon'.
    • sortDirection
    • Type:ig.excel.SortDirection
    • The direction of the sort.

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException iconSet is not defined in the FormatConditionIconSet enumeration. sortDirection is not defined in the SortDirection enumeration.
  • equals
    Inherited

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

    Determines whether the SortCondition is equal to the specified object.

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

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

    Gets the hash code for the SortCondition.

  • iconIndex

    .iconIndex( );

    Gets the icon set (read-only).

  • iconSet

    .iconSet( );
    Return Type:
    ig.excel.FormatConditionIconSet
    Return Type Description:
    Returns a FormatConditionIconSet.

    Gets the icon's index in the associated icon set or null for 'NoCellIcon' (read-only).

  • sortDirection
    Inherited

    .sortDirection( );
    Return Type:
    ig.excel.SortDirection
    Return Type Description:
    Either SortDirection.Ascending or SortDirection.Descending.

    Gets the value which indicates the sort direction represented by the sort condition.

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