API
Component

GridFilter ($UI/system/components/justep/gridFilter/gridFilter)

使用范围：UI2

Contents

component GridFilter ($UI/system/components/justep/gridFilter/gridFilter) extends ViewComponent

选择过滤组件

	
		GridFilter组件通过简单的属性设置就可以给数据增加选择过滤的能力，关键属性有：
			filterData: 过滤数据
			filterCol: 过滤列
		GridFilter是组合组件，内置gridSelect，它自动将用户从gridSelect中选择的数据构造成数据集的过滤条件

Constructor Top

  GridFilter ()
  GridFilter ( options)

Properties Top

observable selectedLabel

选中数据的显示值，可以通过set和get方法存取。
observable selectedValue

选中数据，可以通过set和get方法存取。

Attributes Top

boolean autoRefresh

是否自动刷新 - 默认是true，用户输入后不仅设置数据的过滤条件，同时自动刷新数据。
string defaultValue

默认值，当选择数据为空时，用默认值过滤；与内置gridSelect组件的defaultLabel属性配合使用。
string filterCol

过滤列
string filterData

过滤数据集ID，必须是bizData
string xid

组件标识

Methods Top

void clear ()
void filter ()
Data getFilterData ()
string getFilterFlag ()
string getFilterStr ()

Operations Top

clearFilter ()

Events Top

void onFilter (ViewEvent event)

Constructor details Top

public GridFilter ()

选择过滤组件

	
		GridFilter组件通过简单的属性设置就可以给数据增加选择过滤的能力，关键属性有：
			filterData: 过滤数据
			filterCol: 过滤列
		GridFilter是组合组件，内置gridSelect，它自动将用户从gridSelect中选择的数据构造成数据集的过滤条件

public GridFilter ( options)

构造函数

Inherited from ViewComponent

	
		参数options格式类似{parent:xx, config:{}}，parent是组件的父节点，允许为空或不指定，config是组件的参数选项

Parameters

options

参数选项

Properties Detail Top

public observable selectedLabel

选中数据的显示值，可以通过set和get方法存取。

public observable selectedValue

选中数据，可以通过set和get方法存取。

Attributes Detail Top

public boolean autoRefresh

是否自动刷新 - 默认是true，用户输入后不仅设置数据的过滤条件，同时自动刷新数据。

public string defaultValue

默认值，当选择数据为空时，用默认值过滤；与内置gridSelect组件的defaultLabel属性配合使用。

public string filterCol

过滤列

public string filterData

过滤数据集ID，必须是bizData

public string xid

组件标识

Methods Detail Top

public void clear ()

清除过滤条件

Return Value

void

public void filter ()

设置数据的过滤条件，如果“自动刷新”则刷新数据；开发者可以通过onFilter事件接管。

Return Value

void

public Data getFilterData ()

获取过滤数据集对象

Return Value

Data

public string getFilterFlag ()

获取过滤条件标识

Return Value

string

public string getFilterStr ()

获取过滤条件字符串

Return Value

string

Operations Detail Top

public clearFilter ()

清除过滤条件

Events Detail Top

public void onFilter (ViewEvent event)

过滤事件

	
		var value = event.source.selectedValue.get();
		...
		if (event.source.autoRefresh) {
			event.source.getFilterData().refreshData();
		}

Parameters

ViewEvent event


结构如下：

{ "source" : 组件的js对象 "bindingContext" : 组件绑定的上下文，包含$model、$object等具体请参考bindingContext说明 }

Return Value

void