GC.Spread.Sheets.Filter.HideRowFilter

类: HideRowFilter

Sheets.Filter.HideRowFilter

继承关系

RowFilterBase

↳ HideRowFilter

构造方法

constructor

属性

方法

构造方法

constructor

• new HideRowFilter(range?)

默认的行筛选

代码示例

//下面的示例创建一个新的筛选
sheet.rowFilter(new GC.Spread.Sheets.Filter.HideRowFilter(new GC.Spread.Sheets.Range(0,0,4,4)));
sheet.repaint();

参数

属性名	类型	说明
`range?`	`Range`	筛选区域

Overrides

RowFilterBase.constructor

属性

extendedRange

• extendedRange: Range

行筛选的extendedRange

继承自

RowFilterBase.extendedRange

range

• range: Range

行筛选的区域

继承自

RowFilterBase.range

typeName

• typeName: string

支持序列化的类型名称字符串

继承自

RowFilterBase.typeName

方法

addFilterItem

▸ addFilterItem(col, condition): void

将指定的筛选添加到行筛选

代码示例

sheet.setRowCount(3);
sheet.setColumnCount(1);
sheet.setArray(0, 0,
    [
        [ 1 ],
        [ 2 ],
        [ 3 ]
    ]);
sheet.rowFilter(new GC.Spread.Sheets.Filter.HideRowFilter(new GC.Spread.Sheets.Range(-1, -1, -1, -1)));
var condition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.textCondition, {compareType: GC.Spread.Sheets.ConditionalFormatting.TextCompareType.equalsTo,expected: '3'});
sheet.rowFilter().addFilterItem(0, condition);
sheet.rowFilter().filter(0);

参数

属性名	类型	说明
`col`	`number`	列索引
`condition`	`Condition`	要筛选的条件

返回值

void

继承自

RowFilterBase.addFilterItem

filter

▸ filter(col?): void

筛选指定的列

代码示例

sheet.setRowCount(2);
sheet.setColumnCount(1);
sheet.setArray(0, 0,
    [
        [ "a" ],
        [ "b" ]
    ]);
sheet.rowFilter(new GC.Spread.Sheets.Filter.HideRowFilter(new GC.Spread.Sheets.Range(-1, -1, -1, -1)));
var condition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.textCondition, {compareType: GC.Spread.Sheets.ConditionalFormatting.TextCompareType.equalsTo,expected: 'a'});
var rowFilter = sheet.rowFilter();
rowFilter.addFilterItem(0, condition);
rowFilter.filter(0);

参数

属性名	类型	说明
`col?`	`number`	要筛选的列的索引；如果省略，则将筛选区域内的所有列

返回值

void

继承自

RowFilterBase.filter

filterButtonVisible

▸ filterButtonVisible(col?, value?): any

获取或设置是否显示表单列的筛选按钮

代码示例

sheet.setArray(2, 2,
    [
        [ 1, 4 ],
        [ 2, 5 ],
        [ 3, 6 ]
    ] );
sheet.rowFilter(new GC.Spread.Sheets.Filter.HideRowFilter(new GC.Spread.Sheets.Range(2, 2, 3, 2)));
console.log(sheet.rowFilter().filterButtonVisible()); // true
sheet.rowFilter().filterButtonVisible(2, false);
console.log(sheet.rowFilter().filterButtonVisible(2)); // false
console.log(sheet.rowFilter().filterButtonVisible(3)); // true

参数

属性名	类型	说明
`col?`	`number`	筛选按钮的列索引
`value?`	`boolean`	是否显示筛选按钮

返回值

any

 没有参数时，如果所有筛选按钮都不可见，返回false,否则返回true
 有一个参数 col 时，如果指定的列筛选按钮不可见，返回false,否则返回true
 一个参数值` GC.Spread.Sheets.Filter.RowFilterBase `将所有筛选按钮设置为可见(true)/ 不可见(false)
 两个参数col,value ` GC.Spread.Sheets.Filter.RowFilterBase `将指定的列筛选按钮设置为可见(true)/ 不可见(false)

继承自

RowFilterBase.filterButtonVisible

filterDialogVisibleInfo

▸ filterDialogVisibleInfo(visibleInfo?): any

获取或设置行筛选的可见信息

代码示例

//This example creates a row filter.
 sheet.rowFilter(new GC.Spread.Sheets.Filter.HideRowFilter(new GC.Spread.Sheets.Range(1, 1, 10, 3)));
 var filter = sheet.rowFilter();
 filter.filterDialogVisibleInfo({
     sortByValue : false,
     sortByColor : true,
     filterByColor : true,
     filterByValue : true,
     listFilterArea : false
 });

