配置控件类型

平台为组件配置界面提供了多种内置控件,这些控件的类型和展示形式由不同的json对象决定。


1. text 文本

配置项说明

字段名

描述

类型

是否必选

说明

type

类型

string


name

字段名

string


displayName

显示名

string


value

显示值

string


示例配置

{
  "type": "text",
  "name": "text",
  "displayName": "文本",
  "value": "静态文本"
}

Example



2. input 输入框

配置项说明

字段名

描述

类型

是否必选

说明

type

类型

string


name

字段名

string


displyName

显示名

string


value

显示值

string


config

配置

object


config配置项说明

字段名

描述

类型

是否必选

说明

prefix

前缀

string


suffix

后缀

string


disabled

禁用

boolean


placeholder

占位符

string


示例配置

{
    "type": "input",
    "name": "input",
    "displayName": "文本",
    "value": "文本",
    "config": {
        "disabled": false,
        "placeholder": "请输入一段文本",
        "prefix": "前缀",
        "suffix": "后缀"
    }
}


Example



3. number 数值输入框

配置项说明

字段名

描述

类型

是否必选

说明

type

类型

string


name

字段名

string


displyName

显示名

string


value

显示值

number


config

配置

object


config配置项说明

字段名

描述

类型

是否必选

说明

min

最小值

number


max

最大值

number


step

步进值

number

默认值为:1

prefix

前缀

string


suffix

后缀

string


disabled

是否禁用

boolean


showStep

是否显示步进

boolean

默认有后缀时不显示,无后缀时显示

placeholder

占位提示符

string


示例配置

{
    "type": "number",
    "name": "number",
    "displayName": "数值",
    "value": 123,
    "config": {
        "min": 0,
        "max": 100,
        "step": 1,
        "disabled": false,
        "prefix": "",
        "suffix": "",
        "placeholder": "",
        "showStep": true
    }
}


Example


4. selectCard 下拉框

配置项说明

字段

描述

类型

是否必选

说明

type

类型

string


name

字段名

string


displayName

显示名

string


value

字段值

string


config

配置

object


config配置项说明

字段

描述

类型

是否必选

说明

options

选项列表

array


allowInput

允许输入

boolean


placeholder

占位提示符

string


示例配置

{
  type: "selectCard",
  name: "select",
  displayName: "选择",
  config: {
      //选项列表
      options: [   
          { //绝对地址
              name: "选项一",
              value: "option1",
              cover: 'https://easyv.assets.dtstack.com/template/S4NcbB0Ie_1600333577795_qposcvVE59.jpg'
          },
          { //相对地址
              name: "选项二",
              value: "option2",
              cover: 'template/S4NcbB0Ie_1600333577795_qposcvVE59.jpg'
          }
      ],
      //占位提示符
      placeholder: "请选择",
      //允许输入
      allowInput: true
  }
}
{
    "type": "selectCard",
    "name": "select",
    "displayName": "选择",
    "config": {
      "options": [
          {
            "name": "选项一",
            "value": "option1",
            "cover": "https://easyv.assets.dtstack.com/template/S4NcbB0Ie_1600333577795_qposcvVE59.jpg"
          },
          {
            "name": "选项二",
            "value": "option2",
            "cover": "template/S4NcbB0Ie_1600333577795_qposcvVE59.jpg"
          }
      ],
      "placeholder": "请选择",
      "allowInput": true
    }
}


5. select 下拉框

配置项说明

字段

描述

类型

是否必选

说明

type

类型

string


name

字段名

string


displayName

显示名

string


value

字段值

string


config

配置

object


config配置项说明

字段

描述

类型

是否必选

说明

options

选项列表

array


allowInput

允许输入

boolean


placeholder

占位提示符

string


示例配置

{
    "type": "select",
    "name": "select",
    "displayName": "选择",
    "value": "rect",
    "config": {
        "options": [
            {
                "name": "选项一",
                "value": "option1"
            },
            {
                "name": "选项二",
                "value": "option2"
            }
        ],
        "placeholder": "请选择",
        "allowInput": true
    }
}

Example


6. range 区间滑动条

