通过

创建视觉对象

  • 项目

此 API 提供了在报表页上创建新视觉对象的方法。

如何创建视觉对象并将其绑定到数据

创建特定类型的空视觉对象，然后将视觉对象绑定到数据字段。 有关视觉对象类型的列表，请参阅现用的视觉对象类型。

注意

不能将未安装在可视化效果窗格中的视觉对象添加到报表中。 这适用于未安装和已卸载的现成视觉对象的自定义视觉对象。

  1. 使用以下参数配置要创建的视觉对象：

    • 视觉对象类型：要创建的视觉对象类型，例如 barChart。
    • 布局（可选）：要应用于新视觉对象的布局。
    • autoFocus（可选）：选择页面是否自动滚动到新创建的视觉对象（默认设置为“True”）。

  2. 使用以下方法创建视觉对象：

    createVisual(visualType: string, layout?: models.IVisualLayout, autoFocus?: boolean): Promise<models.ICreateVisualResponse>

返回的值包含一个对象，该对象表示新创建的视觉对象。 可以使用 视觉对象数据绑定 和 视觉属性 API 根据需要编辑视觉对象。

例如：

let createVisualResponse = await page.createVisual('areaChart');
let visual = createVisualResponse.visual;

代码示例

以下代码示例演示如何创建具有不同参数的视觉对象。

注意

有关创建自定义布局的信息，请参阅 视觉布局。

使用自定义布局和无焦点创建面积图视觉对象。

const customLayout = {
    x: 20,
    y: 35,
    width: 1600,
    height: 1200
}

let createVisualResponse = await page.createVisual('areaChart', customLayout, false /* autoFocus */);

创建具有默认布局的面积图。

let createVisualResponse = await page.createVisual('areaChart');

可用的现用视觉对象类型

  • actionButton

  • areaChart

  • barChart

  • basicShape

  • 卡

  • clusteredBarChart

  • clusteredColumnChart

  • columnChart

  • debugVisual

  • 分解树

  • donutChart

  • esriVisual

  • filledMap

  • 漏斗

  • 轨距

  • hundredPercentStackedBarChart

  • hundredPercentStackedColumnChart

  • 图像

  • keyDriversVisual

  • kpi

  • lineChart

  • lineClusteredColumnComboChart

  • lineStackedColumnComboChart

  • 地图

  • multiRowCard

  • pieChart

  • pivotTable

  • PowerApps

  • pythonVisual

  • qnaVisual

  • ribbonChart

  • 散点图

  • scriptVisual

  • shapeMap

  • 切片机

  • stackedAreaChart

  • tableEx

  • 文本框

  • treemap

  • 瀑布图

局限性

视觉对象创建 API 仅在呈现报表后可用。 仅在调用报表后侦听报表 rendered 事件并触发视觉创作 API。 有关详细信息，请参阅 事件处理。

后续步骤

更改视觉对象类型

配置数据字段

设置视觉对象属性格式