本文介紹控件(組件配置項(xiàng))的配置規(guī)范,包括配置規(guī)則和通用字段。

配置規(guī)則

單個(gè)控件配置 = 通用配置 + 私有配置

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

{
  "name": "文本框", 
  "type": "text",
  "default": "",
  "description": "帶描述-帶標(biāo)注",
  "prefix": "今日進(jìn)度:"
}

通用配置

字段名含義類型是否必選備注
name顯示名string示例值:"文本框"
type類型string示例值:"text"。當(dāng)設(shè)置為hidden時(shí),DataV將不對組件進(jìn)?渲染。
default配置項(xiàng)默認(rèn)值string、number、object、array無。
showInPanel配置項(xiàng)是否在?板顯示string可定義配置項(xiàng)的顯隱規(guī)則。不配置時(shí),顯示配置項(xiàng);配置時(shí),按照配置規(guī)則顯示,配置規(guī)則請參見showInPanel配置規(guī)則
caption配置項(xiàng)標(biāo)注string不配置時(shí),將不顯示標(biāo)注。
description配置項(xiàng)描述string無。
handler處理函數(shù)名string無。
col控件主體部分所占柵格數(shù)number采?24柵格系統(tǒng)。
valuePath配置項(xiàng)對應(yīng)值的路徑string配置規(guī)則請參見valuePath配置規(guī)則
show自定義配置項(xiàng)的顯示與隱藏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軸右側(cè)顯示一個(gè)點(diǎn)選框。該配置對兄弟屬性無效。
  • color.show:表示配置單個(gè)屬性是否顯示。
  • ["show", "$eq", true]:兄弟屬性children.show等于true時(shí),color屬性才顯示。

私有配置

控件不同,私有配置不同,詳情請參見控件配置