拓展 / PluginContext
接口: PluginContext
传递给插件的 PivotickPlugin.install 的功能。此处注册的任何内容均由与内置 UI 相同的生命周期驱动,并随之拆除。
方法
addDockTab()
addDockTab(
tab): () =>void
在底部停靠区注册一个窗格 - 与 UIManager.addDockTab 是同一扇门,也是内置表格通过的那扇门。返回一个处理器。
第一个选项卡构建区域,因此插件不必要求使用者打开扩展坞:full模式是唯一的要求。
参数
tab
返回值
():
void
返回值
void
addElement()
addElement(
element,slot?):void
将 UI 元素添加到生命周期中。当给定 slot 时,元素立即安装到其中;然后它参与每个后续阶段(afterMount/graphReady/销毁)。在图表已经上线后可以安全地调用 - 元素已赶上当前阶段。
参数
element
slot?
HTMLElement
返回值
void
addKeybinding()
addKeybinding(
binding):void
注册一个键绑定,当 UI 被拆除时,该键绑定会自动删除。
参数
binding
返回值
void
addPanel()
addPanel(
panel): () =>void
注册一个侧边栏面板 - 与 UI.extraPanels 和 UIManager.addPanel 相同的门。返回一个处理器;该面板会在每次选择更改时重新渲染,并随 UI 一起拆除。
参数
panel
返回值
():
void
返回值
void
addPivot()
addPivot(
definition): () =>void
注册一个拓展——与 graph.pivots.register 和 pivots 选项相同的门,以及插件提供丰富功能的方式。返回一个处理器。
一旦第一个拓展注册,拓展轨道模式就会出现,并在最后一个拓展离开时消失,因此插件不必要求消费者打开任何东西。
参数
definition
返回值
():
void
返回值
void
addRailMode()
addRailMode(
mode): () =>void
在模式轨上注册一个模式 - 与 UIManager.addRailMode 相同的门,以及插件发布自己的探索或丰富模式的方式。返回一个处理器。
注册模式在四种内置模式之后呈现在分隔线下方。每种模式都注册成功;该按钮仅在有导轨的地方绘制(full 和 light)。
参数
mode
返回值
():
void
返回值
void
addTopBarAction()
addTopBarAction(
action): () =>void
在顶部栏添加一个药丸 - 与 UIManager.addTopBarAction 和 UI.topBar.actions 相同的门。返回一个处理器。 ui.refreshTopBar() 重新读取其字段。
参数
action
返回值
():
void
返回值
void
onPhase()
onPhase(
phase,callback): () =>void
挂钩生命周期阶段。返回取消订阅函数。
参数
phase
callback
() => void
返回值
():
void
返回值
void
refreshDockTab()
refreshDockTab(
id):void
从其 render 和 toolbar 重建停靠选项卡 — 当窗格自己的数据或所选视图发生更改时。对于保存 id 而不是句柄的代码,与 DockTabHandle 的 refresh() 执行相同的操作。
参数
id
string
返回值
void
refreshPanel()
refreshPanel(
id?):void
重新渲染一个侧边栏面板,或者当省略 id 时重新渲染所有侧边栏面板。
参数
id?
string
返回值
void
removeDockTab()
removeDockTab(
id):void
通过 id 删除一个停靠选项卡(相当于调用其处理程序)。
参数
id
string
返回值
void
removePanel()
removePanel(
id):void
通过id移除一个侧边栏面板(相当于调用它的disposer)。
参数
id
string
返回值
void
removeRailMode()
removeRailMode(
id):void
通过id移除一个rail mode(相当于调用它的disposer)。
参数
id
string
返回值
void
removeTopBarAction()
removeTopBarAction(
id):void
通过 id 删除顶栏操作(相当于调用其处理程序)。
参数
id
string
返回值
void
setDockTabLabel()
setDockTabLabel(
id,label):void
重命名条中的停靠选项卡,保留其主体和滚动位置 - 实时计数,无需重新注册选项卡。
参数
id
string
label
string
返回值
void
属性
graph
graph:
Pivotick
i18n
i18n:
I18n
图表的语言:它的区域设置、数字、列表和排序格式,以及图书馆自己的消息上的t。插件自己编写的文本是插件要翻译的文本,键入 i18n.locale。
keyManager
keyManager:
KeybindingManager
layout
layout:
Layout|undefined
根 DOM 支架,从 UI 实时读取(绝不是过时的快照)。当 UI 处于活动状态时,它存在于每个模式中,并且仅在 UI 销毁后才为 undefined。它的插槽因模式而异:总是canvas和notification; graphnavigation 除 static 以外的所有模式; mainheader / modal / slidePanel / moderail / toolpanel / flyout / legend full 和 light;仅限full中的sidebar。
canvas 是画布停靠元素想要的插槽 - 请参阅小地图插件。
ui
ui:
UIManager