Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IPage

自助仪表盘页面接口对象

Hierarchy 层级

  • IPage

Index 目录

Methods 方法

Methods 方法

appendCss

  • 增加自定义CSS样式（样式只对当前仪表盘生效）

    version

    9.7.0

    since

    9.7.0

    Parameters 参数

    Returns 返回值 void

doExport

  • 导出仪表盘

    version

    10.5.0

    since

    10.5.0

    • 示例
    page.doExport(ExportType.EXCEL)

    Parameters 参数

    • exportType: ExportType

      导出格式，仅支持EXCEL、PNG、PDF格式

    Returns 返回值 void

doPortletRendered

  • 监听指定组件是否渲染完成的回调函数

    version

    9.7.0

    since

    9.7.0

    Parameters 参数

    Returns 返回值 void

getAlias

  • getAlias(): string

  • 获取自助仪表盘页面别名

    version

    9.7.0

    since

    9.7.0

    Returns 返回值 string

getId

  • getId(): string

  • 获取自助仪表盘id

    version

    9.7.0

    since

    9.7.0

    Returns 返回值 string

getName

  • getName(): string

  • 获取自助仪表盘页面名称

    version

    9.7.0

    since

    9.7.0

    Returns 返回值 string

getPageToolbar

  • 获取自助仪表盘工具栏接口对象

    version

    9.7.0

    since

    9.7.0

    Returns 返回值 IPageToolbar

getPortletById

  • getPortletById<T>(id: string): T

  • 根据组件id获取组件接口对象

    version

    9.7.0

    since

    9.7.0

    示例代码

    let portlet = page.getPortletById('{portletId}')

    Type parameters

    • T

    Parameters 参数

    • id: string

      组件id

    Returns 返回值 T

getPortletIds

  • getPortletIds(): string[]

  • 获取自助仪表盘下所有组件id

    version

    9.7.0

    since

    9.7.0

    Returns 返回值 string[]

getPortletsByTitle

  • getPortletsByTitle<T>(title: string): T

  • 根据组件标题获取组件接口对象，标题相同将返回多个接口对象

    version

    9.7.0

    since

    9.7.0

    示例代码

    let portlets = page.getPortletsByTitle('{title}')

    Type parameters

    • T

    Parameters 参数

    • title: string

      组件标题

    Returns 返回值 T

openLinkByType

  • 指定URL链接及打开方式打开页面

    version

    10.1.0

    since

    10.1.0

    • 示例
    // 传参给资源页面
let query = {
  targetInfo: {
    url: 'URL链接',
    method: 'GET',
    params: [{name: '名称', alias: '别名', value: ['真实值'], displayValue: ['显示值']}]
  }
}
// 新窗口打开
page.openLinkByType(query)
page.openLinkByType(query, 'NEW_WIN')
// 新Tab页打开
page.openLinkByType(query, 'NEW_TAB')
// 浮动框打开
page.openLinkByType(query, 'DIALOG')
// 替换源页面打开
page.openLinkByType(query, 'COVER_SELF')

    Parameters 参数

    • query: OpenLinkQuery

      参数信息

    • Optional type: OpenType | string

      打开方式（默认值：新窗口NEW_WIN）

    Returns 返回值 void

openResourceByType

  • 指定资源id和打开方式打开页面

    version

    10.1.0

    since

    10.1.0

    • 示例
    【不传参给资源页面】
page.openResourceByType('内部资源id')
page.openResourceByType('内部资源id', null)
page.openResourceByType('内部资源id', null, 'DIALOG')

【传参给资源页面】
let query = {
  paramInfo: [{name: '名称', alias: '别名', value: ['真实值'], displayValue: ['显示值']}]
}
// 新窗口打开
page.openResourceByType('内部资源id', query)
page.openResourceByType('内部资源id', query, 'NEW_WIN')
// 新Tab页打开
page.openResourceByType('内部资源id', query, 'NEW_TAB')
// 浮动框打开
page.openResourceByType('内部资源id', query, 'DIALOG')
// 替换源页面打开
page.openResourceByType('内部资源id', query, 'COVER_SELF')

    Parameters 参数

    • id: string

      目标资源id

    • Optional query: OpenResourceQuery

      参数信息

    • Optional type: OpenType | string

      打开方式（默认值：新窗口NEW_WIN）

    Returns 返回值 void

openResourceInTab

  • openResourceInTab(id: string, paramInfo: Array<string> | object): void

  • 新tab页打开

    version

    9.7.0

    since

    9.7.0

    • 示例
    // V模块资源
paramInfo = [{name: '名称', alias: '别名', value: '真实值', displayValue: '显示值'}]
// 自助仪表盘
paramInfo = {'名称': { values: ['真实值'] }, '名称2': { values: ['真实值'] }}

    Parameters 参数

    • id: string

      目标资源id

    • paramInfo: Array<string> | object

      参数数组

    Returns 返回值 void

removeCss

  • removeCss(): void

  • 移除自定义CSS

    version

    9.7.0

    since

    9.7.0

    Returns 返回值 void