网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

gui.json规范

更新时间:2024-10-22 GMT+08:00
分享

gui.json文件是组件的配置文件。本文介绍gui.json文件的字段详情,您可以参考本文的字段说明,根据自身需求,灵活修改gui.json文件,自定义组件的配置面板。

gui.json规范示例:
1
2
3
4
5
6
7
{
  "name": "newCom",
  "style": [...],
  "data": {},
  "dataSlot": {...},
  "event": {...}
}
表1 gui.json参数说明

参数

是否必选

参数类型

描述

name

String

组件名称。

style

Array of Style object

组件样式面板配置。

data

{}

存放组件更新后的数据,保持值为{},请勿删除。

dataSlot

Object

组件数据面板配置,详情请参见组件数据面板配置

event

Object

组件交互面板配置,详情请参见组件交互面板配置

组件样式配置

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
  "style": [
    {
      "label": "全局样式",
      "labelId": "global_style",
      "isExpand": true,
      "children": [
        {
          "label": "字体大小",
          "name": "fontSize",
          "type": "number",
          "min": 12,
          "max": 32,
          "value": 12
        },
        {
          "label": "字体粗细",
          "name": "fontWeight",
          "type": "select",
          "options": [
            {
              "key": "Normal",
              "value": "normal"
            },
            {
              "key": "Bold",
              "value": "bold"
            }
          ],
          "value": "normal"
        },
        {
          "label": "颜色",
          "name": "color",
          "type": "color",
          "value": "#ffffff"
        }
      ]
    }
  ],

Style参数为数组形式,其中每个数据元素将形成一个样式配置项,每个数据元素还能包含相关的子配置项,最多支持两层,具体参数说明如下:

表2 Style参数说明

参数

是否必选

参数类型

描述

label

String

配置项标签名称。

isExpand

Boolean

是否展开子配置项。

  • true:展开。
  • false:不展开。

name

String

配置项key值,用户在命名时要注意唯一性(只限于当前组件)。

配置项的其他属性参数

-

不同UI类型具有不同的属性参数,请参见UI类型介绍

children

Array of children object

配置项所拥有的子配置项,如下图所示全局样式下包含字体和颜色等配置。

表3 children参数说明

参数

是否必选

参数类型

描述

label

String

子配置项标签名称。

type

String

样式配置输入框类型,DataArts Insight开放的UI类型请参见UI类型介绍

name

String

子配置项key值,用户在命名时要注意唯一性(只限于当前组件)。

value

String | Number

子配置项样式取值。

子配置项的其他属性参数

-

不同UI类型具有不同的属性参数,请参见UI类型介绍

示例如下所示:

图1 style示例
表4 样式面板示例说明

区域编号

描述

1

对应字段isExpand。

2

对应字段label。

3

对应字段type,此处type分别为number、select、color类型。

组件数据面板配置

dataSlot:组件的数据面板槽位相关配置。

示例如下:
1
2
3
4
5
6
7
8
9
"data": {
  "version": "2.0"
  "dynamicData": {
      "slots": [...]
      "filter": true,
      "sort": true
},
 
}
表5 dataSlot参数说明

参数

是否必选

参数类型

描述

version

“2.0”

值固定为“2.0”。

slots

Slot[]

数据面板中的数据配置区域,参考slots参数说明

filter

Boolean

数据面板中是否展示过滤槽位。

sort

Boolean

数据面板中是否展示排序槽位。

图2 组件数据面板
  • dataSlot配置示例

    示例中dataSlot参数如下:

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    "dataSlot": {
      "version": "2.0",
      "dynamicData": {
        "slots": [
          {
            "areaId": "area_value",
            "label": "度量槽位",
            "rule": {
              "maxColNum": 1,
              "mimColNum": 0,
              "needAggregator": true
            }
          }
        ],
        "filter": true,
        "sort": true
      }
    },
    

    其中slots为槽位的定义如下:

    表6 slots参数说明

    参数

    是否必选

    参数类型

    描述

    areaId

    String

    数据槽位类型,可选值参考AreaId说明

    label

    String

    数据槽位展示名称。

    rule

    Object

    配置数据槽位规则和限制,参考rule说明

  • AreaId说明

    AreaId标识数据面板槽位类型,AreaId值如下:

    表7 AreaId值说明

    描述

    area_column

    列槽位,支持维度和度量。

    area_type

    维度槽位,只能拖拽维度字段。

    area_value

    度量槽位,只能支持度量字段。

    area_color

    颜色图例槽位,只支持维度,用于对数据进行分类。

  • rule说明

    rule为数据面板槽位规则信息,rule参数说明如下:

    表8 rule值说明

    是否必选

    类型

    描述

    minColNum

    Number

    数据面板槽位最少需要的字段个数。

    maxColNum

    Number

    数据面板槽位最多支持的字段个数。

    dataType

    String[]

    支持的字段类型,可选值为“STRING”、“DATE”、“NUMBER”,不配置该字段则默认为匹配AreaId对应的类型。AreaId说明

    typeErrorTip

    String

    向数据面板槽位拖拽字段类型和槽位不匹配时的提示内容。

组件交互面板配置

event:组件的交互相关配置。

示例如下:

"event": {
  "eventConfig": [
    {
      "type": "select"
    }
  ]
}

Event为key:value形式的对象,其中key值为交互事件名称定义,value值为交互事件的相关配置,具体如下:

表9 event value参数说明

参数

是否必选

参数类型

描述

eventConfig

Arrary

交互配置,值为数组。

表10 eventConfig参数说明

参数

是否必选

参数类型

说明

type

select、drive、link

  • select:允许组件在交互面板里通过交互编辑的方式定义交互事件,该事件和drive、link类型不支持同时配置。
    • isMultivalue:值为true时,操作符只能为“in”,适用于多选下拉。值为false时,操作符包括“=”、“≠”“﹥”等,适用于单选下拉。如图4所示,此时isMultivalue值为true。
      说明:

      select、isMultivalue只支持大屏,不支持仪表板。

  • drive:允许组件在交互面板里配置联动,和select类型不支持同时配置。
  • link:允许组件在交互面板里配置跳转。
图3 type为select的交互入口

图4 type为select的示例

图5 type为link和drive示例

相关文档