ピボット / ModeStore
インターフェース: ModeStore
モードレール状態を保持する小さなオブザーバブル。レール、コンテキスト ツール パネル そして設定ポップアップはそれをサブスクライブします。クリック/キーバインドがそれにディスパッチされます。 セッターは冪等であり、値が実際に変更された場合にのみ通知します。 すべての通知には新しいスナップショットが含まれるため、リスナーがスナップショットを変更することはできません。 ストアの内部状態。
4 つの組み込みモードは常に存在します。 addRailMode で登録されたモード registerMode が追加され、組み込みとまったく同じように状態を保持します。
subscribe は * 変更のみ* で起動します。から初期状態をレンダリングします まずgetState、次に更新情報を購読してください。
メソッド
armTool()
armTool(
mode,tool):void
ポインター モードでツールを準備します (レール スロットがそれを反映します)。冪等。
パラメータ
mode
string
tool
string | null
返品
void
dispose()
dispose():
void
すべてのサブスクライバを削除します (UI ティアダウンで呼び出されます)。
返品
void
getArmedTool()
getArmedTool(
mode):string|null
ポインターモード用の武装ツール ('pointer'/null = デフォルト)。
パラメータ
mode
string
返品
string | null
getDefaultTool()
getDefaultTool(
mode):string|null
何も特別な準備がされていないときにモードが依存するツール。
パラメータ
mode
string
返品
string | null
getMode()
getMode():
string
返品
string
getState()
getState():
Readonly<ModeState>
現在の状態のコピー (安全に読み取れます。突然変異は漏れません)。
返品
Readonly<ModeState>
hasMode()
hasMode(
mode):boolean
モードが現在登録されているかどうか (4 つの組み込みは常に登録されています)。
パラメータ
mode
string
返品
boolean
isFlyoutActive()
isFlyoutActive(
mode):boolean
フライアウトが開いているかどうか (つまり、そのモードがアクティブであるかどうか)。
パラメータ
mode
string
返品
boolean
isPanelOpen()
isPanelOpen(
mode):boolean
ポインタモードのツールパネルが現在展開されているかどうか。
パラメータ
mode
string
返品
boolean
isPointerMode()
isPointerMode(
mode):boolean
モードがツール パネルを所有するかどうか。不明なモードはポインタモードではありません。
パラメータ
mode
string
返品
boolean
isViewActive()
isViewActive():
boolean
返品
boolean
Deprecated
isFlyoutActive('view') を使用します — レールには複数のフライアウトがあります。
registerMode()
registerMode(
mode,kind,defaultTool,panelOpen):void
モードの状態をストアに追加します。レールモードレジストリによって呼び出されます。四人 組み込みはすでに存在します。 IDを再登録すると記録は上書きされますが、IDは保持されます。 すでに持っているツール/パネルの状態。
パラメータ
mode
string
kind
defaultTool
string | null
panelOpen
boolean = true
返品
void
setMode()
setMode(
mode):void
パラメータ
mode
string
返品
void
setPanelOpen()
setPanelOpen(
mode,open):void
ポインタモードのツールパネルを展開/折りたたみます。冪等。
パラメータ
mode
string
open
boolean
返品
void
subscribe()
subscribe(
listener): () =>void
状態の変更をサブスクライブします。 unsubscribe fn (UIComponent.track に渡す) を返します。
パラメータ
listener
ModeListener
返品
():
void
返品
void
toggleFlyout()
toggleFlyout(
mode):void
フライアウト モードを開くか、閉じて最後のポインター モードに戻ります。
パラメータ
mode
string
返品
void
toggleToolPanel()
toggleToolPanel(
mode):void
ポインタモードのツールパネルの開閉を切り替えます。
パラメータ
mode
string
返品
void
toggleView()
toggleView():
void
返品
void
Deprecated
toggleFlyout('view') を使用します — レールには複数のフライアウトがあります。
unregisterMode()
unregisterMode(
mode):void
モードの状態を削除します。呼び出し元、つまりストアから最初に移動する責任があります。 代わりに何をアクティブにするかは決定しません。
パラメータ
mode
string
返品
void