文件下载 API

  • 版本 :2023.1(当前版本)

文件下载 API

通过文件下载 API,用户可以将数据从自定义视觉对象下载到其存储设备上的文件中。 下载视觉对象需要用户同意和管理员全局开关中提供的管理员权限。 此设置独立于组织的“导出和共享”租户设置中应用的下载限制且不受其影响。

允许自定义视觉对象下载的管理设置的屏幕截图。

备注

文件下载 API 自 API 版本 4.5 开始提供

文件下载 API 可以导出到以下类型的文件:

  • .txt

  • .csv

  • .json

  • .tmplt

  • .xml

  • .pdf

  • .xlsx

在下载开始之前,将弹出一个窗口,要求确认视觉对象是否来自受信任的源。

要求确认下载的屏幕截图,只有当数据来自受信任的源时才可以下载。

如何使用文件下载 API

exportVisualsContent 方法具有四个参数:

  • content: string

  • filename: string

  • fileType: string - 导出到 .pdf 或 .xlsx 文件时,fileType 参数应为 base64

  • fileDescription: string

示例:文件下载 API

下面是如何将自定义视觉对象的内容下载到 Excel 文件和文本文件中的示例。

TypeScript复制

import IDownloadService = powerbi.extensibility.IDownloadService;
...export class Visual implements IVisual {
... private new_em: HTMLElement; private static downloadService: IDownloadService;
... constructor(options: VisualConstructorOptions) {
Visual.downloadService = options.host.downloadService;
... this.new_em.onclick = () => { let contentXlsx: string = ...;//content in base64
Visual.downloadService.exportVisualsContent(contentXlsx, "myfile.xlsx", "base64","xlsx file");
let contentTxt: string = ...;
Visual.downloadService.exportVisualsContent(contentTxt, "mytxt.txt", "txt","txt file");
}
}

注意事项和限制

已下载文件大小的大小限制为 10 MB。