配置项说明

字段

描述

类型

是否必选

说明

type

类型

string


name

字段名

string


displayName

显示名

string


value

字段值

number | [number, number] 

两个数值为双区间模式

config

配置

object


config配置项说明

字段

描述

类型

是否必选

说明

min

最小值

number


max

最大值

number


step

步进值

number

默认值为1

suffix

数值后缀

string


prefix

数值前缀

string


示例配置

{
    "type": "range",
    "name": "range",
    "displayName": "区间",
    "value": 10,
    "config": {
        "min": 0,
        "max": 100,
        "step": 1,
        "suffix": "",
        "prefix": ""
    }
}


Example



7. radio 单选框

配置项说明

字段

描述

类型

是否必选

说明

type

类型

string


name

字段名

string


displayName

显示名

string


value

字段值

string


config

配置

object


config配置项说明

字段

描述

类型

是否必选

说明

options

选项列表

{name: string, value: string, icon?: string} []

icon模式提供icon组件库中的图标名称或者图片地址

mode

单选模式

normal | button | icon

默认为 normal

示例配置

{
    "type": "radio",
    "name": "radio",
    "displayName": "单选",
    "value": "option1",
    "config": {
        "options": [
            {
                "name": "选项一",
                "value": "option1"
            },
            {
                "name": "选项二",
                "value": "option2"
            }
        ],
        "mode": "normal"
    }
}

Example



8. boolean 开关

配置项说明

字段

描述

类型

是否必选

说明

type

类型

string


name

字段名

string


displayName

显示名

string


value

字段值

boolean


config

配置

object


config配置项说明

字段

描述

类型

是否必选

说明

mode

布尔模式

normal | icon | switch

icon模式提供icon组件库中的图标名称,默认为normal

icon

icon名称

string


示例配置

{
    "name": "boolean",
    "displayName": "布尔",
    "value": false,
    "type": "boolean"
}

Example



9. checkbox 多选框

配置项说明

字段

描述

类型

是否必选

说明

type

类型

string


name

字段名

string


displayName

显示名

string


value

字段值

string[]


config

配置

object


config配置项说明

字段

描述

类型

是否必选

说明

options

选项列表

{name: string, value: string} []


示例配置

{
    "name": "position",
    "displayName": "位置",
    "value": "bottom",
    "type": "checkbox",
    "config": {
        "options": [
            {
                "name": "右",
                "value": "right"
            },
            {
                "name": "上",
                "value": "top"
            },
            {
                "name": "下",
                "value": "bottom"
            }
        ]
    }
}


Example



10. color 颜色选择器

配置项说明

字段

描述

类型

是否必选

说明

type

类型

string


name

字段名

string


displayName

显示名

string


value

字段值

string


config

配置

object


config配置项说明

字段

描述

类型

是否必选

说明

simple

是否只显示颜色拾取

boolean


示例

{
    "name": "color",
    "displayName": "颜色",
    "value": "#fff",
    "type": "color"
}


Example


11. multicolor(多类型颜色) (需要easyv 平台 v3.15及以上)

配置项说明

字段

描述

类型

是否必选

说明

type

类型

string


name

字段名

string


displayName

显示名

string


value

字段值

object


config

配置

object


config配置项说明

字段

描述

类型

是否必选

说明

simple

是否只显示颜色拾取

boolean


value配置项说明

字段

描述

类型

是否必选

说明

type

颜色类型

pure | linear 


pure

纯色的值

string

对应类型为必选


linear

线性渐变的值

{stops: { offset: number, color: string}[], angle: number,opacity: number}

对应类型为必选



示例

{
	name: "color",
  displayName: "颜色",
  type: "multicolor",
  value: {
    type: "linear", 
    pure: "#fff", 
    linear: {
      stops: [{"offset": 0, "color": '#fff'}, {"offset": 50, "color": '#ff0'}, {"offset": 100, "color": '#f0f'}],
      angle: 30,
      opacity: 1
    }
  }
}


12. rangeColor(颜色区间) (需要easyv 平台 v4.5.0及以上)

配置项说明

字段

描述

类型

是否必选

