You need to enable JavaScript to run this app.
导航
自定义插件包发布与插件包资源
最近更新时间:2024.04.23 10:56:38首次发布时间:2024.03.26 16:21:34

1.概述

自定义可视化是本产品提供的开放能力之一,它支持用户根据需求创建个性化的数据展示。本文为您介绍的是自定义可视化中的插件发布与部署插件包资源,您可以通过本文获取部署插件包的资源或自行开发所需插件,并完成插件包的发布流程。(目前,自定义可视化功能还在内测阶段,若您对该功能有具体需求,欢迎联系火山引擎商务团队,以获取更多购买和合作的详细信息)。
注意:在您阅读并完成本文的配置项前,需要先依次完成《自定义可视化概述》《自定义图表插件结构与开发》《自定义插件数据结构与插件属性配置》中的相关配置。

2.插件包发布

在本产品中使用插件需要先将插件包上传至插件市场,上传后完成审核发布,即可在本产品内使用。

该页面内容为演示效果,实际资源包请依据您的开发情况确定,官方插件包资源请以第3小节为准。

2.1 准备工作

准备所有待上传插件的插件包、插件图标、示意图片、描述信息等。

2.2.1 自行开发插件

针对您自行开发的插件,本地调试完成之后,需要在项目根目录下执行:

npm run build

执行结束后根目录下会出现名为satellite.tgz的压缩包,即为待上传的插件包。
此外,您还需要准备对应的插件图标(SVG/PNG均可)、示意图片(对于该插件展示效果的描述图片)、描述信息(插件的基本信息)。

2.1.2 官方插件

本产品也提供了BoxplotMekkoTreemap等类型的官方插件图表,您可以将这些官方插件包直接上传至插件市场进行使用。相关资源请您查看本文的第3小节《插件包资源》获取。

2.2 插件上传

注意:如果需要上传的插件在插件市场已经存在,建议使用更新版本的方式完成插件安装。否则插件市场将出现多个同类型插件。
从本产品进入开发者后台页面/bi/developers/console/ ,如下:

该页面内容为演示效果,实际资源包请依据您的开发情况确定,官方插件包资源请以第3小节为准。

点击上传插件,进入上传页面。

2.2.1 信息完善

请您完成名称、简介、描述等信息的配置,并上传对应图标和示意图(如果是官方插件,可参考本文的第3小节《插件包资源》提供的信息)。

填写完成后点击【下一步】,进入【可见性设置】。

2.2.2 可见性设置

首先,您需要设置插件在插件市场上的可见范围:

(1)公开
所有人都可以在插件市场中访问到该插件。
(2)部分项目

  • 选择部分项目后,需要输入可见项目。
  • 设置的可见项目可以在插件市场中访问到该插件。

(3)不公开
设置为不公开后插件市场中找不到该插件。
其次,请您选择完成后点击【下一步】,进入【上传插件】。

2.2.3 开始上传

将第一步中生成的插件包点击上传。上传完成后点击发布,插件处于审核中状态,由管理员审核通过后插件发布完成。
进入插件市场即可以看到上传完成的插件。

2.3 插件审核

当前只有账号名为admin的管理员可以审批插件。管理员身份进入开发者后台,右上角可以看到管理员中心,点击即可进入管理员控制台。

管理员控制台中插件审核可以看到当前所有待审核状态和已完成状态的插件。
在待审核列表中的操作栏点击通过即可完成插件审核。审核成功的插件将自动发布在插件市场。

2.4 更新版本

后续如果需要更新插件版本,进入开发者后台页面/bi/developers/console/,点击列表中的查看按钮进入插件详情页面。

进入详情页面后,先点击左侧的【版本管理】进入版本操作页面,点击右上角的【创建版本】按钮:

在创建版本弹窗中填写新的版本号和更新说明,上传新的插件包,点击确定后新的插件版本进入审核状态,审核通过后新的版本发布成。

3.插件包资源

3.1 矩形树图

基于G2实现的矩形树图

satellite.tgz
未知大小

(1)插件图标
图片
(2)示意图片
图片
(3)描述信息
矩形树图使用空间大小直观展示数据占比关系,支持1个或多个维度1个指标、0个维度多个指标。

  • 1个或多个维度1个指标 ,如:维度 [省份] 指标 [利润],生成表达不同省份的利润大小的矩形树图。
  • 0个维度多个指标 ,如:维度 [空] 指标 [利润] [销售额],生成表达 利润和销售额占比关系的矩形树图。

3.2 Mekko图

Mekko Chart(市场矩阵细分图)是一种二维堆积图。
插件包

satellite (1).tgz
未知大小

新版mekko插件包(支持字段指定颜色临时版本)
extension.tgz
未知大小

新版mekko插件包(移除最大堆叠数限制版本)
extension (1).tgz
未知大小

(1)插件图标
图片
(2)示意图片
图片
(3)描述信息
Mekko图维度轴显示组,同时度量轴显示每个类别项目的规范化百分比值,每个组的大小显示其值。
在 Mekko 图中,您需要两个维度和一个度量:

  • 每个条形对应于第一个维度,基于第二维度分为较小的类别标签,不同类别展示为不同颜色。
  • 度量的值确定每个条形内部相关的类别高度以及条形的尺寸。
  • 同时您也可以拖进一个颜色维度。当存在颜色维度时,标签会按照该颜色维度类别显示颜色。
    • 如:维度 [创作类型] [创作状态] 指标 [阅读量] 颜色 [平台],则展示为按创作类型分为若干条形,每个条形中按创作状态分为若干标签,标签高度代表阅读量值,标签颜色为当前平台维度对应颜色。

3.3 日历色块图

日历色块图由小色块有序且紧凑的组成的图表,以日历格式展示,用来展示一段时间内的数据分布情况。

satellite (2).tgz
未知大小

(1)插件图标
图片
(2)示意图片

(3)描述信息
每个小色块代表时间维度,而小色块颜色则代表指标。
1维度1指标,且维度类型为日期类型,如:维度 [日期] 指标 [阅读量]。

3.4 排行榜图

排行榜图是描述排名顺序或关键进度指标的条形图

satellite (3).tgz
未知大小

(1)插件图标
图片
(2)示意图片

(3)描述信息
排行榜一般反映指标在维度中的分布及排名顺序,简洁地展示TOP N的降序排行。例如,排行榜根据付款金额从大到小的顺序展示TOP 10省份。

3.5 Boxplot图

基于G2实现的Boxplot图

satellite (4).tgz
未知大小

(1)插件图标
图片
(2)示意图片

(3)描述信息
箱形图(Boxplot)又名盒须图、盒式图或箱线图,用作显示数据分散情况的统计图,支持使用1个或多个维度,1个指标进行绘图。

  • 1维度1指标 ,如:维度 [城市] 指标 [利润]
    • 生成1个由不同城市的利润分布构成的盒形图,通过可视化效果能够看到 最大值、最小值、中位数、以及上下四分位数所在数据标注点,了解对应城市的利润数值的统计分布。
  • 2维度1指标 ,如:维度 [省份] [城市] 指标 [利润]
    • 生成多个盒形图,坐标轴为省份。每个省份生产一个盒形图表达该省份下不同城市利润的统计分布。