类: BasicFilter

dashboard.VisualNS.BasicFilter

就像内置标签筛选器， 等效的 SQL 是：

SELECT * FROM table WHERE Dept IN ( DTD1 , DTD2 , DTD3 )

Hierarchy

• FilterBase

  ↳ BasicFilter

Table of contents

构造方法

• constructor

方法

• add
• contains
• fromJSON
• getOperator
• getValues
• isEmpty
• remove
• setOperator
• setValues
• toJSON

构造方法

constructor

• new BasicFilter(targetProfile, operator?, values?)

参数

名称	类型	描述
targetProfile	IFieldProfile	数据视图中的 filter 字段。
operator?	BasicFilterOperator	默认的操作符是 “in”。
values?	any[]	筛选器值。

Overrides

FilterBase.constructor

方法

add

▸ add(val): any

添加一个筛选器值。

参数

名称	类型
val	any

返回值

any

---

contains

▸ contains(value): boolean

返回一个布尔值，判断当前筛选器值是否包含指定值。

参数

名称	类型
value	any

返回值

boolean

---

fromJSON

▸ fromJSON(obj): any

从 updateOptions.filters 获取筛选器值。

参数

名称	类型
obj	IBasicFilter

返回值

any

Overrides

FilterBase.fromJSON

---

getOperator

▸ getOperator(): BasicFilterOperator

获取操作符。

返回值

BasicFilterOperator

---

getValues

▸ getValues(): any[]

获取筛选器值。

返回值

any[]

---

isEmpty

▸ isEmpty(): boolean

返回一个 bool 值，判断筛选器值是否是空。

返回值

boolean

Overrides

FilterBase.isEmpty

---

remove

▸ remove(val): any

移除一个筛选器值。

参数

名称	类型
val	any

返回值

any

---

setOperator

▸ setOperator(operator): any

设置操作符。

参数

名称	类型
operator	BasicFilterOperator

返回值

any

示例代码

this.filter.setOperator(this.filter.getOperator() === WynVisual.Enums.BasicFilterOperator.In ?
	WynVisual.Enums.BasicFilterOperator.NotIn :
	WynVisual.Enums.BasicFilterOperator.In
)

---

setValues

▸ setValues(vals): any

设置筛选器值。

参数

名称	类型
vals	any[]

返回值

any

示例代码

filter.setValues(['DTD1', 'DTD2'])

---

toJSON

▸ toJSON(): IBasicFilter

返回一个基本筛选器对象。

返回值

IBasicFilter

Overrides

FilterBase.toJSON