说明

type

类型

string


name

字段名

string


displayName

显示名

string


value

字段值

{offset, color}[]

offet: 1-100

color: 颜色值

示例

{
	"name": "group",
  "displayName": "颜色隐射",
  "type": "group",
  "value": [
    {
    	"name": "rangeColor",
      "displayName": "最小值 -> 最大值",
      "type": "rangeColor",
      "value": [
        {
          "offset": 0,
          "color": "#fff"
        },
        {
          "offset": 100,
          "color": "#000"
        }
      ] 
    }
  ] 
}

Example


13. array 系列

该控件允许用户添加一组预设的配置,并给每一组设置不同的值

配置项说明

字段

描述

类型

是否必选

说明

type

类型

string


name

字段名

string


displayName

显示名

string


value

字段值

object[]


config

配置

object


config配置项说明

字段

描述

类型

是否必选

说明

template

模板

object

该对象为value中的子项

defaultCollapsed

默认折叠状态

boolean

默认为true


示例

{
    "name": "series",
    "displayName": "数据系列",
    "type": "array",
    "value": [
        {
            "name": "child1",
            "displayName": "系列",
            "value": [
                {
                    "type": "input",
                    "name": "input",
                    "displayName": "文本",
                    "value": "文本"
                },
                {
                    "type": "number",
                    "name": "number",
                    "displayName": "数值",
                    "value": 123
                }
            ]
        }
    ],
    "config": {
        "template": {
            "name": "child",
            "displayName": "系列",
            "value": [
                {
                    "type": "input",
                    "name": "input",
                    "displayName": "文本",
                    "value": "系列一"
                },
                {
                    "type": "number",
                    "name": "number",
                    "displayName": "数值",
                    "value": 100
                }
            ]
        }
    }
}


Example



14. image 图片上传

