Interface IFilterPortlet

Hierarchy 层级

IPortlet
- IFilterPortlet

Index 目录

Methods 方法

appendCss

appendCss(selector: CssSelector, style: CssObject | string): void

增加自定义CSS样式（样式只对当前组件生效）
version

9.7.0

since
9.7.0

示例代码1 给标题栏加CSS,改变标题栏颜色
```
portlet.appendCss('.portlet-title-text-default', {
  'color': '#fff',
  'background': 'rgb(0,0,255)',
  'font-size': '16px'
})
```
示例图1

示例代码2 给静态文本组件内容加CSS,改变文本样式(注意只在静态文本组件中生效)
```
portlet.appendCss('.text-object__processedContent', {
   'color': '#f00',
   'background': 'rgb(0,255,0)',
})
```
示例图2
Parameters 参数
- selector: CssSelector
  
  css选择器
- style: CssObject | string
  
  css样式对象
Returns 返回值 void

getId

getId(): string

获取组件id

version

9.7.0

since

9.7.0

Returns 返回值 string

getStandByValues

getStandByValues(): Array<IStandByValue>

获取筛选器备选值
version

10.1.0

since
10.1.0

示例
```
let standByValues: Array<IStandByValue> = portlet.getStandByValues();
```
注意目前只有列表、下拉类型的筛选器可以获取到备选值
Returns 返回值 Array<IStandByValue>

备选值，包含显示值与真实值
仅下拉筛选器和列表筛选器有备选值

getTitle

getTitle(): string

获取组件标题

version

9.7.0

since

9.7.0

Returns 返回值 string

getToolbar

getToolbar(): IPortletToolbar

获取组件工具栏
version

10.5.0

since
10.5.0
- 示例
```
let toolbar: IPortletToolbar = portlet.getToolbar();
```
Returns 返回值 IPortletToolbar

getType

getType(): string

获取组件类型

version

9.7.0

since

9.7.0

Returns 返回值 string

getValue

getValue(): Array<string>

获取参数值
version

9.7.0

since
9.7.0

示例
```
let value = portlet.getValue()
```
Returns 返回值 Array<string>

Array

hide

hide(): void

隐藏组件

version

9.7.0

since

9.7.0

Returns 返回值 void

isMaximized

isMaximized(): boolean

当前组件是否是最大化状态
version

10.5.0

since
10.5.0
- 示例
```
let isMaximized: boolean = portlet.isMaximized();
```
Returns 返回值 boolean

maximize

maximize(): void

最大化组件，目前仅支持图形、表格、web电子表格、tab组件以及URL组件调用
version

10.5.0

since
10.5.0
- 示例
```
portlet.maximize();
```
Returns 返回值 void

pauseCarousel

pauseCarousel(): void

暂停筛选器备选值轮播，可以通过调用turnOnCarousel恢复轮播
version

10.1.0

since
10.1.0

示例
```
portlet.pauseCarousel();
```
Returns 返回值 void

removeCss

removeCss(): void

移除自定义CSS

version

9.7.0

since

9.7.0

Returns 返回值 void

restoreDown

restoreDown(): void

还原最大化
version

10.5.0

since
10.5.0
- 示例
```
portlet.restoreDown();
```
Returns 返回值 void

setFilterValueChangeHandler

setFilterValueChangeHandler(handler: FilterValueChangeHandler): void

设置筛选器输入值处理函数

可以动态改变筛选器的值
version

9.7.0

since
9.7.0

示例代码
```
portlet.setFilterValueChangeHandler(function (value: Array) {
  // 可以对value做处理
  return value
})
```
Parameters 参数
- handler: FilterValueChangeHandler
  
  筛选器输入值处理函数
Returns 返回值 void

setRenderOptionHandler

setRenderOptionHandler(handler: IFilterTableHandler): void

设置筛选器备选项处理函数
version

9.7.0

since
9.7.0

示例
```
portlet.setRenderOptionHandler(function (row: IFilterRow, column: IFilterColumn, rowIndex: number, columnIndex: number) {})
```
注意

目前只支持列表单选、列表多选类型的筛选器，不支持其他类型的筛选器
Parameters 参数
- handler: IFilterTableHandler
Returns 返回值 void

备选值分页列表

setTitle

setTitle(title: string): void

设置组件标题

version

9.7.0

since

9.7.0

Parameters 参数
- title: string
  
  标题
Returns 返回值 void

setValue

setValue(value: string[]): void

设置参数值
version

9.7.0

since
9.7.0

示例
```
portlet.setValue(['海鲜'])
```
Parameters 参数
- value: string[]
  
  设置的值
Returns 返回值 void

show

show(): void

显示组件

version

9.7.0

since

9.7.0

Returns 返回值 void

turnOffCarousel

turnOffCarousel(): void

停止筛选器备选值轮播，再调用turnOnCarousel的时候会从第一个备选值开始
version

10.1.0

since
10.1.0

示例
```
portlet.turnOffCarousel();
```
Returns 返回值 void

turnOnCarousel

turnOnCarousel(options?: ICarouselOptions): void

启动\恢复筛选器备选值轮播
version

10.1.0

since
10.1.0

示例
```
portlet.turnOnCarousel();
```
注意不传参数的时候将使用默认配置
Parameters 参数
- Optional options: ICarouselOptions
  
  轮播选项，如果不传递则使用默认选项
Returns 返回值 void