跳到主要内容

items

描述

可选。一个数组,包含 Diagram Editor 的 Toolbar 上显示的控件

用法

items?: (object | string)[];

通过字符串配置 items

items 属性允许您将服务元素指定为一个字符串数组:

items: [ "file", "edit", "view", "arrange", "spacer", "scale" ];

完整的服务元素列表请参见此处

通过对象配置 items

items 属性允许您将服务元素基础元素指定为一个对象数组:

items: [
{
type: string,
id?: string,
value?: string,
hotkey?: string,
icon?: string,
hidden?: boolean,
disabled?: boolean,
css?: string | string[],
items?: (string | object)[],
checkIcon?: (editor: object) => string,
handler?: (editor: object, event: Event) => void
}, {...}
];

参数

对于所有服务元素separator / spacer / scale 除外),您可以指定一个具有以下参数的对象:

  • type - (必需)- 服务元素的类型。服务元素类型的完整列表请参见此处
  • id - (可选)- 服务元素的 ID。默认情况下,服务元素的 ID 包含 $ 和该服务元素的 type$file
  • value - (可选)- 服务元素的标签
  • hotkey - (可选)- 服务元素的快捷键组合标签
  • icon - (可选)- 服务元素图标的 css 类
  • hidden - (可选)- 隐藏服务元素
  • disabled - (可选)- 禁用服务元素
  • css - (可选)- 为服务元素应用自定义 css 类
  • items - (可选)- 定义子元素的结构
  • checkIcon - (可选)- 返回图标 css 类的处理函数。调用时带有以下参数:
    • editor - Diagram Editor 对象
  • handler - (可选)- 当 clickinputChange 事件发生时运行的处理函数。调用时带有以下参数:

示例 1

下面的示例展示了如何通过字符串配置 Toolbar 的 items:

// 通过字符串配置 items
const editor = new dhx.DiagramEditor("editor_container", {
type: "default",
view: {
// toolbar: true, // 显示默认 Toolbar
// 或通过对象配置 Toolbar
toolbar: {
css: "custom_css",
navigationType: "pointer",
items: [
"file",
"spacer",
"scale"
]
}
}
});

示例 2

下面的示例展示了如何通过对象配置 Toolbar 的 items:

const editor = new dhx.DiagramEditor("editor_container", {
type: "default",
view: {
toolbar: {
css: "custom_css",
navigationType: "pointer",
items: [
{
type: "file",
items: [
"importJson",
{
type: "exportJson",
value: "Export to JSON"
},
{
id: "custom_id_1",
type: "menuItem",
value: "Server export",
icon: "dxi dxi-vault",
items: [
"exportPdf",
{
id: "custom_id_2",
type: "menuItem",
value: "PNG",
handler: editor => {
editor.diagram.export.png();
// 自定义逻辑
}
}
]
}
]
},
"spacer",
"scale"
]
}
}
});

更新日志:v6.0 中新增

相关文章: Toolbar 配置

相关示例: Diagram Editor。默认模式。工具栏自定义。新增按形状搜索功能