如何使用 TypeScript 实现一个天气预报插件？

葡萄城官方账号

博客专家认证

2024-06-26 09:35:39

前言

随着数字化和信息化的发展，数据大屏使用越来越广泛，我们不仅需要展示数据，更需要以一种更加美观的方式展示数据。这就必然需要使用到各种图表组件，比如柱状图、饼图、折线图等等。但是有一些效果不太适合通过这种常规图表实现，比如3D效果图表、组织结构、天气预报等这些特殊效果。那么这种特殊效果，我们就可以自己来开发实现。今天小编以葡萄城公司的嵌入式BI工具——Wyn商业智能为例为大家介绍如何实现一个天气预报插件。

插件开发

Wyn提供了用户自定义可视化插件开发的功能，使用者可以根据自己的实际需求，自己开发符合自己使用场景的、漂亮的可视化组件，来丰富大屏的展示效果。

获取代码

葡萄城公司官方公开了天气预报插件的源码，可以直接在github上获取：Visual/tree/main/%E5%A4%A9%E6%B0%94%E9%A2%84%E6%8A%A5)

代码打包

获取代码之后，在本地的IDE中通过wyn-visual-tools package命令将程序打包生成对应的VIZ插件包。

上传组件

最后将插件包上传到Wyn中进行使用。首先在门户页面上选择"天气预报.viz"组件包。

选择组件之后，点击上传

组件使用

组件上传之后就可以在仪表板中添加使用。

开发说明

开源代码库

葡萄城将已经实现的可视化插件源码已经公开，可以直接在github中获取。比如上面的天气预报插件就是直接从官方的代码仓库中获取的，除此之外还有很多其他的插件供用户下载使用。下载源码、依赖之后就可以直接打包使用了。

从零开始做一个插件

如果官方提供的插件没有需要的，就可以自己开始搭建项目工程，进一步开发插件。

2.1 准备环境

安装10.0.0 以上的版本的node.js 。

然后在IDE（如VS Code）中创建一个空白工程。

安装 wyn-visual-tools 命令集：npm i @grapecity/wyn-visual-tools -g

2.2 工程初始化

通过命令wyn-visual-tools init初始化项目环境，执行成功之后，可视化插件项目的基本工程框架就搭建出来了，后面继续按照框架结构进行开发即可。初始化后的项目结构如下：

assets：存储图片资源。目前仅支持图片，定义中所使用的图片将被编码为base64字符串。
i18nResources：此文件夹用于存放 i18n 文件。
node_modules: 该工程安装的依赖。
src/visual.ts：自定义可视化插件的入口。
capabilities.json：配置可视化插件的一些静态属性，包括数据绑定，属性设置，操作栏的配置。
package.json/package-lock.json: 该项目的npm配置，具体可以参考https://docs.npmjs.com/files/package.json
tsconfig.json: 该项目有关typescript的一些配置，具体可以参考https://www.typescriptlang.org/docs/handbook/tsconfig-json.html
visual.d.ts: 可视化插件提供的一些接口定义。
visual.json：有关自定义可视化插件的一些元信息。
webpack.config.js: 该项目通过webpack进行打包，该文件是webpack的配置文件，具体可参考https://webpack.js.org/configuration/