该控件仅允许用户上传image/*格式的文件,参考accept属性说明,也可以在图片类型上定义图片格式

配置项说明

字段

描述

类型

是否必选

说明

type

类型

string


name

字段名

string


displayName

显示名

string


value

字段值

string


config配置项说明

字段

描述

类型

是否必选

说明

accept

文件类型

string[]

参考accept属性说明,接受多个值

示例

{
    "name": "image",
    "displayName": "图片",
    "type": "image",
    "value": ""
}

Example



15. video 视频上传

该控件仅允许用户上传video/*格式的文件,参考accept属性说明,也可以定义视频的格式

配置项说明

字段

描述

类型

是否必选

说明

type

类型

string


name

字段名

string


displayName

显示名

string


value

字段值

string


config配置项说明

字段

描述

类型

是否必选

说明

accept

文件类型

string[]

参考accept属性说明,接受多个值

示例

{
    "name": "video",
    "displayName": "视频",
    "type": "video",
    "value": ""
}


Example



16. audio 音频上传

该控件仅允许用户上传audio/*格式的文件,参考accept属性说明,也可以定义音频的格式

配置项说明

字段

描述

类型

是否必选

说明

type

类型

string


name

字段名

string


displayName

显示名

string


value

字段值

string


config配置项说明

字段

描述

类型

是否必选

说明

accept

文件类型

string[]

参考accept属性说明,接受多个值

示例

{
    "name": "audio",
    "displayName": "音频",
    "type": "audio",
    "value": ""
}

Example



17. uploadModel模型上传

该控件允许用户上传模型类型的文件,如上传glb、gltf、fbx、obj等模型文件

支持类型:'glb','gltf','fbx','obj','stl','dae','3dm','3ds','3mf','amf','pmd','vmd','vpd','ply','vrm','wrl','b3dm','osgb'

配置项说明

字段

描述

类型

是否必选

说明

type

类型

string


name

字段名

string


displayName

显示名

string


value

字段值

string


config配置项说明

字段

描述

类型

是否必选

说明

accept

文件类型

string[]

参考accept属性说明,接受多个值


示例

{
    "name": "uploadModel",
    "displayName": "模型",
    "type": "uploadModel",
    "value": ""
}

Example


18. model 文件上传

该控件允许用户上传任何类型的文件,在某些环境下会很有用,比如上传json、obj、mtl、fbx、glb、gltf等模型或资源文件

配置项说明

字段

描述

类型

是否必选

说明

type

类型

string


name

字段名

string


displayName

显示名

string


value

字段值

string


示例

{
    "name": "model",
    "displayName": "文件",
    "type": "model",
    "value": ""
}

Example



19. font 字体

该控件给用户提供不同的字体类型选择,可选的字体列表由平台提供。

配置项说明

字段

描述

类型

是否必选

说明

type

类型

string


name

字段名

string


displayName

显示名

string


value

字段值

string



示例

{
    "type": "font",
    "name": "font",
    "displayName": "字体",
    "value": "Microsoft Yahei"
}


Example


20. json (需要easyv 平台 v4.13及以上)

该控件支持输入JSON对象,提供代码编辑器编辑,可支持全屏编辑。

该配置项需要easyv 平台 v4.13以上才支持

配置项说明

字段

描述

类型

是否必选

说明

type

类型

string

type 为 json

name

字段名

string


displayName

显示名

string


value

字段值

JSON string


config

配置

object

config配置项说明

字段

描述

类型

是否必选

说明

showGutter

显示行号

boolean

默认为false

示例

{
    "type": "json",
    "name": "json",
    "displayName": "JSON",
    "value": "{}"
}

效果图


21. jscode (需要easyv 平台 v4.13及以上)

该控件支持编写js代码,提供代码编辑器编辑,可支持全屏编辑。

该配置项需要easyv 平台 v4.13以上才支持

配置项说明

字段

描述

类型

是否必选

说明

type

类型

string

type 为 jscode

name

字段名

string


displayName

显示名

string


value

字段值

JSON string


config

配置

object

config配置项说明

字段

描述

类型

是否必选

说明

showGutter

显示行号

boolean

默认为false


示例

{
    "type": "jscode",
    "name": "js",
    "displayName": "JS",
    "value": "",
  	"config": {
    	"showGutter": true
    }
}

效果图


22. area(地图选择)

配置项说明

字段

描述

类型

是否必选

说明

type

类型

string


name

字段名

string


displayName

显示名

string


value

字段值

string


示例

{
  type: 'area',
	name: 'area',
  displayName: 'adCode',
  value: '100000'
}


23. grid(九宫格单选) (需要easyv 平台 v3.15及以上)


配置项说明

字段

描述

类型

是否必选

说明

type

类型

string


name

字段名

string


displayName

显示名

string


value

字段值

string


config配置项说明

字段

描述

类型

是否必选

说明

options

选项

string[]

string为“”,则不显示宫格的点

示例

{
  type: 'grid',
	name: 'grid',
  displayName: '九宫格',
  value: 'center center',
  config: {
  	options: [
      "left top", 
      "center top", 
      "right top", 
      "left center", 
      "center center", 
      "right center",
      "left bottom",
      "center bottom",
      "right bottom"
    ]
  }
}

示例2

{
  type: 'grid',
	name: 'grid',
  displayName: '九宫格',
  value: 'center center',
  config: {
  	options: [
      "", 
      "center top", 
      "", 
      "left center", 
      "", 
      "right center",
      "",
      "center bottom",
      ""
    ]
  }
}


24. position(位置) (需要easyv 平台 v3.15及以上)

配置项说明

字段

描述

类型

是否必选

说明

type

类型

string


name

字段名

string


displayName

显示名

string


value

字段值

[x,y]

x,y为0-1的数值


套件

25. shadow(阴影) (需要easyv 平台 v3.15及以上)


配置项说明

字段

描述

类型

是否必选

说明

type

类型

string


name

字段名

string


displayName

显示名

string


value

字段值

object


value值说明

字段

描述

类型

是否必选

说明

color

颜色

string



vShadow

竖直方向阴影距离

number


hShadow

水平方向阴影距离

number


blur

模糊

number


spread

扩展

number

不填,表示不需要扩展

示例

{
  type: 'shadow',
  name: 'shadow',
  displayName: '文本阴影',
  value: {
    color: '#fff',
    vShadow: 8,
    hShadow: -10,
    blur: 8
  }
}

示例2

{
  type: 'shadow',
  name: 'shadow',
  displayName: '形状阴影',
  value: {
    color: '#fff',
    vShadow: 8,
    hShadow: -10,
    blur: 8,
    spread: 8
  }
}

26. textStyle(文本样式) (需要easyv 平台 v3.15及以上)

配置项说明

字段

描述

类型

是否必选

说明

type

类型

string


name

字段名

string


displayName

显示名

string


value

字段值

object


value值说明

字段

描述

类型

是否必选

说明

fontFamily

字体

string


fontSize

字体大小

number


color

颜色

string


bold

加粗

boolean


italic

斜体

boolean


letterSpacing

字间距

number


lineHeight

行距

number

示例

{
  type: 'textStyle',
  name: 'textStyle',
  displayName: '文本样式',
  value: {
    fontFamily: 'Mircosoft Yahei',
    fontSize: 24,
    color: '#fff',
    bold: true,
    italic: false,
    letterSpacing: 0,
  	lineHeight: 3
  }
}


27. 布局类型

组合

在外层配置项上设置type为group,则内层的配置项会自动成一组。

一旦外层的配置项上设置了type为group,内层的配置项只能是原子控件的配置,不能再出现嵌套的配置。

内层配置项上,config.span 对应的就是该原子控件的占比。


示例

{
  type: 'group',
  name: 'group',
  displayName: '成组',
  value: [
    {
      type: 'number',
      name: 'number1',
      displayName: '数字1',
      value: 50,
      config: {
        span: 12
      }
    },
    {
      type: 'number',
      name: 'number2',
      displayName: '数字2',
      value: 60,
      config: {
        span: 12
      }
    }
  ]
}


28. 平台控件

该控件类型是平台独有的控件,用于满足特殊的使用场景,依据不同的类型,会有多个基本控件组合的展示形态和交互逻辑,并且可选内容会由平台动态填充

组件ID

平台提供各种各样的组件类型,为了提升可读性,将不同的组件从概念上做了划分,分为以下几种格式。

类型

格式


组件

$component(1)


分组

$group(group_1)


动态面板

$panel(panel_341)


引用面板

$panel(ref_1)


remoteOptions 远程控制

该控件是由多个内置的控件组合成的一组控件,统称为远程控制控件,包含事件回调两种类型。

事件类型:通过关联需要远程控制的大屏上已经配置好的自定义事件,来获取交互的参数,通过平台提供的接口去触发事件。

大屏:需要远程控制的大屏

组件:需要远程控制的大屏中的组件

事件:需要远程控制的大屏中的组件的自定义事件列表,该组件必须已经设置过自定义事件

回调类型:通过在该组件上设置回调值,触发回调后,该回调值会映射到需要远程控制的大屏中。

大屏:需要远程控制的大屏

配置说明

字段

描述

类型

是否必选

说明

type

类型

string


name

字段名

string


displayName

显示名

string


value

字段值

string


示例配置

{
  "type": "remoteOptions",
	"name": "remoteOptions",
  "displayName": "远程控制",
  "value": "{}"	// value为JSON字符串 结构在下面
}

value

{
  type: 'event' | 'callback';
	component: string; // 用户选择的组件id e.g. $component(1)
  event: {	// JSON字符串 受控组件绑定的事件对象
  	type: string;	// 触发控制类型 e.g. click
    action: string;	// 触发后组件执行的动作 e.g. show/hide
    component: string;	// 受控组件的id e.g. $component(1)
    panel: {	// 受控面板(动态面板/引用面板)的数据对象 JSON字符串
      panelId: string;	// 面板id e.g. $panel(panel_1)
      stateId: string;	// 指定切换到面板中某个状态 e.g. $state(1)
    }
  }; 
  screen: string; // 用户选择的屏幕id e.g. $screen(1) 
}


示例Demo下载



如遇其他使用问题,可扫描下方二维码,获取更多产品支持~

400-8505-905复制
免费试用
在线咨询
微信社区
易知微-数据可视化
微信扫一扫入群