本文介绍控件(组件配置项)的配置规范,包括配置规则和通用字段。

配置规则

单个控件配置 = 通用配置 + 私有配置

例如,以下示例中nametypedefault都是通用配置,prefix是私有配置。

{
  "name": "文本框", 
  "type": "text",
  "default": "",
  "description": "带描述-带标注",
  "prefix": "今日进度:"
}

通用配置

字段名 含义 类型 是否必选 备注
name 显示名 string 示例值:"文本框"
type 类型 string 示例值:"text"。当设置为hidden时,DataV将不对组件进⾏渲染。
default 配置项默认值 string、number、object、array 无。
showInPanel 配置项是否在⾯板显示 string 可定义配置项的显隐规则。不配置时,显示配置项;配置时,按照配置规则显示,配置规则请参见showInPanel配置规则
caption 配置项标注 string 不配置时,将不显示标注。
description 配置项描述 string 无。
handler 处理函数名 string 无。
col 控件主体部分所占栅格数 number 采⽤24栅格系统。
valuePath 配置项对应值的路径 string 配置规则请参见valuePath配置规则
show 自定义配置项的显示与隐藏 object 配置示例如下。
{
  "xAxis": {
    "type": "group",
    "name": "x轴",
    "children": {
      "show": { 
        "type": "boolean",
        "name": "显示",
        "default": true
      },
      "color": {
        "type": "color",
        "name": "颜色",
        "default": "#ccc",
        "show": [                
          ["show", "$eq", true] 
        ]
      }
    }
  }
}
  • children.show:表示在x轴右侧显示一个点选框。该配置对兄弟属性无效。
  • color.show:表示配置单个属性是否显示。
  • ["show", "$eq", true]:兄弟属性children.show等于true时,color属性才显示。

私有配置

控件不同,私有配置不同,详情请参见控件配置