过滤组件配置
更新时间:2022-11-15
注: hash: "conada15-6nvllb58-jk69jk", // 用来确保唯一性,下面的排序中也需要用,id 字段可不唯一(因为可能会重复加同一个字段),frontendId 在后端 SQL 生成中也很重要作为字段的 AS 别名(生成方式:'con' + (+new Date()).toString(36) + Math.floor(Math.random() 10000000 (massive ? 10000 : 1).toString(36))
过滤条件容器参数(必须有,作为其它条件容器使用)
Javascript
1{
2 config: { // 配置信息
3 conditionTitleColor: "rgba(126, 211, 33, 1)", // 标题颜色
4 titleAlign: "center" // 标题对齐方式(left左、center中、right右)
5 },
6 dataConfig: {},
7 dataModelHash: "", // 数据模型hash
8 dataType: "sql", // 数据绑定方式(dataModel数据模型、sql SQL建模、api API拉取、json静态JSON)
9 halfWidth: false, // 宽度减半
10 hash: "con_ada15-6nvllb58-jk69jk", // 过滤条件hash(生成方式见上方)
11 height: 23, // 过滤条件高度
12 width: 12, // 过滤条件宽度(1 ~ 12)
13 key: "container", // 过滤条件容器的key
14 label: "过滤条件", // 过滤条件名称
15 left: 0, // 左侧位置
16 order: 0, // 过滤条件顺序
17 required: false, // 是否必填
18 top: 0, // 顶部位置
19 type: "container" // 过滤条件类型(container容器、select下拉单选)
20}
参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
---|---|---|---|---|---|
config | Object | 是 | 图表配置信息(详细描述见下方) | - | {} |
dataConfig | Object | 是 | 图表数据配置(详细描述见下方) | - | {} |
dataModelHash | String | 是 | 数据模型 hash | - | mld_ada15-9c2ccod1-46jxow4 |
dataType | String | 是 | 数据绑定方式(dataModel 数据模型、sql SQL 建模、api API 拉取、json 静态 JSON) | - | dataModel |
hash | String | 是 | 用来确保唯一性,下面的排序中也需要用,id 字段可能不唯一(因为可能会重复加同一个字段),frontendId 在后端 SQL 生成中也很重要作为字段的 AS 别名(生成方式:'con_' + (+new Date()).toString(36) + Math.floor(Math.random() 10000000 (massive ? 10000 : 1)).toString(36)) | - | con_ada15-6nvllb58-jk69jk |
halfWidth | String | 是 | 宽度减半 | false | false |
height | Number | 是 | 过滤条件高度 | - | 23 |
width | Number | 是 | 过滤条件宽度(1 ~ 12) | - | 12 |
key | String | 是 | 过滤条件容器的 key | - | container |
label | String | 是 | 过滤条件名称 | - | 过滤条件 |
left | Number | 是 | 左侧位置 | 0 | 0 |
order | Number | 是 | 过滤条件顺序 | - | 0 |
required | Boolean | 是 | 是否必填 | false | false |
top | Number | 是 | 顶部位置 | 0 | 0 |
type | String | 是 | 过滤条件类型(container 容器、select 下拉单选) | - | container |
config 图表数据配置
参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
---|---|---|---|---|---|
conditionTitleColor | String | 否 | 标题颜色 | default | default |
titleAlign | String | 否 | 标题对齐方式(left 左、center 中、right 右) | left | left |
下拉单选参数
Javascript
1{
2 config: {}, // 配置信息
3 dataConfig: { // 数据相关配置
4 dataModel: { // 数据模型配置
5 chartBind: {
6 list: ["kev14v2r1hv15"] // 关联的图表(list内为图表的frontId)
7 },
8 conditionBind: {
9 list: [] // 关联依赖本条件的过滤条件列表
10 },
11 dataModelBind: [ // 要过滤的数据模型
12 {
13 colId: "SG013D40CAE7C5C32C", // 关联的模型字段
14 dataModelHash: "mld_ada15-9c2ccod1-46jxow4", // 数据模型hash
15 linkType: "=" // 关联方式(['=', '等于'],['!=', '不等于'],['>', '大于'],['<', '小于'],['>=', '大于或等于'],['<=', '小于或等于'],['in', '等于多个'],['notIn', '不等于多个'],['between', '在范围之内'],['notBetween', '在范围之外'],['like', '模糊匹配'],['begin', '以它开头'],['end', '以它结尾'],['null', '取值为Null'],['notNull', '取值不为Null'])
16 }
17 ],
18 limit: 5, // 查询结果行数
19 value: [
20 dataType: "string", // 数据类型 string字符、int整数、float小数、date日期、timestamp时间戳、datetime日期时间
21 frontendId: "FKFKSWZOE1BZCR", // 用来确保唯一性,下面的排序中也需要用,id字段可能不唯一(因为可能会重复加同一个字段),frontendId在后端SQL生成中也很重要作为字段的AS别名(生成方式:'F' + (+new Date()).toString(36) + Math.floor(Math.random() * 10000000 * (massive ? 10000 : 1)).toString(36).toUpperCase())
22 id: "SG013D40CAE7C5C32C", // 维度的id
23 type: "d" // 类型 (d维度、m度量)
24 ]
25 },
26 // 在type==='text'时使用
27 otherData: {
28 // dataType === 'api'时的配置
29 suggestion: {
30 dataApiUrl: "test", // Suggestion数据绑定地址
31 dataType: "api", // Suggestion数据绑定方式(api/API拉取、sql/SQL建模)
32 // apiPro_method: "post"时配置
33 dataConfig: {
34 apiPro_adaptorOpen: false, // 开启API数据转换器
35 apiPro_method: "post", // API请求方式
36 apiPro_open: true, // 开启API高级配置
37 apiPro_postAuto: true, // 开启自动将过滤条件、联动等参数加到POST内容中
38 apiPro_postType: "json" // POST数据方式(json/JSON、form/form-data、x/x-www-form-urlencode)
39 }
40 // apiPro_method:'get'时配置
41 dataConfig: {
42 apiPro_method: "get", // API请求方式
43 apiPro_getAuto: false, // 自动将过滤条件、联动等参数加到URL中
44 apiPro_headerList: [ // Header头部设置
45 {
46 id: "kfl2m4w02zr1k", // 字段id(用来确保唯一性,下面的排序中也需要用,id字段可能不唯一(因为可能会重复加同一个字段),frontendId在后端SQL生成中也很重要作为字段的AS别名(生成方式:'F' + (+new Date()).toString(36) + Math.floor(Math.random() * 10000000 * (massive ? 10000 : 1)).toString(36)))
47 k: "test", // 字段名
48 t: "str", // 取值类型
49 v: "1" // 取值
50 }
51 ]
52 }
53 }
54 // dataType === 'sql'时的配置
55 {
56 dataType: "sql", // Suggestion数据绑定方式(api/API拉取、sql/SQL建模)
57 dataModelHash: "sql_ada15-9qtgiokb-pm192o", // 数据模型hash
58 dataConfig: {
59 valueField: "k5g6p9bl4c2ls" // 绑定Suggestion数据字段
60 }
61 }
62 }
63 },
64 dataModelHash: "mld_ada15-9c2ccod1-46jxow4", // 数据模型hash
65 dataType: "dataModel", // 数据绑定方式(dataModel数据模型、sql SQL建模、api API拉取、json静态JSON)
66 defaultVal: "__showx_default_value_first", // 下拉单选默认值(__showx_default_value_first第一项、__showx_default_value_second第二项、__showx_default_value_last最后一项)
67 frontendId: "con_ada15-84dg6ugf-gm454k", // 单选的frontendId(生成方式同上方hash生成方式)
68 halfWidth: false, // 宽度减半
69 hasFirstLoaded: true, // 是否第一次加载
70 hash: "con_ada15-84dg6ugf-gm454k", // 单选的hash(生成方式同上方hash生成方式)
71 height: 23, // 高度
72 isDashCondition: 0, // 是否大屏中过滤条件
73 isHide: false, // 是否隐藏
74 key: "select", // 单选key
75 label: "下拉单选", // 单选名称
76 left: 0, // 左侧位置
77 order: 1, // 过滤条件中的顺序
78 reportHash: "r_ada15-6hwxpdv-72g5mz", // 所在报表的hash
79 required: false, // 是否必填
80 top: 0, // 顶部位置
81 type: "select", // 过滤条件类型(container容器、select下拉单选、date日期、dateTime日期时间、text输入框)
82 width: 12 // 宽度
83}
参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
---|---|---|---|---|---|
config | Object | 是 | 图表配置信息(详细描述见下方) | - | {} |
dataConfig | Object | 是 | 图表数据配置(详细描述见下方) | - | {} |
dataModelHash | String | 是 | 数据模型 hash | - | mld_ada15-9c2ccod1-46jxow4 |
dataType | String | 是 | 数据绑定方式(dataModel 数据模型、sql SQL 建模、api API 拉取、json 静态 JSON) | - | dataModel |
defaultVal | String | 是 | 下拉单选默认值(showx_default_value_first 第一项、showx_default_value_second 第二项、__showx_default_value_last 最后一项) | __showx_default_value_first | __showx_default_value_first |
frontendId | String | 是 | 单选的 frontendId(生成方式同上方 hash 生成方式) | - | con_ada15-84dg6ugf-gm454k |
hash | String | 是 | 用来确保唯一性,下面的排序中也需要用,id 字段可能不唯一(因为可能会重复加同一个字段),frontendId 在后端 SQL 生成中也很重要作为字段的 AS 别名(生成方式:'con_' + (+new Date()).toString(36) + Math.floor(Math.random() 10000000 (massive ? 10000 : 1)).toString(36)) | - | con_ada15-6nvllb58-jk69jk |
hasFirstLoaded | Boolean | 是 | 是否第一次加载 | true | true |
halfWidth | String | 是 | 宽度减半 | false | false |
height | Number | 是 | 过滤条件高度 | - | 23 |
width | Number | 是 | 过滤条件宽度(1 ~ 12) | 12 | 12 |
key | String | 是 | 过滤条件容器的 key | select | select |
label | String | 是 | 过滤条件名称 | - | 过滤条件 |
left | Number | 是 | 左侧位置 | 0 | 0 |
order | Number | 是 | 过滤条件顺序 | - | 0 |
required | Boolean | 是 | 是否必填 | false | false |
top | Number | 是 | 顶部位置 | 0 | 0 |
type | String | 是 | 过滤条件类型(container 容器、select 下拉单选) | select | select |
isDashCondition | Number | 是 | 是否大屏中过滤条件(0 否、1 是) | 0 | 0 |
isHide | Boolean | 是 | 是否隐藏 | false | false |
config 图表数据配置(type==='select')
参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
---|---|---|---|---|---|
uiMode | String | 是 | 展示样式,适用于 type==='select'时(select 单选下拉、list 单选列表) | select | select |
config 图表数据配置(type==='text')
参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
---|---|---|---|---|---|
openSuggestion | Boolean | 否 | 是否开启开启Suggestion | false | false |
suggestDelay | Number | 否 | Suggestion 拉取延迟毫秒数 | 200 | 200 |
dataConfig 图表数据配置
参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
---|---|---|---|---|---|
dataModel | Object | 否 | 数据模型配置(详细描述见下方) | - | - |
otherData | Object | 否 | 其它数据配置配置(在 type==='text'时使用)(详细描述见下方) | - | - |
dataModel 图表数据模型配置
参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
---|---|---|---|---|---|
limit | Number | 是 | 查询结果行数 | - | 1000 |
value | Array | 是 | 数据字段(详细描述见下方) | [] | - |
chartBind | Array | 是 | 关联的图表(详细描述见下方) | [] | - |
conditionBind | Array | 是 | 关联依赖本条件的过滤条件(详细描述见下方) | [] | - |
dataModelBind | Array | 是 | 要过滤的数据模型(详细描述见下方) | [] | - |
value 配置
参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
---|---|---|---|---|---|
dataType | String | 是 | 数据类型 string 字符、int 整数、float 小数、date 日期、timestamp 时间戳、datetime 日期时间 | - | string |
frontendId | String | 是 | 用来确保唯一性,下面的排序中也需要用,id 字段可能不唯一(因为可能会重复加同一个字段),frontendId 在后端 SQL 生成中也很重要作为字段的 AS 别名(生成方式:'F' + (+new Date()).toString(36) + Math.floor(Math.random() 10000000 (massive ? 10000 : 1)).toString(36).toUpperCase()) | - | FKFKSWZOE1BZCR |
id | String | 是 | 度量/维度 id | - | - |
type | String | 是 | 类型 (d 维度、m 度量) | - | d |
chartBind/conditionBind 配置
参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
---|---|---|---|---|---|
list | Array | 是 | 关联的图表(list 内为图表的 frontId) | - | - |
dataModelBind 配置
参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
---|---|---|---|---|---|
colId | String | 是 | 关联的模型字段 | - | SG013D40CAE7C5C32C |
dataModelHash | String | 是 | 数据模型 hash | - | mld_ada15-9c2ccod1-46jxow4 |
linkType | String | 是 | 关联方式(['=', '等于'],['!=', '不等于'],['>', '大于'],['<', '小于'],['>=', '大于或等于'],['<=', '小于或等于'],['in', '等于多个'],['notIn', '不等于多个'],['between', '在范围之内'],['notBetween', '在范围之外'],['like', '模糊匹配'],['begin', '以它开头'],['end', '以它结尾'],['null', '取值为 Null'],['notNull', '取值不为 Null']) | - | = |
otherData 其它数据配置配置(在 type==='text'时使用)
参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
---|---|---|---|---|---|
suggestion | Object | 是 | suggestion 数据字段(详细描述见下方) | [] | - |
suggestion 配置
参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
---|---|---|---|---|---|
dataType | String | 否 | Suggestion 数据绑定方式(api/API 拉取、sql/SQL 建模) | - | api |
dataApiUrl | String | 否 | Suggestion 数据绑定地址(dataType === 'api'时存在) | - | - |
dataConfig | String | 否 | 数据配置(详细描述见下方) | - | - |
dataConfig 配置(dataType === 'api')
参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
---|---|---|---|---|---|
apiPro_adaptorOpen | Boolean | 否 | 开启 API 数据转换器 | - | false |
apiPro_method | String | 否 | API 请求方式(post/get) | - | post |
apiPro_open | Boolean | 否 | 开启 API 高级配置 | - | false |
apiPro_postAuto | Boolean | 否 | 开启自动将过滤条件、联动等参数加到 POST 内容中(apiPro_method === 'post'时使用) | - | true |
apiPro_postType | String | 否 | POST 数据方式(json/JSON、form/form-data、x/x-www-form-urlencode)(apiPro_method === 'post'时使用) | - | json |
apiPro_getAuto | Boolean | 否 | 自动将过滤条件、联动等参数加到 URL 中(apiPro_method === 'get'时使用) | - | true |
apiPro_headerList | Array | 否 | Header 头部设置(详细描述见下方)(apiPro_method === 'get'时使用) | - | [] |
apiPro_headerList 配置(apiPro_method === 'get')
参数名 | 类型 | 必填 | 描述 | 默认值 | 参考值 |
---|---|---|---|---|---|
id | String | 否 | 字段 id((用来确保唯一性,下面的排序中也需要用,id 字段可能不唯一(因为可能会重复加同一个字段),frontendId 在后端 SQL 生成中也很重要作为字段的 AS 别名(生成方式:'f' + (+new Date()).toString(36) + Math.floor(Math.random() 10000000 (massive ? 10000 : 1)).toString(36)))) | - | kfl2m4w02zr1k |
k | String | 否 | 字段名 | - | test |
t | String | 否 | 取值类型(str 字符串/num 数值/bool 布尔) | - | str |
v | String | 否 | 取值 | - | 1 |