导出图片和pdf接口
更新时间: 2025-03-18 19:18:00
阅读 3065
接口说明:
用于将图表导出为图片,这里需要注意的,导出接口用户在页面上临时的选择,无法实现导出
基本信息:
API | /api/dash/report/exportCapture |
Method | GET |
请求参数:
字段名称 | 参数类型 | 参数说明 |
---|---|---|
token | String | 鉴权token |
exportType | String(Optional) | 导出图片类型,"picture"为导出图片,"pdf"为导出PDF,默认是导出图片 |
reportId | Int | 需要导出的报告id |
type | String | type="report",表示是导出报告,type="dashboard",表示导出报告页,type="component",表示导出图表组件 |
componentId | String(Optional) | 组件id,如果type="component",必传 |
dashboardId | Int(Optional) | 页面id,如果type="component"或"dashboard",必传 |
title | String(Optional) | 导出文件名称 |
defaultFilters | filters(Optional) | 筛选器,支持列表筛选器和静态类型日期筛选器 |
tempQueryId | String (Optional) | 临时筛选ID,如果客户在报告做了一些临时筛选等操作,可以通过在集成iframe 的postMessage的方式拿到这个ID,就可以导出筛选后的数据, postMessage具体格式参考前端开放API能力| |
emptyCheck | Boolean(Optional) | 是否检查数据为空 |
列表筛选器的配置格式为:
{
"列表筛选器控件id":{
selected: Array,
exclude: Boolean
}
}
静态日期筛选器的配置格式为;
{
"日期筛选器控件id":{
type: "StaticTime",
minBound: timeString,
maxBound: timeString
}
}
接口输入参数示例:
{
"token": "1503575355359c4fdea8ec1683ed10edd91ae",
"exportType": "picture", //png格式
"reportId": 1,
"type": "dashboard",
"dashboardId": 23330,
"title": "API导出",
"tempQueryId": "export_2ff50084b2e9ac865f3779c6ecd7c4d6",
"defaultFilters": {
"c-bQo8b75xnJqmhvnJpYNXtW": {
"selected": [
"2020",
"2021",
"2022",
"2023"
],
"exclude": false
}
}
}
成功数据返回:
{
"code": 200,
"result": {
"link": "...", // 下载地址
"emptyData": true // 当设置了emptyCheck时,返回截图数据是否为空,且当数据为空时不返回下载地址
}
}
文档反馈
以上内容对您是否有帮助?