interface-chart.md 7.3 KB
数据接口 - 图表
新增图表
请求路径:
/inputCharts
请求方式:
HTTP - POST
#####包类方法:
dispatch(type:'chart/remoteAdd')
请求参数
| 字段名（后端） | 字段名（前端） | 说明 |
|---|---|---|
| chartName | header.label | 图表标题 |
| dataId | baseConfig.dataSource | 基础配置 – 数据源 |
| groupBy{ | 预处理 – 分组 | |
| columnName | preparing.groupBy.key | 分组列列名 |
| columnRamane | preparing.groupBy.label | 分组列别名 |
| }] | ||
| createBy | 创建人 | |
| describes | description | 说明 |
| style | 样式配置 | |
| otherConfig | JSON.stringify(otherConfig) | 其他配置 |
| chartType | base.viewType | 可视化模式 |
| chartConfig | 图表配置 |
请求示例
返回结果
详细说明
根据base.viewType的不同 chartConfig加载内容也不同
修改图表
请求路径
/updateCharts
请求方式
HTTP - POST
包类方法
dispatch(type:'chart/remoteModify')
请求参数
ChartID: code （图表编号） 其余同新增图表
请求示例
返回结果
详细说明
删除图表
请求路径
/delChartsConfig
请求方式
HTTP - POST
包类方法
dispatch(type:'chart/remoteDelete')
请求参数
Code （图表编号）
请求示例
返回结果
详细说明
获得图表列表
请求路径
/getListCharts
请求方式
HTTP - POST
包类方法
dispatch(type:'chart/fetchList')
请求参数
空
请求示例
返回结果
详细说明
获得单个图表详细数据
请求路径
/getChartsConfig
请求方式
HTTP - POST
包类方法
dispatch(type:'chart/remoteDetail')
请求参数
Code (图表编号)
请求示例
返回结果
详细说明
请求单个图表展示数据
请求路径
/showHistogram
/showPie
/showLine
/showScatter
/showIndividual
请求方式
HTTP - POST
包类方法
dispatch(type:'chart/fetchBarData')
dispatch(type:'chart/fetchLineData')
dispatch(type:'chart/fetchPieData')
dispatch(type:'chart/fetchScatterData')
dispatch(type:'chart/fetchDataViewData')
请求参数
| 字段名（后端） | 字段名（前端） | 说明 |
|---|---|---|
| id | code | 图表编号 |
| groups | preparing.groupBy.key | 分组列列名 |
| xAxis | X轴 | |
| columnRename | barConfig.xAxis.column.value | X轴列名 |
| columnType | barConfig.xAxis.column.type | X轴分析类型 |
| showDataType | barConfig.xAxis.granularity.value | X轴粒度 |
| yAxis | Y轴 | |
| columnRename | barConfig.yAxis.column.value | Y轴列名 |
| showDataType | barConfig.yAxis.gauge.value | Y轴统计方式 |
请求示例
返回结果
详细说明
此处gauge的命名可能会容易混淆：指的对单列进行合计统计的方式，分有计数、累计、最大值、中位数、平均值、最小值等。可能混淆的名称有metrics, aggregate等。
获得图表所有分组/子分组
请求路径
/getChartsGroup
请求方式
HTTP - POST
包类方法
dispatch(type:'chart/remoteGroupList')
请求参数
空
请求示例
返回结果
Code 分组编号 Pcode 父级分组编号 Index 索引 Label 标签
详细说明
新增图表分组/子分组
请求路径
/setChartsGroup
#####请求方式HTTP - POST
包类方法
dispatch(type:'chart/remoteAddGroup')
请求参数
| 字段名（后端） | 字段名（前端） | 说明 |
|---|---|---|
| fatherId | pgroup.code | 父级分组ID |
| groupName | “新子分组”’ | 基础配置 – 数据源 |
| groupIndex | 分组索引 | |
| createBy | 创建人 |
请求示例
返回结果
详细说明
如果是顶级分组（没有父级分组），则父级分组ID设置为-1
修改图表分组信息
请求路径
/updataChartsGroup
请求方式
HTTP - POST
包类方法
dispatch(type:'chart/remoteModifyGroup')
请求参数
| 字段名（后端） | 字段名（前端） | 说明 |
|---|---|---|
| Id | Group.code | 分组ID |
| fatherId | pgroup.code | 父级分组ID |
| groupName | “新子分组”’ | 基础配置 – 数据源 |
| groupIndex | 分组索引 | |
| createBy | 创建人 |
请求示例
返回结果
详细说明
设置图表所属分组
请求路径
/updateChartConfigGroup
请求方式
HTTP - POST
包类方法
dispatch(type:'chart/remoteSetChartGroup')
请求参数
| 字段名（后端） | 字段名（前端） | 说明 |
|---|---|---|
| Id | DatasourceCode | 数据源ID |
| GroupID | “新子分组”’ | 目标分组ID |
请求示例
返回结果
详细说明
批量修改图表分组信息
请求路径
/updataListGroup
请求方式
HTTP - POST
包类方法
dispatch(type:'chart/remoteModifyGroups')
请求参数
id : code
请求示例
返回结果
详细说明
删除图表分组/子分组
请求路径
/delChartsGroup
请求方式
HTTP - POST
包类方法
dispatch(type:'chart/remoteDeleteGroup')
请求参数
Code ID
请求示例
返回结果
详细说明
图表编辑器
获得数据源下的列数据
请求路径
/getColumnData
请求方式
HTTP - POST
包类方法
dispatch(type:'chartDesigner/remoteDataColumn')
请求参数
| 字段名（后端） | 字段名（前端） | 说明 |
|---|---|---|
| fatherId | pgroup.code | 父级分组ID |
| groupName | “新子分组”’ | 基础配置 – 数据源 |
| groupIndex | 分组索引 | |
| createBy | 创建人 |
请求示例
返回结果
详细说明
此处将整个groups集体上传 集体替换。 此处建议使用batch表达批量修改的概念。