interface-chart.md 8.4 KB
数据接口 - 图表
新增图表
请求路径:
/inputCharts
请求方式:
HTTP - POST
请求参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| chartName | String | 图表标题 |
| dataId | Number | 数据源id |
| describes | String | 描述 |
| style | String | 样式 |
| otherConfig | String | 其他设置 |
| chartsGroup | Number | 所属分组 |
| filters | String | 过滤条件 |
| chartType | enum : [ "Histogram", "Pie", "Line", "scatter", "population", "individual"] | 可视化模式 |
| chartConfig | String | 图表配置 |
请求示例
{
"chartName": "文档测试1(未命名)",
"dataId": 71,
"describes": "",
"style": "",
"chartConfig": "{}",
"chartType": ""
}
返回结果
{
"data": {
"code": 200,
"msg": "成功",
"data": 298
}
}
详细说明
根据base.viewType的不同 chartConfig加载内容也不同
修改图表
请求路径
/updateCharts
请求方式
HTTP - POST
请求参数
ChartID: code （图表编号） 其余同新增图表
请求示例
{
"chartId": 298,
"chartName": "文档测试1(未命名)",
"dataId": 71,
"createBy": "zhuth",
"describes": null,
"style": "",
"otherConfig": "{}",
"chartsGroup": "-1",
"chartType": "Histogram",
"chartConfig": "{\"xAxis\":{\"column\":{},\"granularity\":{}},\"yAxis\":{\"column\":{},\"gauge\":{}},\"groupBy\":{\"key\":\"\"}}",
"groupBy": []
}
返回结果
{
"data": {
"code": 200,
"msg": "成功",
"data": null
}
}
详细说明
删除图表
请求路径
/delChartsConfig
请求方式
HTTP - POST
请求参数
Code （图表编号）
请求示例
返回结果
详细说明
获得图表列表
请求路径
/getListCharts
请求方式
HTTP - POST
请求参数
空
返回结果
{
"data": {
"code": 200,
"msg": "成功",
"data": [{
"chartId": 262,
"chartName": "bbbb",
"chartType": "Pie",
"describes": null,
"chartsGroup": -1,
"createBy": "zhuth",
"createDate": "2018-08-06 11:17:33.0"
}, {
"chartId": 265,
"chartName": "销售订单0",
"chartType": "individual",
"describes": null,
"chartsGroup": 26,
"createBy": "zhuth",
"createDate": "2018-08-06 15:35:29.0"
}, {
"chartId": 263,
"chartName": "bench_flowchart(未命名)111",
"chartType": "Histogram",
"describes": null,
"chartsGroup": 41,
"createBy": "zhuth",
"createDate": "2018-08-06 11:18:19.0"
}, {
"chartId": 267,
"chartName": "销售订单(未命名)",
"chartType": "Line",
"describes": null,
"chartsGroup": 41,
"createBy": "zhuth",
"createDate": "2018-08-06 17:49:00.0"
}, {
"chartId": 264,
"chartName": "hhjhh",
"chartType": "Histogram",
"describes": null,
"chartsGroup": -1,
"createBy": "zhuth",
"createDate": "2018-08-06 11:20:16.0"
}, {
"chartId": 295,
"chartName": "bbbb_副本",
"chartType": "Pie",
"describes": null,
"chartsGroup": -1,
"createBy": "zhuth",
"createDate": "2018-08-08 13:56:26.0"
}, {
"chartId": 266,
"chartName": "销售订单1",
"chartType": "population",
"describes": null,
"chartsGroup": 26,
"createBy": "zhuth",
"createDate": "2018-08-06 16:22:30.0"
}, {
"chartId": 298,
"chartName": "文档测试1(未命名)",
"chartType": "Histogram",
"describes": null,
"chartsGroup": -1,
"createBy": "zhuth",
"createDate": "2018-08-08 16:32:33.0"
}, {
"chartId": 261,
"chartName": "bench_flowchart(未命名)",
"chartType": "Histogram",
"describes": null,
"chartsGroup": -1,
"createBy": "zhuth",
"createDate": "2018-08-06 10:03:03.0"
}]
}
}
详细说明
获得单个图表详细数据
请求路径
/getChartsConfig
请求方式
HTTP - POST
请求参数
Code (图表编号)
请求示例
298
返回结果
{
"data": {
"code": 200,
"msg": "成功",
"data": {
"chartId": 298,
"chartName": "文档测试1(未命名)",
"tableName": null,
"chartType": "Histogram",
"chartsGroup": -1,
"groupBy": "[]",
"chartConfig": "{\"xAxis\":{\"column\":{},\"granularity\":{}},\"yAxis\":{\"column\":{},\"gauge\":{}},\"groupBy\":{\"key\":\"\"}}",
"createBy": "zhuth",
"accessAuthority": "null",
"updateAuthority": "null",
"describes": null,
"style": "\"\"",
"filters": "null",
"createDate": "2018-08-08 16:32:33.0",
"updateDate": null,
"dataId": 71,
"subsections": null
}
}
}
详细说明
请求单个图表展示数据
请求路径
/showHistogram
/showPie
/showLine
/showScatter
/showIndividual
请求方式
HTTP - POST
请求参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | Number | 图表编号 |
| groups | Array | 分组列列名 |
| xAxis | Object : { columnRename: "列名", columnType: "列类型", showDataType: "统计方式" } | X轴 |
| yAxis | Object : { columnRename: "列名", showDataType: "统计方式"} | Y轴 |
| filters | Array | 过滤条件 |
请求示例
返回结果
详细说明
- 在不同的可视化模式下有不同的请求参数，这里不一一列出了
- 此处gauge的命名可能会容易混淆：指的对单列进行合计统计的方式，分有计数、累计、最大值、中位数、平均值、最小值等。可能混淆的名称有metrics, aggregate等。
获得图表所有分组/子分组
参照数据源分组接口说明
请求路径
/getChartsGroup请求方式
HTTP - POST请求参数
空
请求示例
返回结果
Code 分组编号 Pcode 父级分组编号 Index 索引 Label 标签
详细说明
新增图表分组/子分组
请求路径
/setChartsGroup
#####请求方式HTTP - POST
请求参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| fatherId | Number | 父级分组ID |
| groupName | String | 组名 |
| groupIndex | Number | 顺序号 |
请求示例
返回结果
详细说明
如果是顶级分组（没有父级分组），则父级分组ID设置为-1
修改图表分组信息
请求路径
/updataChartsGroup
请求方式
HTTP - POST
请求参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| Id | Number | 分组ID |
| fatherId | Number | 父级分组ID |
| groupName | String | 组名 |
| groupIndex | Number | 顺序号 |
请求示例
返回结果
详细说明
设置图表所属分组
请求路径
/updateChartConfigGroup
请求方式
HTTP - POST
请求参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| Id | Number | 数据源ID |
| GroupID | Number | 目标分组ID |
请求示例
返回结果
详细说明
批量修改图表分组信息
请求路径
/updataListGroup
请求方式
HTTP - POST
请求参数
id : code
请求示例
返回结果
详细说明
删除图表分组/子分组
请求路径
/delChartsGroup
请求方式
HTTP - POST
请求参数
Code ID
请求示例
返回结果
详细说明
图表移交
请求路径
/changeChartOrder
请求方式
HTTP - POST
请求参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| userId | Number | 被移交人id |
| id | Number | 图表id |
请求示例
{
"userId": "23",
"id": "145"
}