ESUI - Region


List of Tables

1. 构造器静态参数配置
2. 初始化参数
3. 公共实例方法
4. 事件

1. 继承层级

Region - InputControl - Control

2. 说明

Region用于地域选择。

Region支持单选和多选两种选择模式。

多选模式下,value的字符串格式为逗号分割的地域列表。

地域列表可通过静态参数配置,也可初始化时传入。地域列表是一个Array,列表中的每一项是一个可具有id、text、children属性的多重结构的数据。具体数据形式参照E-JSON标准中的数据场景:树。

[
    {
        id: 'China',
        text: '中国地区',
        children: [
            {
                id: "North",
                text: "华北地区",
                children: [
                    {id: "1", text: "北京"},
                    {id: "3", text: "天津"},
                    {id: "13", text: "河北"},
                    {id: "26", text: "山西"},
                    {id: "22", text: "内蒙古"}
                ]
            },
            {
                id: "NorthEast",
                text: "东北地区",
                children: [
                    {id: "21", text: "辽宁"},
                    {id: "18", text: "吉林"},
                    {id: "15", text: "黑龙江"}
                ]
            },
            {
                id: "East",
                text: "华东地区",
                children: [
                    {id: "2", text: "上海"},
                    {id: "19", text: "江苏"},
                    {id: "32", text: "浙江"},
                    {id: "9", text: "安徽"},
                    {id: "5", text: "福建"},
                    {id: "20", text: "江西"},
                    {id: "25", text: "山东"}
                ]
            },
            {
                id: "Middle",
                text: "华中地区",
                children: [
                    {id: "14", text: "河南"},
                    {id: "16", text: "湖北"},
                    {id: "17", text: "湖南"}
                ]
            },
            {
                id: "South",
                text: "华南地区",
                children: [
                    {id: "4", text: "广东"},
                    {id: "8", text: "海南"},
                    {id: "12", text: "广西"}
                ]
            },
            {
                id: "SouthWest",
                text: "西南地区",
                children: [
                    {id: "33", text: "重庆"},
                    {id: "28", text: "四川"},
                    {id: "10", text: "贵州"},
                    {id: "31", text: "云南"},
                    {id: "29", text: "西藏"}
                ]
            },
            {
                id: "NorthWest",
                text: "西北地区",
                children: [
                    {id: "27", text: "陕西"},
                    {id: "11", text: "甘肃"},
                    {id: "24", text: "青海"},
                    {id: "23", text: "宁夏"},
                    {id: "30", text: "新疆"}
                ]
            },
            {
                id: "Other",
                text: "其他地区",
                children: [
                    {id: "34", text: "香港"},
                    {id: "36", text: "澳门"},
                    {id: "35", text: "台湾"}
                ]
            }
        ]
    },
    {
        id: 'Abroad',
        text: '国外',
        children: [
            {id: '7', text: '日本'},
            {id: '37', text: '其他国家'}
        ]
    }
]

3. 构造器静态参数配置

Table 1. 构造器静态参数配置

名称描述
{Array} REGION_LIST地域列表。

4. 初始化参数

Table 2. 初始化参数

名称描述
{Array} datasource地域列表。
{boolean} disabled控件的不可用状态。
{HTMLElement} main控件主元素。
{string} mode选择模式。multi|single。
{string|Object} rule验证规则。
{string} value当前选中的地域value。

5. 公共实例方法

Table 3. 公共实例方法

名称描述
{void} appendTo( {HTMLElement} wrap )将控件添加到页面的某个元素中。
{boolean} checkValidity( {void} )验证控件,仅返回true/false。
{void} disable( {void} )设置控件状态为禁用。
{void} enable( {void} )设置控件状态为启用。
{string} getValue( {void} )获取选中的地域。
{boolean} isDisabled( {void} )获取控件可用状态。
{void} render( {void} )绘制控件。
{boolean} validate( {void} )验证控件,当值不合法时显示错误信息。

6. 事件

Table 4. 事件

名称描述
{boolean} onchange: ( {string} value )当选中地域发生改变时触发。
{void} onbeforevalidate( {validator.Validity} )验证开始前触发。
{void} onaftervalidate( {validator.Validity} )验证结束后触发。
{void} oninvalid( {validator.Validity} )验证控件值不合法时触发。