管理自定义可视化内容

更新时间:
复制为 MD 格式

Quick BI开放平台的自定义可视化页面中,展示了当前组织内创建的所有类型的可视化组件,您可以通过点击组件/菜单/页面标签的方式切换查看,并按需进行注册、编辑、删除等管理操作。本文将为您具体介绍。image

注册

当您需要新增一个可视化组件时,可在对应页面进行注册操作:

  • 注册组件:点击组件页签下的注册组件,在注册组件弹窗中配置相关信息。image

    配置项

    说明

    组件名称

    自定义输入组件名称,该名称后续将展示在物料栏中用于辨识组件,您可以按照其业务含义命名。

    图标

    选择自定义组件的显示图标,该图标后续将展示在物料栏中用于可视化区分不同的自定义组件,支持使用官方素材或上传自定义图片。

    说明

    仅支持上传格式为jpg、jpeg、png、gif的图片,且大小需控制在100K以内。

    适用范围

    选择可使用当前组件的资源范围,支持选择仪表板、数据大屏。

    平台

    选择可使用组件的终端类型,PC端为默认选择且不可取消,您可以按需设置是否使用于移动端。

    开发模式

    选择组件后续的开发模式,支持选择为在线编辑专业模式

    • 在线编辑:自定义组件的开发和调试将在Quick BI控制台中进行,无需安装开发环境,调试的难易度更低、便捷性更强。

    • 专业模式:自定义组件的开发和调试将在本地环境中进行,需要先安装和配置好本地环境,适合复杂组件的开发场景。

    说明

    该处选项会影响后续开发组件的流程,并且注册后不可修改。

    高级配置

    开启ShadowDOM

    开启后,自定义代码与页面上的其他代码将相隔离,可用于样式隔离。

    默认宽高

    设置自定义组件的默认宽度和高度。

    依赖的第三方库

    添加开发自定义组件过程中所使用的第三方依赖。

    点击添加,并维护以下信息:

    image

    • 第三方库名称:通过import语句引入的第三方库的名称,例如:import * as echarts from "echarts"中的"echarts"

    • 模块导出名称:三方库绑定在全局对象上的名称,例如window.echarts中的echarts

    • 三方库 CDN 路径:加载三方库的请求路径,三方库需要符合UMD模块规范。

    关于第三方库的更多说明,请参见三方库CDN

    备注

    给自定义组件添加备注。

  • 注册菜单:点击菜单页签下的注册菜单,在注册菜单弹窗中配置相关信息。image

    配置项

    说明

    菜单名称

    自定义输入菜单名称,该名称后续将展示在对应的菜单栏中用于辨识菜单项,您可以按照其操作意义命名。

    图标

    选择自定义菜单的显示图标,该图标后续将展示在对应菜单栏中用于可视化区分不同的自定义菜单项,支持使用官方素材或上传自定义图片。

    说明

    仅支持上传格式为jpg、jpeg、png、gif的图片,且大小需控制在100K以内。

    菜单类型

    设置菜单的类型,支持选择为图表卡片菜单仪表板菜单电子表格菜单

    平台

    设置可使用当前菜单的终端类型。

    当菜单类型为图表卡片菜单时,可选择PC、移动端;当菜单类型为仪表板菜单电子表格菜单时,仅可选PC。

    开发模式

    选择菜单后续的开发模式,支持选择为在线编辑或专业模式。

    • 在线编辑:自定义菜单的开发和调试将在Quick BI控制台中进行,无需安装开发环境,调试的难易度更低、便捷性更强。

    • 专业模式:自定义菜单的开发和调试将在本地环境中进行,需要先安装和配置好本地环境,适合复杂的开发场景。

    说明

    该处选项会影响后续开发菜单的流程,并且注册后不可修改。

    高级配置

    开启ShadowDOM

    开启后,自定义代码与页面上的其他代码将相隔离,可用于样式隔离。

    展示模式

    设置菜单的展示方式,支持选择为平铺收起

    说明

    PC端图表最多平铺2个自定义菜单,移动端图表最多收起10个自定义菜单。

    展示顺序

    设置当前菜单项在系统菜单列表中的显示顺序,数字越小代表越靠前。

    依赖的第三方库

    添加开发自定义菜单过程中所使用的第三方依赖。

    点击添加,并维护以下信息:

    image

    • 第三方库名称:通过import语句引入的第三方库的名称,例如:import * as echarts from "echarts"中的"echarts"

    • 模块导出名称:三方库绑定在全局对象上的名称,例如window.echarts中的echarts

    • 三方库 CDN 路径:加载三方库的请求路径,三方库需要符合UMD模块规范。

    关于第三方库的更多说明,请参见三方库CDN

    备注

    给自定义菜单添加备注。

  • 注册页面:点击页面页签下的注册页面,在注册页面弹窗中配置相关信息。image

    配置项

    说明

    页面名称

    自定义输入页面名称,该处名称后续将展示在PC端企业门户定制的自定义页面选择列表中,用于辨识页面,您可以按照其业务意义命名。

    图标

    选择自定义页面的显示图标,该图标后续将展示在PC端企业门户定制的自定义页面选择列表中,用于可视化区分不同的自定义页面,支持使用官方素材或上传自定义图片。

    说明

    仅支持上传格式为jpg、jpeg、png、gif的图片,且大小需控制在100K以内。

    适用范围

    选择自定义页面的应用范围,目前仅支持在企业门户中添加自定义页面。

    平台

    选择自定义页面的应用终端,目前仅支持在PC端应用自定义页面。

    开发模式

    选择自定义页面的开发方式,目前仅支持选择专业模式,即:使用SDK本地调试。

    高级配置

    调试地址

    用于调试自定义页面的地址。

    默认为//127.0.0.1:8001,表示后续在Quick BI的企业门户页面中进行调试。您可以按需修改为自己的调试地址。

    开启ShadowDOM

    开启后,自定义代码与页面上的其他代码将相隔离,可用于样式隔离。

    依赖的第三方库

    添加开发自定义页面过程中所使用的第三方依赖。

    点击添加,并维护以下信息:

    image

    • 第三方库名称:通过import语句引入的第三方库的名称,例如:import * as echarts from "echarts"中的"echarts"

    • 模块导出名称:三方库绑定在全局对象上的名称,例如window.echarts中的echarts

    • 三方库 CDN 路径:加载三方库的请求路径,三方库需要符合UMD模块规范。

    关于第三方库的更多说明,请参见三方库CDN

    备注

    给自定义页面添加备注信息。

