接口: DockTab
定义于:interfaces/GraphUI.ts:1365
底部停靠栏中的一个窗格 — 其选项卡栏中的一个条目。
码头拥有 region:网格行、其高度、调整大小分隔线和折叠。选项卡拥有其 in 的内容 — 一个主体,以及可选的其自己的标题控件,当活动选项卡发生更改时,停靠栏会换入和换出这些控件。仅注册一个选项卡时,根本不会绘制条带;没有什么可以切换的。
在图表生命周期中的任意时刻使用 graph.UIManager.addDockTab() 注册一个,或者通过 ctx.addDockTab() 从插件的 install 注册一个。要么返回一个处理器。
一个选项卡是一个窗格,而不是一个视图。 具有多个视图的窗格(数据表的 Nodes 和 Edges)是一个 单个 停靠选项卡,它在其 toolbar 中绘制自己的开关并调用DockTabHandle.刷新改变身体。因此,扩展坞的条带列出了窗格(Table、Events),并且永远不会将一个窗格的视图与另一个窗格并排展平;出于同样的原因,这两个级别的绘制方式有所不同。
数据表本身就是这样一个选项卡,因此注册选项卡与内置选项卡具有完全相同的特权。
示例
const dispose = graph.UIManager.addDockTab({
label: 'Audit',
render: () => myAuditPane(),
toolbar: () => [clearButton],
})派生类型
属性
icon?
optionalicon:string
定义于:interfaces/GraphUI.ts:1382
在条带中的标签之前绘制的字形,标记窗格的来源。
一个SVG字符串,注入了innerHTML和未清理——它必须是可信的,就像PivotDefinition.icon一样。当多个选项卡与窗格的kind相同时很有用:四个候选评论和一个数据表,否则读取为五个列表。
id?
optionalid:string
定义于:interfaces/GraphUI.ts:1371
稳定的身份:removeDockTab/activateDockTab采取什么,以及写在条带按钮上的data-tab。
默认值
自动生成的 pvt-dock-tab-N
label
label:
string
定义于:interfaces/GraphUI.ts:1373
条带的标签逐字使用(因此可以翻译)。
onActivate()?
optionalonActivate: (tab) =>void
定义于:interfaces/GraphUI.ts:1412
当此选项卡到达前面以及离开时调用。监视实时数据的选项卡应在 onDeactivate 中停止工作并在 onActivate 中赶上:没有其他信息告诉它它已在屏幕外。
参数
tab
返回值
void
onDeactivate()?
optionalonDeactivate: (tab) =>void
定义于:interfaces/GraphUI.ts:1413
参数
tab
返回值
void
order?
optionalorder:number
定义于:interfaces/GraphUI.ts:1406
条带中的显示顺序为升序。相同的顺序保持注册顺序——并且由于插件是在 UI 构建之后安装的,因此插件的选项卡会在内置选项卡之后出现,而不必这么说。
默认值
0render()
render: (
tab) =>HTMLElement
定义于:interfaces/GraphUI.ts:1388
构建窗格的主体。懒洋洋地调用 once,选项卡第一次出现在前面——没有人打开的选项卡不需要任何费用。该元素在以后的激活中被保留并重新附加,因此它保持自己的状态(包括滚动位置)。
参数
tab
返回值
HTMLElement
toolbar()?
optionaltoolbar: (tab) =>HTMLElement|HTMLElement[]
定义于:interfaces/GraphUI.ts:1399
构建此选项卡的标题控件,将其布局为扩展坞标题行的一部分。在每个激活时重新调用,因此控件可以反映选项卡的当前状态。
具有多个视图的窗格在此处绘制开关。两个公共类赋予它与内置表格相同的外观 - pvt-dock-views 在条上,pvt-dock-view 在每个按钮上,active 在当前按钮上 - 因此它在扩展坞自己的选项卡旁边保留了一个药丸组并遵循主题。
参数
tab
返回值
HTMLElement | HTMLElement[]