参数

属性名	类型	说明
`visibleInfo?`	`IFilterDialogVisibleInfo`	行筛选的可见信息

返回值

any

如果未设置任何值，则筛选对话框可见信息；否则，返回HideRowFilter

fromJSON

▸ fromJSON(settings): void

从指定的JSON字符串加载对象状态

参数

属性名	类型	说明
`settings`	`Object`	设置反序列化的行筛选数据

返回值

void

继承自

RowFilterBase.fromJSON

getFilterItems

▸ getFilterItems(col): Condition[]

获取指定列的筛选

代码示例

sheet.getCell(0, 0).value("a");
sheet.getCell(0, 1).value("b");
sheet.getCell(1, 0).value("ac");
sheet.getCell(1, 1).value("bd");
sheet.rowFilter( new GC.Spread.Sheets.Filter.HideRowFilter(new GC.Spread.Sheets.Range( -1, -1, -1, -1)));
var condition1 =  new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.textCondition, { compareType: GC.Spread.Sheets.ConditionalFormatting.TextCompareType.equalsTo,expected: 'a' });
var condition2 = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.textCondition, { compareType: GC.Spread.Sheets.ConditionalFormatting.TextCompareType.equalsTo,beginsWith: '' });
sheet.rowFilter().addFilterItem(0, condition1);
sheet.rowFilter().addFilterItem(1, condition2);
console.log(sheet.rowFilter().getFilterItems(0)); // result is array, length is 1, and the item equals to condition1.

参数

属性名	类型	说明
`col`	`number`	列索引

返回值

Condition[]

返回包含属于指定列的条件的集合

继承自

RowFilterBase.getFilterItems

getFilteredItems

▸ getFilteredItems(): Condition[]

获取所有筛选条件

代码示例

sheet.setRowCount(3);
sheet.setColumnCount(2);
sheet.setArray(0, 0,
    [
        [ 1, 2 ],
        [ 3, 4 ],
        [ 5, 6 ]
    ]);
sheet.rowFilter(new GC.Spread.Sheets.Filter.HideRowFilter(new GC.Spread.Sheets.Range(-1, -1, -1, -1)));
var condition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.numberCondition, { compareType: GC.Spread.Sheets.ConditionalFormatting.GeneralComparisonOperators.greaterThan, expected: 1 });
var condition1 = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.numberCondition, { compareType: GC.Spread.Sheets.ConditionalFormatting.GeneralComparisonOperators.greaterThan, expected: 4 });
sheet.rowFilter().addFilterItem(0, condition);
sheet.rowFilter().addFilterItem(1, condition1);
console.log(sheet.rowFilter().getFilteredItems().length); // 0
sheet.rowFilter().filter();
console.log(sheet.rowFilter().getFilteredItems().length); // 2
sheet.rowFilter().removeFilterItems(0);
console.log(sheet.rowFilter().getFilteredItems().length); // 1
sheet.rowFilter().removeFilterItems(1);
console.log(sheet.rowFilter().getFilteredItems().length); // 0

返回值

Condition[]

返回包含所有筛选条件的集合

继承自

RowFilterBase.getFilteredItems

getSortState

▸ getSortState(col): SortState

获取当前的排序状态

代码示例

sheet.setArray(0, 0, [
    [ 4 ],
    [ 3 ],
    [ 2 ],
    [ 1 ],
    [ 0 ]
]);
sheet.rowFilter( new GC.Spread.Sheets.Filter.HideRowFilter( new GC.Spread.Sheets.Range( 0, 0, 5, 1 ) ) );
sheet.rowFilter().addFilterItem( 0, new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.numberCondition, { compareType: GC.Spread.Sheets.ConditionalFormatting.GeneralComparisonOperators.greaterThan, expected: 2 }));
sheet.rowFilter().filter(0);
sheet.rowFilter().sortColumn(0, false);
console.log(sheet.rowFilter().getSortState(0)); // 2

参数

属性名	类型	说明
`col`	`number`	列索引

返回值

SortState

当前筛选的排序状态

继承自

RowFilterBase.getSortState

isFiltered

▸ isFiltered(col?): boolean

获取一个值，该值是否筛选任何行或指定的列

代码示例