编辑

当您需要修改可视化组件的信息时,可点击其卡片中的image图标,并在更新弹窗中修改信息。关于编辑弹窗中各配置项的说明,请参见注册image

调试

在自定义可视化开发过程中,您可以调试其实现效果。点击待调试组件卡片中的image图标,并在配置弹窗中选择调试环境、调试范围等信息。配置完成后点击前往调试,即可跳转至宿主页面查看可视化组件的实现效果。image

说明

可视化组件的不同运行状态下,可选的调试环境不同,具体说明请参见运行状态

隐藏

当您需要将某一可视化组件在物料栏中隐藏时,您可以点击其卡片上的image图标,并在提示弹窗中进行二次确认。

image

说明
  • 仅运行状态为待发布、已发布的可视化组件,支持修改显隐状态。

  • 隐藏操作将影响可视化组件的显示状态,具体说明请参见显示状态

发布

当您已完成了可视化组件的开发与调试,需要正式发布到生产环境中使用时,您可点击该可视化组件卡片上的image图标进行发布。不同开发模式下的发布说明不同:

  • 在线模式下,当可视化组件注册成功后,其状态即为待发布。image点击发布图标(image),在弹出的源码弹窗中您可以看到组件详情;点击查看代码对比还可以于代码对比弹窗中查看当前组件代码的具体变动信息。image完成信息确认后点击确认发布即可正式发布。

  • 专业模式下,当您已上传了可视化组件的开发包;或已发布开发包,但信息有调整且未同步到线上时,该可视化组件将处于待发布状态。此时组件卡片上的发布按钮会变为可点击。image点击发布图标(image),在弹出的源码弹窗中您可以查看到文件信息;当已发布开发包,重新上传了修订版本开发包时,此时会显示变更详情。image完成信息确认后点击确认发布即可正式发布。

删除

当您不再需要使用某一可视化组件时,可点击该组件卡片上的image图标,在提示弹窗中二次确认后即可删除该组件。image

删除后,有以下影响:

  • 被删除的可视化组件将无法在物料栏中选择。

  • 先前已经保存过该可视化组件的页面中也将不能显示该组件,并在该组件原来的位置提示组件元信息异常或已被删除。image

组件状态

在管理页面对自定义可视化组件进行增删改等管理操作时,会影响组件的运行状态显示状态

运行状态

运行状态是描述自定义可视化组件从注册到销毁的一系列状态,根据注册时所选择的开发模式的不同而有所不同:

image

状态

说明

可选择的调试环境

开发中

刚注册但未上传开发包的状态,仅专业模式注册成功后会进入此状态。

本地开发环境

待发布

可视化组件的草稿态。

  • 在线模式下,可视化组件注册成功后即进入待发布状态。

  • 专业模式下,当开发中状态上传了开发包,或已发布组件修改了信息时,即进入此状态,此状态不会影响线上已集成的组件。

不同情况下可选的调试环境不同。

  • 当组件未发布过时:本地开发环境、待发布环境

  • 当已发布组件进行了信息修改时:本地开发环境、待发布环境、线上环境

已发布

发布组件后会进入此状态,处于此状态的组件才会在宿主页面的物料栏中显示,已集成的组件会使用最新发布的组件信息。

本地开发环境、待发布环境、线上环境

已删除

删除组件后的状态, 宿主页面的物料栏不可见, 已集成的组件不可用

/

显示状态

显示状态控制已发布的自定义可视化组件是否可以在宿主页面的物料栏中显示,分为以下两种:

  • 显示状态:物料栏可见。

  • 隐藏状态:物料栏不可见,不能再次集成该组件,但已集成的组件仍可用。如果此时您正在宿主页调试组件,则无论隐藏与否都会强制在物料中显示。

运行状态和显示状态的关系如下:

运行状态

显示

隐藏

物料栏是否可见

组件是否可用

物料栏是否可见

组件是否可用

调试中

可见

可用

可见

可用

已发布

可见

不可用

不可见

可用

已删除

不可见

不可用

不可见

不可用