ピボット / 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と同じドア、そして プラグインが独自の Explore または Enrich モードを提供する方法。ディスポーザーを返します。
登録されたモードは、4 つの組み込みモードの後に、ディバイダの下にレンダリングされます。登録 すべてのモードで成功します。ボタンはレールがある場所にのみ描画されます (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 からドック タブを再構築します — ペイン自体のデータが必要な場合に備えて または選択したビューが変更されました。 DockTabHandle の refresh() が行うのと同じことです。 ハンドルではなく ID を保持するコード。
パラメータ
id
string
返品
void
refreshPanel()
refreshPanel(
id?):void
1 つのサイドバー パネル、または id が省略されている場合はすべてのサイドバー パネルを再レンダリングします。
パラメータ
id?
string
返品
void
removeDockTab()
removeDockTab(
id):void
ID を使用してドック タブを削除します (ディスポーザーを呼び出すのと同等)。
パラメータ
id
string
返品
void
removePanel()
removePanel(
id):void
ID によってサイドバー パネルを削除します (ディスポーザーを呼び出すのと同じです)。
パラメータ
id
string
返品
void
removeRailMode()
removeRailMode(
id):void
ID によってレール モードを削除します (ディスポーザを呼び出すのと同等)。
パラメータ
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 が生きている間はすべてのモードに存在し、その後のみ undefined になります。 UIが破壊されます。その スロット はモードによって異なります: canvas および notification いつも; static を除くすべてのモードで graphnavigation; mainheader / modal / slidePanel / moderail / toolpanel / flyout / fullとlightのlegend。 fullのsidebarのみ。
canvas は、キャンバスにドッキングされた要素が必要とするスロットです。ミニマップ プラグインを参照してください。
ui
ui:
UIManager