更新时间:2021-09-18 GMT+08:00
分享

算子配置API

算子配置API

算子配置API接口说明,如表1所示。

表1 算子配置API介绍

参数

说明

id

标识算子,全局唯一。

disabled

标识算子在菜单中是否可用。

配置为“true”,则当前算子置灰展示,不可用。

默认值:false

show

标识算子在菜单中是否展示。

默认值:True

icon

算子在菜单中展示的图标。

使用require引入图片,不能直接写图片路径。在jupyterlab 2.x版本中,使用require引入图片之后,必须通过default属性才能获取到图片路径,正确配置示例为“require('../../assets/style/images/toolbar/data.png').default”。

label

算子标签内容。

actions

算子对应的动作组。

可包含多个动作,具体配置请参见表2

items

子算子列表。

数组类型,每个子算子的数据结构与当前接口相同。

算子actions配置

算子actions配置参数说明,如表2所示。

表2 算子actions配置参数说明

参数

说明

id

算子动作组ID。

也用作算子动作组注册为命令的命令ID,需要保证全局唯一。

type

算子类型。

register

标识算子动作组是否注册为命令。

默认值:true

items

算子动作组配置列表。

数组类型。每个条目格式为:

{
type: ActionType;
content: ContentType;
}

其中,“content”的值根据不同的type,有不同的配置。“ActionType”可以有如下几种取值:

  • markdown:插入Markdown节点后,输入算子需要展示的标题和描述对应的Markdown源码。
  • code:插入代码节点,输入需要执行的sdk代码段或“ (columnList: string[]) => string”形式的回调函数。其中,“columnList”会传入,在上一个cell中被spread选中的列,用户无需关注。返回的是带“columnList”的sdk代码段,用来实现cell之间的列选择继承的交互体验。
    说明:

    后续会陆续支持其他变量在cell之间的传递,有兴趣的可以贡献代码。

  • callback:输入“(panel: NotebookPanel)=> void”形式的回调函数。其中,“panel”会在notebook-toolbar组件中传入,用户无需关注。
  • command:执行命令,可以是jupyterlab平台自带命令、用户定制命令或其他算子注册命令。输入命令ID。
  • analysisChart:回写数据探索图表到cell。输入需要回写的图片base64编码,可以从“echartInstance”对象导出,参见data-analysis模块用法。
分享:

    相关文档

    相关产品

close