Dashboard 仪表板

Dashboard

仪表板(Dashboard)类，YHP系统中的仪表板，一般包含一个或多个可视化组件（Widget）或输入（DashboardInput）， 同时也包含了各组件的布局信息（position）。

Dashboard的属性主要有：

• id: Dashboard的唯一标识
• title: Dashboard的标题
• widgets: 可视化组件（Widget）列表，类型为：array
• positions: 仪表板内容的布局信息
  • positions.type: 仪表板内容的布局方式，YHP 旧版本中可能存在row-column-layout的布局方式，在新版本中默认为grid-layout
  • positions.layout: 具体的布局信息，类型为：Array<object>

成员函数:

init(service: Service, dashboardId: string, namespace: object)

Dashboard对象的初始化方法，需要传入对应的dashboard服务实例

参数:

参数名称	参数类型	描述
service	Service	Dashboard Service的实例对象
dashboardId	string	Dashboard的唯一标识
namespace	object	命名空间，主要用于标识Dashboard所属的应用

widgets() → {Array.<Widget>}

返回这个Dashboard中所有可视化组件(Widget)

properties(includeWidget: boolean) → {object}

获取仪表板的所有属性

参数:

参数名称	参数类型	描述
includeWidget	boolean	返回的结果是否包含widgets

addWidget(widgetConfig: object, chartInsertPos: 'first' | 'last') → {Promise.<this>}

在Dashboard中添加一个可视化组件（Widget）

参数:

参数名称	参数类型	描述
widgetConfig	object	可视化组件的具体配置
chartInsertPos	'first' | 'last'	插入Widget的位置，'first'表示插入在所有已经存在的widget前面，'last'表示插入在最后

updateTokens(newTokens: object) → {Promise.<this>}

更新tokens部分的配置

参数:

参数名称	参数类型	描述
newTokens	object	新的tokens配置

updateBaseSearches(newBaseSearches: object) → {Promise.<this>}

更新基础查询。

参数:

参数名称	参数类型	描述
newBaseSearches	object	新的基础查询