//本示例使用isFiltered方法
activeSheet.setValue(0, 0, "North");
activeSheet.setValue(1, 0, "South");
activeSheet.setValue(2, 0, "East");
activeSheet.setValue(3, 0, "South");
activeSheet.setValue(4, 0, "North");
activeSheet.setValue(5, 0, "North");
activeSheet.setValue(6, 0, "West");
activeSheet.setColumnWidth(0, 80);
//设置一个行筛选
activeSheet.rowFilter(new GC.Spread.Sheets.Filter.HideRowFilter(new GC.Spread.Sheets.Range(0, 0, 7, 1)));
//button
$("#button1").click(function () {
    var rowFilter = spread.getActiveSheet().rowFilter();
    if (rowFilter.isFiltered(0)) {
        alert("Row-filtering executed for Column1");
    } else {
        alert("Row-filtering not executed for Column1");
    }
});
//将按钮控件添加到页面
<input type="button" id="button1" value="button1"/>

参数

属性名	类型	说明
`col?`	`number`	列索引

返回值

boolean

不传参时，如果某些行被筛选，返回true;否则返回false. 传一个col参数时，如果指定的列已筛选，返回true;否则为false

继承自

RowFilterBase.isFiltered

isRowFilteredOut

▸ isRowFilteredOut(row): boolean

确定是否将指定的行筛选掉

代码示例

sheet.setRowCount(2);
sheet.setColumnCount(1);
sheet.setArray(0, 0,
    [
        [ 1 ],
        [ 2 ]
    ] );
sheet.rowFilter(new GC.Spread.Sheets.Filter.HideRowFilter(new GC.Spread.Sheets.Range(-1, -1, -1, -1)));
var condition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.textCondition, {compareType: GC.Spread.Sheets.ConditionalFormatting.TextCompareType.equalsTo,expected: '2'});
sheet.rowFilter().addFilterItem(0, condition);
sheet.rowFilter().filter(0);
sheet.addRows(1, 1);
console.log(sheet.rowFilter().isFiltered()); // true
console.log(sheet.rowFilter().isRowFilteredOut(0)); // true
console.log(sheet.rowFilter().isRowFilteredOut(1)); // false

参数

属性名	类型	说明
`row`	`number`	行索引

返回值

boolean

如果该行被筛选，返回true;否则返回false

继承自

RowFilterBase.isRowFilteredOut

onFilter

▸ onFilter(args): void

当某些列被筛选或未筛选时执行操作

代码示例

sheet.setRowCount(3);
sheet.setColumnCount(2);
sheet.setArray(0, 0,
    [
        [ 1, 2 ],
        [ 3, 4 ],
        [ 5, 6 ]
    ]);
function HighLightFilter(range) {
    GC.Spread.Sheets.Filter.RowFilterBase.call(this, range);
}
HighLightFilter.prototype = new  GC.Spread.Sheets.Filter.RowFilterBase(new GC.Spread.Sheets.Range(-1, -1, -1, -1));
var doFilterCalled = false;
HighLightFilter.prototype.onFilter = function(args) {
    if ( args.action ===  GC.Spread.Sheets.Filter.FilterActionType.filter ) {
        doFilterCalled = true;
    }
};
sheet.rowFilter(new HighLightFilter(new GC.Spread.Sheets.Range(-1, -1, -1, -1)));
var condition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.numberCondition, { compareType: GC.Spread.Sheets.ConditionalFormatting.GeneralComparisonOperators.greaterThan, expected: 1 });
sheet.rowFilter().addFilterItem(0, condition);
sheet.rowFilter().filter();
console.log(doFilterCalled); // true

参数

属性名	类型	说明
`args`	`IFilteredArgs`	包含action、sheet、range、filteredRows和filteredOutRows的对象

返回值

void

继承自

RowFilterBase.onFilter

openFilterDialog

▸ openFilterDialog(filterButtonHitInfo): void

当用户单击筛选按钮时，打开筛选对话框

代码示例

sheet.setRowCount(3);
sheet.setColumnCount(2);
sheet.setArray(0, 0,
    [
        [ 1, 2 ],
        [ 3, 4 ],
        [ 5, 6 ]
    ]);
function HighLightFilter(range) {
    GC.Spread.Sheets.Filter.RowFilterBase.call(this, range);
}
HighLightFilter.prototype = new  GC.Spread.Sheets.Filter.RowFilterBase(new GC.Spread.Sheets.Range(-1, -1, -1, -1));
HighLightFilter.prototype.openFilterDialog = function(args) {
    console.log(args.row, args.col);
};
sheet.rowFilter(new HighLightFilter(new GC.Spread.Sheets.Range(-1, -1, -1, -1)));

