检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
责任人:数据集的创建人。 描述:新建数据集的描述信息,通常设置为数据集的功能。 配置数据集参数。 图3 设置数据集 应用:选择调用自定义接口所属的应用。 API接口:选择待调用的API接口,下拉框中的选项取值为接口的标签,如果接口标签取值为中文,则这里“API接口”显示为中文标签
组件内置API 内置API一览表 Studio对象预置API一览表 magno对象预置API一览表 HttpUtils工具类预置API一览表 SafeUtils安全工具类预置API一览表 父主题: 自定义组件开发规范
内置API一览表 表1 内置API一览表 API API说明 init 组件渲染的入口函数,组件自己实现继承,使用推荐模板即可。 render 整个组件渲染的业务逻辑实现入口,组件自己实现继承。 getConnectorProperties 获取Connector对接的配置值,用于查看与Connector相关的信息。
magno对象预置API一览表 表1 magno对象预置API一览表 API API说明 savePropertiesForWidget() 用于在开发态中保存当前组件的高级设置属性信息。 savePropertiesForWidget() 该API用于在开发态中,保存当前组件的高级设置属性信息。
Studio对象预置API一览表 表1 Studio对象预置API一览表 API API说明 registerWidget 定义组件。 registerConnector 定义桥接器。 registerEvents 注册事件,只有通过此API注册后的事件才会在组件的事件列表中展现。 registerAction
HttpUtils工具类预置API一览表 表1 HttpUtils工具类预置API一览表 API API说明 getCookie 用于获取某个cookie的值。 setCookie 用于设置cookie的值。 getI18n 返回一个Vue18n的实例。 getCsrfToken 通过ajax的方式,调用平台的接口时使用。
SafeUtils安全工具类预置API一览表 表1 SafeUtils安全工具类预置API一览表 API API说明 escapeHtml() 将HTML字符串进行转义。 getSafeUrl() 对外部链接进行xss安全过滤,获取安全的绝对URL地址。 escapeHtml()
数据源名称:新建数据源的名称,用于标识该数据源。长度为1~32个字符,可包括中文、字母、数字及下划线,且不能以下划线开头或结尾。 APIC服务地址:ROMA Connect服务集成APIC的网关地址,配置该值后,可实现调用ROMA Connect的服务API。 服务集成APIC(API Connect,简称APIC)是ROMA
在数据类型中,选择“桥接器预置”,并选中所需的桥接器。 设置桥接器预置数据。 图2 设置桥接器参数 桥接器数据类型:桥接器的数据源类型,支持“静态数据”和自定义接口“AstroZero API”。 URL:配置为自定义接口的URL。如何查看自定义接口URL,请参考查看自定义接口。“桥接器数据类型”选择“AstroZero
责任人:数据集的创建人。 描述:新建数据集的描述信息,通常设置为数据集的功能。 配置数据集参数。 图2 ROMA连接器配置示例 API接口:API请求路径。 请求类型:请求的类型,如GET、POST。 参数:输入参数,请根据实际请求进行配置。 测试API接口:用于测试该接口,单击“测
约束与限制 AstroCanvas实例 表1 AstroCanvas实例规格约束与限制 限制项 约束与限制 实例版本 AstroCanvas目前支持的实例版本有:Astro大屏应用基础版、Astro大屏应用专业版和Astro大屏应用企业版。 Astro大屏应用基础版:基于平台预置
接口鉴权方式:设置接口鉴权方式,支持API鉴权、AK/SK、API Key和无身份验证。 API鉴权:填写API鉴权信息后,可在连接器中选择其响应参数,作为连接器请求参数的值。 无身份验证:不需要任何验证信息,直接调用接口,通常用于访问一些公开的接口。 AK/SK:通过访问密钥进行接口鉴权。访问密钥即AK/SK(Access
文件字段说明 widegtApi > name:组件的名称,如“EchartsWidgetTemplate”。 widgetDescription:组件的描述信息。 authorName: :组件的作者信息。 width:在绝对布局高级页面中,添加该组件时的默认宽度,单位为“px”,不填写默认为“200px”。
应用:选择调用自定义接口所属的应用。 API接口:选择待调用的API接口,下拉框中的选项取值为接口的标签,如果接口标签取值为中文,则这里“API接口”显示为中文标签。如果接口标签未定义,则显示接口的操作名称。 请求类型:API接口的请求类型,系统会自动填入。 参数:接口入参,当有入参时,系统会自动展示。
js为组件逻辑文件,整个Widget的渲染核心JS,在组件编辑状态和页面最终的发布运行态都会被加载执行。一个推荐的组件架构,应包含表1中API。其中,init、render和beforeDestory为组件的通用生命周期函数,其余为推荐模板实现。 表1 组件架构组成 API名称 API解释 是否必须 init(生命周期函数)
如何基于页面级的全局变量实现组件交互中实现的场景是:用户在“下拉选择框”中选择某个告警状态时,通过配置的交互事件将告警状态赋值给全局变量,“多区域折线图”组件呈现的数据来源于封装了AstroZero某API接口的数据集,将该接口的入参与全局变量绑定,则“多区域折线图”组件呈现的告警数据会随着全局变量值变化而变化。
图4 设置数据集 应用:选择调用自定义接口所属的应用,本示例选择AstroZero中安装的“告警服务Mock应用”。 此处的“告警服务Mock应用”仅为示例,在实际使用时,选择AstroZero中已安装的一个应用即可。 API接口:API接口的URL,本示例选择“getWarnDetailByStatus”接口。
组件对接数据配置开关 组件的数据可来自于静态数据或通过数据集获取,以EchartsWidgetTemplate组件为例,在“{Widget}”.editor.js文件中,可配置组件接入的数据。当识别到组件propertiesConfig中存在dataSetting类型的配置项时,默认组件需要对接数据集。配置示例如下:
操作场景 在配置组件交互时,可以通过编写代码实现自定义交互动作,从而实现对应的业务需求。 图1 自定义动作 自定义动作参数说明 在自定义动作中,支持直接使用的参数如下: eventParam:组件传递出的参数。 以日期选择器组件为例,介绍如何获取eventParam。 在页面中,拖入一个日期选择器组件到画布中。
测试API接口:用于测试该接口,单击“测试API接口”,“样例报文”中会显示输出结果。 样例报文:对应API接口的响应样例报文数据格式,数据集的元数据结构由该样例报文经转换器处理后的数据结构确定。 单击“格式化”,可对样例报文进行格式化处理。 转换器:建议使用系统预置的“Pro