aspose.cells
Class AutoFilter

//Instantiating a Workbook object
$workbook = new cells\Workbook("Book1.xls");
//Accessing the first worksheet in the Excel file
$worksheet = $workbook->getWorksheets()->get(0);
//Creating AutoFilter by giving the cells range of the heading row
$worksheet->getAutoFilter()->setRange("A1:B1");
//Filtering columns with specified values
$worksheet->getAutoFilter()->filter(1, "Bananas");

function getSorter()

Gets the data sorter.

function getRange() / function setRange(value)

Represents the range to which the specified AutoFilter applies.

function getFilterColumns()

Gets the collection of the filter columns.

function setRange(row, startColumn, endColumn)

Sets the range to which the specified AutoFilter applies.

Parameters:

row: Number - Row index.

startColumn: Number - Start column index.

endColumn: Number - End column Index.

function addFilter(fieldIndex, criteria)

Adds a filter for a filter column.

MS Excel 2007 supports multiple selection in a filter column.

Parameters:

fieldIndex: Number - The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).

criteria: String - The specified criteria (a string; for example, "101"). It only can be null or be one of the cells' value in this column.

function addDateFilter(fieldIndex, dateTimeGroupingType, year, month, day, hour, minute, second)

Adds a date filter.

If DateTimeGroupingType is Year, only the param year effects. If DateTiemGroupingType is Month, only the param year and month effect.

Parameters:

fieldIndex: Number - The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).

dateTimeGroupingType: Number - A DateTimeGroupingType value. DateTimeGroupingType

year: Number - The year.

month: Number - The month.

day: Number - The day.

hour: Number - The hour.

minute: Number - The minute.

second: Number - The second.

function removeDateFilter(fieldIndex, dateTimeGroupingType, year, month, day, hour, minute, second)

Removes a date filter.

If DateTimeGroupingType is Year, only the param year effects. If DateTiemGroupingType is Month, only the param year and month effect.

Parameters:

fieldIndex: Number - The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).

dateTimeGroupingType: Number - A DateTimeGroupingType value. DateTimeGroupingType

year: Number - The year.

month: Number - The month.

day: Number - The day.

hour: Number - The hour.

minute: Number - The minute.

second: Number - The second.

function removeFilter(fieldIndex, criteria)

Removes a filter for a filter column.

Parameters:

fieldIndex: Number - The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).

criteria: String - The specified criteria (a string; for example, "101"). It only can be null or be one of the cells' value in this column.

function filter(fieldIndex, criteria)

Filters a list with specified criteria.

Aspose.Cells will remove all other filter setting on this field as Ms Excel 97-2003.

Parameters:

fieldIndex: Number - The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).

criteria: String - The specified criteria (a string; for example, "101").

function filterTop10(fieldIndex, isTop, isPercent, itemCount)

Filter the top 10 item in the list

Parameters:

fieldIndex: Number - The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).

isTop: boolean - Indicates whether filter from top or bottom

isPercent: boolean - Indicates whether the items is percent or count

itemCount: Number - The item count

function dynamicFilter(fieldIndex, dynamicFilterType)

Adds a dynamic filter.

Parameters:

fieldIndex: Number - The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).

dynamicFilterType: Number - A DynamicFilterType value. Dynamic filter type.

function addFontColorFilter(fieldIndex, color)

Adds a font color filter.

Parameters:

fieldIndex: Number - The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).

color: CellsColor - The CellsColor object.

function addFillColorFilter(fieldIndex, pattern, foregroundColor, backgroundColor)

Adds a fill color filter.

Parameters:

fieldIndex: Number - The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).

pattern: Number - A BackgroundType value. The background pattern type.

foregroundColor: CellsColor - The foreground color.

backgroundColor: CellsColor - The background color.

function addIconFilter(fieldIndex, iconSetType, iconId)

Adds an icon filter.

Only supports to add the icon filter. Not supports checking which row is visible if the filter is icon filter.

Parameters:

fieldIndex: Number - The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).

iconSetType: Number - A IconSetType value. The icon set type.

iconId: Number - The icon id.

function matchBlanks(fieldIndex)

Match all blank cell in the list.

Parameters:

fieldIndex: Number - The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).

function matchNonBlanks(fieldIndex)

Match all not blank cell in the list.

Parameters:

fieldIndex: Number - The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).

function custom(fieldIndex, operatorType1, criteria1)

Filters a list with a custom criteria.

Parameters:

fieldIndex: Number - The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).

operatorType1: Number - A FilterOperatorType value. The filter operator type

criteria1: Object - The custom criteria

function custom(fieldIndex, operatorType1, criteria1, isAnd, operatorType2, criteria2)

Filters a list with custom criteria.

Parameters:

fieldIndex: Number - The integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).

operatorType1: Number - A FilterOperatorType value. The filter operator type

criteria1: Object - The custom criteria

isAnd: boolean -

operatorType2: Number - A FilterOperatorType value. The filter operator type

criteria2: Object - The custom criteria

function showAll()

Unhide all rows.

function removeFilter(fieldIndex)

Remove the specific filter.

Parameters:

fieldIndex: Number - The specific filter index

function refresh()

Refresh auto filters to hide or unhide the rows.

Returns:

Returns all hidden rows' indexes.

function refresh(hideRows)

Gets all hidden rows's indexes.

Parameters:

hideRows: boolean - If true, hide the filtered rows.

Returns:

Returns all hidden rows indexes.