[]
首页
开发者学堂
文档
活字格 SpreadJS GcExcel Wyn
论坛
市场
生态机会
招聘求职 项目合作
活动
活动公告 悬赏达人 GCDG
产品官网 帮助文档 API 文档 视频教程 技术社区
v9.0
在线Demo 免费试用
(Showing Draft Content)

Wyn插件开发概览

1.1 什么是 Wyn 可视化插件

Wyn 商业智能支持自定义可视化插件，允许开发者创建和扩展各种数据可视化组件，包括但不限于：

  • 基础图表：柱状图、折线图、饼图等

  • 地图类：Bing 地图、热力图、流向图等

  • 特殊图表：组织结构图、桑基图、词云等

  • 交互控件：下拉框、日期选择器等

  • 动画与增强效果：动态数字、3D 旋转类效果等

从客户视角看，插件主要有 3 种来源：

  1. 系统内置插件：开箱即用。

  2. 应用市场插件：从葡萄城应用市场下载 .viz 包后上传使用。

  3. 自定义开发插件：按本文第 2–5 章进行开发，打包为 .viz 后上传。

内置插件概览

系统内置 30+ 可视化插件。系统管理员可在「系统管理 > 文档管理 > 可视化插件」中查看和管理；拥有仪表板创建权限的普通用户可在仪表板设计器中直接调用。


系统内置免费插件：

  • 图片旋转3D

  • 3D饼图

  • 图片旋转2D

  • 扩展饼图

  • 监控视频

  • 动态数字

  • 状态时间图

  • 扩展指示器

  • 组合饼图

  • 嵌套饼图

  • 里程碑图

  • 3D旋转三棱锥

  • 组织结构图

  • 箱线图

  • 图片轮播

  • 四象限分布图

  • 桑基图

  • 关系图

  • 动态标题

  • 日期时间

  • 3D旋转KPI

  • 视频播放

  • 组合地图

  • 直方图

  • 热力日历图

  • 瀑布图

  • 滚动文本

  • 3D四棱锥

  • 流向地图

  • 帕累托图

  • 对比条形图

  • 天气预报

  • 3D倾斜旋转KPI

系统内置收费插件：

  • 3D饼图（收费）

  • 3D组合地图（收费）

技术栈与核心概念

  • 语言：TypeScript

  • 样式：LESS

  • 构建：Webpack

  • 常见图表库：ECharts、G6、D3.js、Three.js

  • 地图库：Bing Maps

概念

说明

WynVisual

所有插件都需要继承的主类

VisualHost

宿主环境，提供选择、提示、本地化、过滤、命令等服务

DataView

数据绑定后的运行时数据结构

SelectionId

交互联动、交叉筛选、提示菜单所依赖的选择标识

capabilities.json

插件的静态能力定义文件：数据绑定、属性、动作、分析

visual.json

插件元数据与运行参数定义

界面位置说明

  • 系统管理员查看插件列表的界面，以及普通用户在设计器中打开可视化插件面板的界面。

  • 插件可以像内置组件一样被拖拽到仪表板画布中使用。

1.2 获取插件：内置、市场、自研三条路径

路径一：直接使用系统内置插件

当内置图表已经满足需求时，用户可在仪表板设计器中直接拖拽使用，无需上传。

路径二：从应用市场下载插件

当内置组件不能满足业务需求时，可从应用市场获取 .viz 插件包。常见入口有 3 个：

  1. 从设计器进入应用市场

    • 打开仪表板设计器

    • 切换到“可视化插件”面板

    • 点击底部“下载更多插件”

    • 跳转到应用市场后选择适配版本并下载

  2. 从系统管理页进入应用市场

    • 系统管理员进入「系统管理 > 文档管理 > 可视化插件」

    • 点击右上角“下载更多插件”

    • 选择适配版本并下载

  3. 直接访问应用市场网站

1.3 上传插件：门户与管理后台两种方式

无论插件来自应用市场还是自行开发，必须先上传到系统，才能在设计器中被使用。

方式一：在文档门户上传

  1. 登录系统并进入文档门户。

  2. 点击“工作空间”。

  3. 将 .viz 插件包拖拽到上传区域。

  4. 上传完成后，插件即可进入系统资源。

方式二：在系统管理后台上传

  1. 系统管理员进入「系统管理 > 文档管理 > 可视化插件」。

  2. 点击“上传”。

  3. 将 .viz 拖拽到上传区域。

  4. 确认无误后点击“确定”。

上传后的统一结果

  • 插件进入系统插件库。

  • 打开仪表板设计器后，可在“可视化插件”面板中找到该插件。

  • 使用方式与内置图表一致：拖拽、绑定数据、设置属性、展示结果。

1.4 插件管理：升级、删除、重命名、下载、参数设置

上传完成后，系统管理员可在插件管理界面进行统一管理。

升级插件

  • 如果上传的插件已存在，系统会比较版本号。

  • 新上传版本小于或等于当前版本：不允许上传。

  • 新上传版本高于当前版本：系统显示升级入口，提交后完成升级。

删除插件

  • 仅系统管理员可删除插件。

  • 支持单个删除和多选批量删除。

重命名插件

  • 在插件操作菜单中点击“重命名”。

  • 在弹窗中输入新名称并确认。

下载插件

  • 在插件操作菜单中点击“下载”，即可下载当前插件包。

设置插件运行参数

管理后台支持对插件运行参数进行设置，重点声明：

  • DIV / iFrame 运行方式切换

    • 默认值为“否”，即运行于 DIV

    • 设置为“是”时，运行于 iFrame

这类可配置参数的底层定义来自 visual.json > configuration，详见第 3 章。

1.5 设计器中的实际使用与收费授权

在仪表板设计器中使用

当插件上传成功后：

  1. 打开仪表板设计器。

  2. 在“可视化插件”面板找到目标插件。

  3. 将插件拖拽到画布。

  4. 绑定数据。

  5. 设置属性。

  6. 查看最终可视化结果。

收费插件试用与授权激活

收费插件策略如下：

  • 可视化插件包含免费版和付费版。

  • 付费插件支持 90 天试用。

  • 试用期间会带有试用版水印或试用提示。

  • 建议通过插件市场购买授权。

  • 授权按大版本购买：如 1.0.2 的大版本是 1；小版本升级一般不需要重新购买，大版本升级需要重新购买。

  • 购买授权后会得到一个以 .cvl 结尾的授权文件。

激活步骤

  1. 系统管理员进入「系统管理 > 运维管理 > 产品授权 > 可视化插件授权」。

  2. 点击“添加可视化插件授权”。

  3. 选择 .cvl 授权文件。

  4. 若右侧状态显示为绿色加号，表示授权满足条件。

  5. 勾选所需授权并点击“导入”。

  6. 导入成功后，即可在设计界面正常使用收费插件。

注意事项

  • 试用版 Wyn 无法使用正式授权版插件。

  • 若用户准备使用新大版本插件，需要重新购买对应授权。