检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
{widget}.js 文件介绍 {widget}.js为组件逻辑文件,整个Widget的渲染核心JS,在组件编辑状态和页面最终的发布运行态都会被加载执行。一个推荐的组件架构,应包含表1中API。其中,init、render和beforeDestory为组件的通用生命周期函数,其余为推荐模板实现。
{widget}.editor.js 文件介绍及示例 eventConfig classfication propertiesConfig 父主题: 目录文件详解
{widget}.editor.js为组件属性定义文件,负责组件编辑状态时需要渲染的界面和逻辑。其中,“{widget}”为自定义组件的名称,如本示例中该文件名为“EchartsWidgetTemplate.editor.js”。{widget}.editor.js文件只在组件编辑状态被加
clickSeries对象中,“desc”是对事件selectItem的解释。“fields”为组件对外暴露的字段及相应描述。相应代码要在{widget}.js中实现如下: this.echartsInst.on('click', 'series', (event) => {
name: 'tooltip' } ] ], 图1 设置后效果 父主题: {widget}.editor.js
config数组中,每一个对象保存的配置项信息。config中,配置项的介绍,请参见组件配置项(Config配置)。 父主题: {widget}.editor.js
{widget}.editor.js:组件核心渲染文件。组件属性定义文件,负责组件编辑状态时需要渲染的界面和逻辑。 {widget}.flt:组件DOM结构文件,需要在服务端提前渲染的部分可以写在此文件中,相当于HTML文件,负责样式展示。 {widget}.js:组件逻辑文件,整个Wi
作列表中展现。 inReader 判断当前页面状态是开发态或预览态。 registerWidget 必须在{widget}.editor.js中注册组件,使用方式参考如下: /* @param {string} widgetName * @param {string} description
组件对接数据配置开关 组件的数据可来自于静态数据或通过数据集获取,以EchartsWidgetTemplate组件为例,在“{Widget}”.editor.js文件中,可配置组件接入的数据。当识别到组件propertiesConfig中存在dataSetting类型的配置项时,默认组件需要对接数据集。配置示例如下:
代码结构介绍 了解代码目录结构 目录文件详解 父主题: 自定义组件开发规范
i18n.json packageinfo.json {widget}.css {widget}.editor.js {widget}.ftl {widget}.js 父主题: 代码结构介绍
配置项总览 本章节介绍AstroCanvas支持的组件配置项,您可以通过{widget}.editor.js文件中定义的type字段,来定义组件的类型和配置。 表1 配置项总览 类别 类型 说明 输入框 input 单行文本输入框 textarea 多行文本输入框 数字类型 input-number
json包含所要引入的文件。例如,MintUI库需要引入的文件有“js/index.js”和“css/index.css”文件,请在packageinfo.json中添加这两个文件的描述,如下所示。其中,“js”和“css”定义文件类型,“name”定义文件路径及名称。 { "js": [ {
zip字段说明 字段名 字段说明 sendSelect 自定义的事件名为“sendSelect”,必须配置。 须知: 需要在组件“.js”文件逻辑代码中,使用“Studio.registerEvents()”方法注册该事件,并使用“thisObj.triggerEvent()”方法触发该事件。
注册自定义事件 自定义事件在{widget}.editor.js文件中的eventConfig配置项中注册,以global_SelectWidget组件为例: 在文件global_SelectWidget.editor.js中定义事件 eventConfig: { sendSelect:
css,EchartsWidgetTemplate.editor.js修改为BarGraph.editor.js,EchartsWidgetTemplate.ftl修改为BarGraph.ftl,EchartsWidgetTemplate.js修改为BarGraph.js。 图3 修改后效果 进入重名后的BarGraph
初始化代码块、实例化代码块、自定义事件和自定义动作。 图4 代码设置 初始化代码块:初始化代码块输入框是一个javascript的执行环境,该执行环境的目的是调用echarts的init方法创建实例,此处可配置初始化相关的操作,包括echarts的主题等。 图5 初始化代码块 单
{widget}.css 文件介绍 {widget}.css为组件的样式文件,在该文件中编写组件的CSS样式。 AstroCanvas的组件未进行打包编译,CSS样式可能存在互相影响的风险。因为,CSS选择器务必要加上组件id,通过组件id减少互相影响的可能。 文件示例 #EchartsWidgetTemplate
{widget}.ftl 文件介绍 {widget}.html为组件DOM结构文件,相当于HTML文件,负责样式展示。 在AstroCanvas中自定义组件时,需要在服务端提前渲染的部分,可以写在此文件中。 文件示例 <div id="EchartsWidgetTemplate"
packageinfo.json 文件介绍 packageinfo.json是组件的元数据描述文件,用于配置组件的基本信息。 文件示例 { "widgetApi": [{ "name": "EchartsWidgetTemplate" }], "widgetDescription":