• 简体中文
  • DashboardChartBuilder

    方法

    constructor

    定义:

    constructor(widget: Y.Map<any>, options?: DashboardChartBuilderOptions<TQueryDSL, TSeedDSL>)

    参数:

    参数类型说明
    widgetY.Map-
    options? = {}DashboardChartBuilderOptions<TQueryDSL, TSeedDSL>-

    getId

    获取仪表盘组件 ID。

    定义:

    getId(): string

    返回: string

    getBuilder

    解析组件引用的资源构建器;其文档与撤销历史独立于仪表盘。

    定义:

    getBuilder(): VBIChartBuilder<TQueryDSL, TSeedDSL> | undefined

    返回: VBIChartBuilder<TQueryDSL, TSeedDSL> \| undefined

    setTitle

    设置组件标题,修改由所属仪表盘的 undoManager 追踪。

    定义:

    setTitle(title: string): this

    返回: this

    参数:

    参数类型说明
    titlestring-

    setDescription

    设置组件描述。

    定义:

    setDescription(description: string): this

    返回: this

    参数:

    参数类型说明
    descriptionstring-

    setChart

    设置引用的图表资源或 UUID,不复制或修改资源内容。

    定义:

    setChart(chart: ResourceReference): this

    返回: this

    参数:

    参数类型说明
    chartResourceReference-

    setLayouts

    设置本次 add / update 回调提交的断点布局;在 collection 回调外调用不会写入仪表盘。

    定义:

    setLayouts(layouts: DashboardWidgetLayouts): this

    返回: this

    参数:

    参数类型说明
    layoutsDashboardWidgetLayouts-

    toJSON

    导出组件的纯 JSON 配置。

    定义:

    toJSON(): VBIDashboardWidget

    返回: VBIDashboardWidget