Interface IEChartsPortlet

ECharts组件接口对象

Hierarchy 层级

IPortlet
- IEChartsPortlet

Index 目录

Methods 方法

Methods 方法

addChartsListener

addChartsListener(event: EChartEvent, callback: (params: EChartEventParams) => void): void

监听EChart事件
version

9.7.0

since
9.7.0

示例代码
```
 portlet.addChartsListener('click', function (params) {
   alert('点击了')
 })
```
示例图
Parameters 参数
- event: EChartEvent
  
  EChart事件
- callback: (params: EChartEventParams) => void
  
  事件回调函数
  - - (params: EChartEventParams): void
    - Parameters 参数
      - params: EChartEventParams
      Returns 返回值 void
Returns 返回值 void

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

cancelAsFilter

cancelAsFilter(): void

取消作为筛选器
version

10.5.0

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

doExport

doExport(exportType: ExportType): void

导出组件
version

10.5.0

since
10.5.0
- 示例
```
portlet.doExport(ExportType.EXCEL);
```
Parameters 参数
- exportType: ExportType
Returns 返回值 void

getChartInstance

getChartInstance(): EChartInstance

获取EChart实例

需要等组件渲染完成，也就是在onAfterRender（组件渲染后事件）中才能获取到EChart示例。

Returns 返回值 EChartInstance

getChartOptions

getChartOptions(): EChartOptions

获取EChart配置项

version

9.7.0

since

9.7.0

Returns 返回值 EChartOptions

getId

getId(): string

获取组件id

version

9.7.0

since

9.7.0

Returns 返回值 string

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

getTooltipHandler

getTooltipHandler(handler: TooltipHandler): void

获取tooltip信息处理函数

version

9.7.0

since

9.7.0

Parameters 参数
- handler: TooltipHandler
  
  单个tooltip的字段信息回调函数
Returns 返回值 void

getType

getType(): string

获取组件类型

version

9.7.0

since

9.7.0

Returns 返回值 string

hide

hide(): void

隐藏组件

version

9.7.0

since

9.7.0

Returns 返回值 void

isAsFilter

isAsFilter(): boolean

当前组件是否作为筛选器
version

10.5.0

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

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

removeCss

removeCss(): void

移除自定义CSS

version

9.7.0

since

9.7.0

Returns 返回值 void

resetLinkage

resetLinkage(): void

重置联动
version

10.5.0

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

restoreDown

restoreDown(): void

还原最大化
version

10.5.0

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

setAsFilter

setAsFilter(): void

设置当前组件作为筛选器
version

10.5.0

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

setChartOptions

setChartOptions(options: EChartOptions): void

设置EChart配置项

通常需要先调用getChartOptions获得到options后，再做改动，如果直接new新的options原配置将失效。

建议在onBeforeRender(组件渲染前事件)中进行设置，可以有效避免图表多次刷新。
version

9.7.0

since
9.7.0

示例代码
```
let options = portlet.getChartOptions()
options.yAxis.min = 200
portlet.setChartOptions(options)
```
示例图
Parameters 参数
- options: EChartOptions
  
  EChart配置项
Returns 返回值 void

setTitle

setTitle(title: string): void

设置组件标题

version

9.7.0

since

9.7.0

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

show

show(): void

显示组件

version

9.7.0

since

9.7.0

Returns 返回值 void