告别数据混乱：Teable仪表盘API让数据可视化自动化

你是否还在为手动创建数据报表而烦恼？团队成员是否经常询问"最新销售数据在哪里"？Teable仪表盘API（应用程序接口）让这一切成为过去。通过简单的编程调用，你可以自动创建、配置和分享专业的数据仪表盘，将团队从重复劳动中解放出来。

读完本文后，你将能够：

• 使用API快速创建数据仪表盘
• 自定义仪表盘布局和组件
• 集成图表插件展示关键指标
• 实现仪表盘的自动化更新和管理

仪表盘API基础

Teable的仪表盘功能是数据可视化的核心，通过API可以完全控制这一功能。API相关的代码主要集中在以下位置：

• API定义：packages/openapi/src/dashboard/
• 后端实现：apps/nestjs-backend/src/features/dashboard/
• 测试示例：apps/nestjs-backend/test/dashboard.e2e-spec.ts

这些API支持完整的CRUD（创建、读取、更新、删除）操作，以及插件管理、布局调整等高级功能。

快速上手：创建你的第一个仪表盘

使用Teable仪表盘API只需三步：

1. 创建基础仪表盘

通过简单的API调用即可创建一个新的仪表盘：

// 创建仪表盘示例
const createResponse = await createDashboard(baseId, {
  name: "销售数据分析",
});
const dashboardId = createResponse.data.id;

2. 添加数据可视化组件

Teable支持多种图表类型，你可以根据需求添加：

// 安装图表插件
const installRes = await installPlugin(baseId, dashboardId, {
  name: "月度销售趋势",
  pluginId: "plgchart", // 图表插件ID
});

// 配置图表数据
await updateDashboardPluginStorage(
  baseId,
  dashboardId,
  installRes.data.pluginInstallId,
  {
    config: {
      type: "bar", // 柱状图
      xAxis: [{ column: "月份", display: { type: "bar", position: "auto" } }],
      yAxis: [{ column: "销售额", display: { type: "bar", position: "auto" } }],
    },
    query: {
      from: tableId, // 数据源表格ID
      select: [
        { column: monthFieldId, alias: "月份", type: "field" },
        { column: salesFieldId, alias: "销售额", type: "field" },
      ],
    },
  }
);

3. 调整布局

自定义仪表盘组件的位置和大小：

// 更新仪表盘布局
await updateLayoutDashboard(baseId, dashboardId, [
  { pluginInstallId: installRes.data.pluginInstallId, x: 0, y: 0, w: 8, h: 6 },
  // 可以添加更多组件...
]);

仪表盘实战效果

通过API创建的仪表盘可以展示多种数据视图，满足不同场景需求：

这个仪表盘整合了销售趋势图、地区分布饼图和关键指标卡片，所有元素都通过API精确配置。

高级功能

仪表盘复制

快速复制现有仪表盘及其所有配置：

// 复制仪表盘
const duplicateRes = await duplicateDashboard(baseId, sourceDashboardId, {
  name: "销售数据分析-副本",
});

插件管理

Teable支持多种仪表盘插件，可以通过API安装、更新和移除：

// 移除插件
await removePlugin(baseId, dashboardId, pluginInstallId);

开始使用

Teable仪表盘API为数据可视化提供了无限可能。无论你是开发自动化报表系统，还是构建自定义数据分析工具，这些API都能帮你快速实现目标。

要了解更多细节，请查看：

• 官方文档：README.md
• API测试示例：dashboard.e2e-spec.ts

现在就开始用代码创建你的第一个自动化数据仪表盘吧！