参数

属性名	类型	说明
`filterButtonHitInfo`	`IFilterButtonHitInfo`	有关筛选按钮的点击测试信息

返回值

void

继承自

RowFilterBase.openFilterDialog

removeFilterItems

▸ removeFilterItems(col): void

删除指定的筛选

代码示例

sheet.setRowCount(3);
sheet.setColumnCount(1);
sheet.setArray(0, 0,
    [
        [ 1 ],
        [ 2 ],
        [ 3 ]
    ]);
sheet.rowFilter(new GC.Spread.Sheets.Filter.HideRowFilter(new GC.Spread.Sheets.Range( -1, -1, -1, -1)));
var condition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.textCondition, {compareType: GC.Spread.Sheets.ConditionalFormatting.TextCompareType.equalsTo, expected: '3'});
var rowFilter = sheet.rowFilter();
rowFilter.addFilterItem(0, condition);
rowFilter.removeFilterItems(0);

参数

属性名	类型	说明
`col`	`number`	列索引

返回值

void

继承自

RowFilterBase.removeFilterItems

reset

▸ reset(): void

清除所有筛选

代码示例

sheet.rowFilter(new GC.Spread.Sheets.Filter.HideRowFilter(new GC.Spread.Sheets.Range(-1, -1, -1, -1)));
sheet.rowFilter().reset();
console.log(sheet.rowFilter().isFiltered()); // false

返回值

void

继承自

RowFilterBase.reset

sortColumn

▸ sortColumn(col, ascending): void

按指定顺序对指定列进行排序

代码示例

sheet.setArray(0, 0, [
    [ 4 ],
    [ 3 ],
    [ 2 ],
    [ 1 ],
    [ 0 ]
]);
sheet.rowFilter(new GC.Spread.Sheets.Filter.HideRowFilter(new GC.Spread.Sheets.Range(0, 0, 5, 1)));
sheet.rowFilter().addFilterItem(0, new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.numberCondition, { compareType: GC.Spread.Sheets.ConditionalFormatting.GeneralComparisonOperators.greaterThan, expected: 2 }));
sheet.rowFilter().filter(0);
sheet.rowFilter().sortColumn(0, true);

参数

属性名	类型	说明
`col`	`number`	列索引
`ascending`	`boolean`	排序时设置为true为升序

返回值

void

继承自

RowFilterBase.sortColumn

toJSON

▸ toJSON(): Object

将对象状态保存为JSON字符串

返回值

Object

行筛选数据

继承自

RowFilterBase.toJSON

unfilter

▸ unfilter(col?): void

从指定的列中删除筛选

代码示例

sheet.setRowCount(2);
sheet.setColumnCount(1);
sheet.setArray(0, 0,
    [
        [ "a" ],
        [ "b" ]
    ]);
sheet.rowFilter(new GC.Spread.Sheets.Filter.HideRowFilter(new GC.Spread.Sheets.Range(-1, -1, -1, -1)));
var condition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.textCondition, {compareType: GC.Spread.Sheets.ConditionalFormatting.TextCompareType.equalsTo,expected: 'a'});
var rowFilter = sheet.rowFilter();
rowFilter.addFilterItem(0, condition);
rowFilter.unfilter();

参数

属性名	类型	说明
`col?`	`number`	要删除筛选的列的索引；如果省略，则删除该区域内所有列筛选

返回值

void

继承自

RowFilterBase.unfilter

GC.Spread.Sheets.Filter.HideRowFilter

类: HideRowFilter

继承关系

Table of contents

构造方法

属性

方法

构造方法

constructor

参数

Overrides

属性

extendedRange

继承自

range

继承自

typeName

继承自

方法

addFilterItem

参数

返回值

继承自

filter

参数

返回值

继承自

filterButtonVisible

参数

返回值

继承自

filterDialogVisibleInfo

参数

返回值

fromJSON

参数

返回值

继承自

getFilterItems

参数

返回值

继承自

getFilteredItems

返回值

继承自

getSortState

参数

返回值

继承自

isFiltered

参数

返回值

继承自

isRowFilteredOut

参数

返回值

继承自

onFilter

参数

返回值

继承自

openFilterDialog

参数

返回值

继承自

removeFilterItems

参数

返回值

继承自

reset

返回值

继承自

sortColumn

参数

返回值

继承自

toJSON

返回值

继承自

unfilter