# 栏目配置文件


此处是栏目开发者重点关注文档、配置文件涵盖了栏目跟平台的链接定义、支持的数据源范围等。

详细需要参考 09 栏目类型 (opens new window) ,根据自身业务类型合理选择栏目。

# 1.栏目基本信息

栏目存放路径 packages/ 栏目的文件夹结构

├─src
│  ├─css         --栏目实现所依赖的css文件
│  ├─img         --栏目实现中所依赖的图片文件
│  └─column.vue  --栏目实现
├─config.json     --栏目配置文件.
├─mySection.png   --[v8.1]栏目封面,本地导入的时候也能看到封面图片。
└─index.js        --栏目组件vue入口文件。可以在组件注入vue之前,处理一些环境变量。

# 2.栏目配置文件

{
    "id": "4902333343974444",  // 【必须】栏目id
    "name": "栏目名称",         // 【必须】栏目名称
    "bgColor": "red"  // 【可选】可预制栏目背景色。
    "UUID": "UUID11213111111", // 【必须】栏目UUID,每个栏目都有一个自己的物理UUID,用于请求栏目物理文件。
    "height": 300, // 【必须】栏目高度,一般还是要写上,方便可设置栏目高度。ps:不写栏目不会报错,但是不能预占位。
    "fullPage": "1" // 【可选】'是否是全屏模式,'1':全屏模式 '':根据height自定义高度',
    "minHeight": 20, // 【可选】如果不设置,默认为20,标识栏目最低高度。
    "maxHeight": 2000, //[V8.1SP1]【可选】如果不设置,默认为2000,标识栏目最大高度。
    "platform": 1,// 【必须】1:pc,2:移动 0:全部
    "heightReload": true,// 【可选】true:在编辑态高度变化时候,让平台销毁自己(重新挂载:主要为了解决echarts等canvas在栏目大小变化时无法重绘等问题、栏目开发者无需自己写监听,由平台统一处理)。 
    "forceReload": true,// 【可选】true:在编辑态高度变化时候,让平台销毁自己,重新挂载。
    "onResizeReload": true,// 【可选】true:编辑态跟运行态中,浏览器窗口变化,重新挂载自身栏目。
    "autoHeight": true, // 【可选】true:把height 转换为min-height。可做动态伸缩高度的栏目。
    "noBgColor": true, // 【可选】true:不允许设置背景色。
    "skipNoDataCheck": true, // 【可选】默认为:false:是否跳过默认的无数据检查 PS:如果设置为true,那么必须自己需要确认无数据场景栏目不能报错。
    "skipEgCheck": true, // 【可选】默认为:false:是否跳过默认的eg检查。PS:如果设置为true,那么必须自己判断是否是示例数据。示例数据不能参与真实数据的处理。
    "allowElementAuthCheck": true, // [V8.1SP1]【可选】true:允许对栏目元素单个做权限校验,元素如果无权限会在允许时自动移除。
    "options": [               // 【可选】用户自定义高级参数,用于接收设计者的选择值。
        {
            "type": "text",       // 类型:[text:文本]、[number:数字型]、[color:颜色]、[icon:图标选择]
            "name": "高级筛选1",  // 高级配置的
            "rules": [{  // 正则适配,用于过滤异常输入
                        "pattern": "^(0|[1-9][0-9]?|100)$",
                        "attributes": "g", //标识全局适配
                        "message": "*注: 圆角设置范围为:0 - 100"
                    }],
            "value": ""          // 用户录入的值会回填在value中
        }
    ],
    "elements": [             // 【可选】栏目元素,一般要有一个。但是可以没有,这样可开发纯样式栏目
        {
            "name": "栏目元素",  // 【必须】栏目名称
            "dataFormat": "1",  // 【必须】数据格式
            "dataVersion": "v1" // 【必须】数据格式版本
        },
        {
            "name": "统计",
            "description": {// 【可选(只有统计才支持条件按条件过滤)】数据源描述信息(此属性可过滤统计的统计列)
                "includeCalcType":"[sum][count][avg][max][min]",// 【可选】支持哪些数据类型
                "excludeCalcType":""// 【可选】不支持哪些数据类型
            },
            "dataFormat": "5",
            "dataVersion": "V1",
            "extensible":true, //[V8.1]【可选】元素可扩展,可以通过编辑态,动态增加元素
            "extensibleGroup": "1", //[V8.1SP1]【可选】组编号,相同的组元素,动态添加的时候一起添加,一起删除。
            "groupDelete":true, //[V8.1SP1]【可选】栏目权限校验的时候,如果没有权限,并且groupDelete==true,那么整个组的栏目都将被删除。
            "options":[],//[V8.1SP1]【可选】跟栏目的options一样,栏目能配置的元素都能配置
            "important": true, //  [V8.1SP1]【可选】true:重要的元素,如果此元素无权限,则整个栏目无权限。
            "doNotCheckAuth":true, //  [V8.1SP1]【可选】true:元素权限校验的时候,就算是无权限也禁止移除此元素。
            "condition":{  // 【可选(只有统计和查询才支持条件)】条件
                "pagination" : {      // 分页
                    "page" : 1,
                    "pageSize" : 50
                },
                "rowTypes" : ["normal"] //【可选】数组可写多个 *[normal:普通行],[subtotal:小计行],[total:合计行],此属性可以过滤统计的部分行。
            }
        },
        {
            "name": "更多",
            "description": "",
            "linkToColumnGroupRight": "1" , // 是否连接到栏目组右上角,指定为1后,次栏目元素会被栏目组的右上角区域捕获,一般用于跳转
            "columnGroupRightIcon":'', // 可配置右上角图标
            "dataFormat": "1",
            "dataVersion": "v1"
        }
    ]
}
编撰人:yinyanting