コンテンツへスキップ

pivotick v3.0.0


ピボット / Pivotick

クラス: Pivotick ​

定義: Graph.ts:26

コンストラクター ​

コンストラクター ​

new Pivotick(container, data?, options?): Graph

定義: Graph.ts:87

指定されたデータとオプションを使用して、指定されたコンテナー内のグラフを初期化します。

パラメータ ​

container ​

HTMLElement

グラフのメインコンテナとして機能する HTMLElement。

data? ​

RelaxedGraphData

レンダリングするノードとエッジを含むグラフ データ。

options? ​

Partial<GraphOptions>

グラフの動作、UI、スタイル、シミュレーションなどのオプションの構成。

返品 ​

Graph

メソッド ​

addEdge() ​

addEdge(e): Edge

定義: Graph.ts:1000

グラフにエッジを追加します。

ソース (from) ノードとターゲット (to) ノードの両方がグラフ内にすでに存在している必要があります。 同じ ID を持つエッジがすでに存在する場合、エラーがスローされます。

パラメータ ​

e ​

追加するエッジ。

Edge | RawEdge

返品 ​

Edge

投げる ​

エッジ ID がすでに存在する場合、またはいずれかのノードが存在しない場合はエラー。 エッジが正常に追加された後に onChange をトリガーします。


addNode() ​

addNode(n): Node

定義: Graph.ts:902

グラフにノードを追加します。

パラメータ ​

n ​

Node | RawNode

返品 ​

Node

投げる ​

同じ id を持つノードがすでに存在する場合はエラー。 ノードが正常に追加された後、onChange がトリガーされます。


addNote() ​

addNote(n): Note | undefined

定義: Graph.ts:1265

グラフにメモを追加して描画します。 data.notes と同じオプションを取ります (注。toJSON が返すもの)、または Note。 noteAddを発します。

パラメータ ​

n ​

Note | NoteOptions

返品 ​

Note | undefined

音符、または UI.notes.enabled が false のときの undefined。

投げる ​

同じ id を持つノートがすでに存在する場合、エラーになります。


addToSelection() ​

addToSelection(nodes): void

定義: Graph.ts:1637

すでに選択されているものはそのままにして、現在の選択にノードを追加します。 すでに選択されているノードは無視されます。

ノードのみ: インタラクションレイヤーにはエッジ用の追加セッターがありません。 selectElements を介してセット全体として選択できます。

パラメータ ​

nodes ​

Node[]

追加する Node 。

返品 ​

void


clearEmphasis() ​

clearEmphasis(): void

定義: Graph.ts:1726

強調を終了 emphasiseElements 開始: キャンバスは再び通常どおりに読み込まれます。

返品 ​

void


clearForecast() ​

clearForecast(): void

定義: Graph.ts:1745

予想を下げてください。

返品 ​

void


clearHighlightedElements() ​

clearHighlightedElements(): void

定義: Graph.ts:1707

ノードまたはエッジからハイライト クラスを削除します。

返品 ​

void


closeTable() ​

closeTable(): void

定義: Graph.ts:1669

データドックを閉じます。

返品 ​

void


deselectAll() ​

deselectAll(): void

定義: Graph.ts:1681

すべての選択を解除します

返品 ​

void


destroy() ​

destroy(): void

定義: Graph.ts:1444

すべての UI コンポーネントを破棄します。

返品 ​

void


edgeVisibilityChanged() ​

edgeVisibilityChanged(): void

定義: Graph.ts:1388

エッジレイヤーの変更後に再ペイントします。意図的にではありません onChange: レイヤー リンク強制に触れないでください (Simulation.getActiveEdges を参照)。 シミュレーションによって理由もなくグラフが移動してしまう可能性があります。

返品 ​

void


emphasiseElements() ​

emphasiseElements(elements): void

定義: Graph.ts:1721

グラフから要素の set を選択します。それらはすでに持っている外観を維持します。 その間、キャンバス上の他のすべてがclearEmphasisまで薄暗くなります。これは 凡例エントリにホバーすると、そのカテゴリがキャンバスからどのように読み取られるか。

highlightElement が 1 つの要素を指す場合、これはグループを表します。 現在描画されていない要素はスキップされ、空のセットでは何も暗くなりません。

パラメータ ​

elements ​

(Node | Edge)[]

Node と Edge を強調します。

返品 ​

void


focusElement() ​

focusElement(element): void

定義: Graph.ts:1583

グラフ ビュー内で指定されたノードまたはエッジにフォーカスを当てます。に隠されたノード 閉じたクラスターまたはグループは、そのクラスターまたはグループに焦点を当てます。

パラメータ ​

element ​

Node または Edge に焦点を当てます。

Node | Edge | Note

返品 ​

void


getAppID() ​

getAppID(): string

定義: Graph.ts:1456

アプリのID

返品 ​

string


getConnectedNodes() ​

getConnectedNodes(node): Node[]

定義: Graph.ts:1241

指定されたノードから直接接続されているすべてのノードを取得します。

外部からの変更を防ぐために、複製されたノードを返します。

パラメータ ​

node ​

接続を検索するノードまたはノード ID。

string | Node

返品 ​

Node[]

指定されたノードから直接接続された Node オブジェクトの配列。


getEdge() ​

getEdge(id): Edge | undefined

定義: Graph.ts:1036

ID によってグラフからエッジを取得します。

外部からの突然変異を防ぐために、エッジのディープ クローンを返します。

パラメータ ​

id ​

string

エッジのID。

返品 ​

Edge | undefined

見つかった場合はクローン Edge、見つからなかった場合は undefined。


getEdgeCount() ​

getEdgeCount(): number

定義: Graph.ts:1086

現在グラフ内のエッジの数を返します。

返品 ​

number

合計エッジ数。


getEdges() ​

getEdges(): Edge[]

定義: Graph.ts:1168

グラフ内のすべてのエッジを取得します。

外部からの変更を防ぐために、エッジのクローンを返します。

返品 ​

Edge[]

クローン化された Edge オブジェクトの配列。


getEdgesFromNode() ​

getEdgesFromNode(node): Edge[]

定義: Graph.ts:1211

指定されたノードから発生するすべてのエッジを検索します。

外部からの変更を防ぐために、複製されたエッジを返します。

パラメータ ​

node ​

発信エッジを検索するノードまたはノード ID。

string | Node

返品 ​

Edge[]

from ノードがクエリに一致する Edge オブジェクトの配列。


getEdgesToNode() ​

getEdgesToNode(node): Edge[]

定義: Graph.ts:1226

指定されたノードを指すすべてのエッジを検索します。

外部からの変更を防ぐために、複製されたエッジを返します。

パラメータ ​

node ​

受信エッジを検索するノードまたはノード ID。

string | Node

返品 ​

Edge[]

to ノードがクエリに一致する Edge オブジェクトの配列。


getGraphDepth() ​

getGraphDepth(): number

定義: Graph.ts:1566

返品 ​

number


getMutableEdge() ​

getMutableEdge(id): Edge | undefined

定義: Graph.ts:1052

ID によってグラフからエッジを取得します。

実際のエッジ インスタンスを返し、直接変更できるようにします。

警告: この方法を使用してエッジを直接変更すると、予期しない動作が発生する可能性があります。 通常は、クローンインスタンスを返す getEdge を使用する方が安全です。

パラメータ ​

id ​

string

エッジのID。

返品 ​

Edge | undefined

見つかった場合は Edge、見つからなかった場合は undefined。


getMutableEdges() ​

getMutableEdges(): Edge[]

定義: Graph.ts:1184

グラフ内のすべてのエッジを取得します。

実際のエッジ インスタンスを返し、直接変更できるようにします。

返品 ​

Edge[]

Edge オブジェクトの配列。

備考 ​

⚠️ 警告: エッジを直接変更すると、予期しない動作が発生する可能性があります。 安全なクローンを操作するには、代わりに getEdges を使用してください。


getMutableNode() ​

getMutableNode(id): Node | undefined

定義: Graph.ts:943

ID によってグラフからノードを取得します。

実際のノード インスタンスを返し、直接変更できるようにします。

警告: この方法を使用してノードを直接変更すると、予期しない動作が発生する可能性があります。 通常は、クローンインスタンスを返す getNode を使用する方が安全です。

パラメータ ​

id ​

ノードまたは Node オブジェクトの ID。

string | Node

返品 ​

Node | undefined

見つかった場合は Node、見つからなかった場合は undefined。


getMutableNodes() ​

getMutableNodes(): Node[]

定義: Graph.ts:1114

グラフ内のすべてのノードを取得します。

実際のノード インスタンスを返し、直接変更できるようにします。

返品 ​

Node[]

Node オブジェクトの配列。

備考 ​

⚠️ 警告: ノードを直接変更すると、予期しない動作が発生する可能性があります。 通常は、クローンインスタンスを返す getNodes を使用する方が安全です。


getMutableVisibleEdges() ​

getMutableVisibleEdges(): Edge[]

定義: Graph.ts:1199

グラフ内のすべての表示エッジを取得します。

実際のエッジ インスタンスを返し、直接変更できるようにします。

返品 ​

Edge[]

Edge オブジェクトの配列。

備考 ​

⚠️ 警告: エッジを直接変更すると、予期しない動作が発生する可能性があります。 安全なクローンを操作するには、代わりに getEdges を使用してください。


getMutableVisibleNodes() ​

getMutableVisibleNodes(): Node[]

定義: Graph.ts:1130

グラフ内に表示されているすべてのノードを取得します。可視の子を再帰的に追加する

実際のノード インスタンスを返し、直接変更できるようにします。

返品 ​

Node[]

Node オブジェクトの配列。

備考 ​

⚠️ 警告: ノードを直接変更すると、予期しない動作が発生する可能性があります。 通常は、クローンインスタンスを返す getNodes を使用する方が安全です。


getNode() ​

getNode(id): Node | undefined

定義: Graph.ts:927

ID によってグラフからノードを取得します。

外部の突然変異を防ぐために、ノードのディープ クローンを返します。

パラメータ ​

id ​

ノードまたは Node オブジェクトの ID。

string | Node

返品 ​

Node | undefined

見つかった場合はクローン Node、見つからなかった場合は undefined。


getNodeCount() ​

getNodeCount(): number

定義: Graph.ts:1077

現在グラフ内にあるノードの数を返します。

返品 ​

number

合計ノード数。


getNodes() ​

getNodes(): Node[]

定義: Graph.ts:1097

グラフ内のすべてのノードを取得します。

外部からの変更を防ぐために、ノードのクローンを返します。

返品 ​

Node[]

クローン化された Node オブジェクトの配列。


getNote() ​

getNote(id): Note | undefined

定義: Graph.ts:1254

パラメータ ​

id ​

string

返品 ​

Note | undefined


getNotes() ​

getNotes(): Note[]

定義: Graph.ts:1250

返品 ​

Note[]


getOptions() ​

getOptions(): GraphOptions

定義: Graph.ts:693

グラフの現在の構成オプションを返します。

返品 ​

GraphOptions


hideNode() ​

hideNode(node): void

定義: Graph.ts:1393

パラメータ ​

node ​

Node

返品 ​

void


highlightElement() ​

highlightElement(element): void

定義: Graph.ts:1690

指定されたノードまたはエッジにハイライト クラスを追加します。

パラメータ ​

element ​

Node または Edge を強調表示します。

Node | Edge

返品 ​

void


nextTick() ​

nextTick(): void

定義: Graph.ts:1430

グラフの次のレンダリング更新をトリガーします。

返品 ​

void


nextTickFor() ​

nextTickFor(nodes): void

定義: Graph.ts:1437

渡されたサブジェクトのグラフの次のレンダリング更新をトリガーします。

パラメータ ​

nodes ​

Node[]

返品 ​

void


noteAdd() ​

noteAdd(note): void

定義: Graph.ts:422

パラメータ ​

note ​

Note

返品 ​

void


noteChange() ​

noteChange(note): void

定義: Graph.ts:425

パラメータ ​

note ​

Note

返品 ​

void


noteRemove() ​

noteRemove(note): void

定義: Graph.ts:428

パラメータ ​

note ​

Note

返品 ​

void


off() ​

off<K>(event, handler): void

定義: Graph.ts:258

型パラメータ ​

K ​

K ** GraphEvents のキーを拡張します

パラメータ ​

event ​

K

handler ​

GraphEvents[K]

返品 ​

void


on() ​

on<K>(event, handler): void

定義: Graph.ts:251

型パラメータ ​

K ​

K ** GraphEvents のキーを拡張します

パラメータ ​

event ​

K

handler ​

GraphEvents[K]

返品 ​

void


openTable() ​

openTable(): void

定義: Graph.ts:1662

データ ドックを開きます。グラフの行が並べ替え可能で選択可能なグリッドとして分割されます。 キャンバスの底部。 full モードのみ、および UI.table が許可する場合のみ。 それ以外の場合は何もしません。

ドックはテーブル以外のペインを保持できるようになったので、テーブルのペインも保持できるようになりました。 ペインを前面に表示します。呼び出しにはテーブルの名前が付けられており、テーブルが表示されます。リーチ UIManager.dock または activateDockTab() を使用して、それなしでリージョンを駆動します。

返品 ​

void


removeBySource() ​

removeBySource(source): object

定義: Graph.ts:592

情報源が保証しているものはすべて削除してください。いくつかの情報源が保証している要素 生き残り、一方がより軽いと主張します。同じ統一ルールのピボットアンドゥが続き、 ピボットがもたらしたものはすべて削除される唯一の方法です。

これは順方向の操作であり、history の 1 つのエントリ: 元に戻すと元に戻ります 残ったものを削除し、情報源の主張を残ったものに戻します。

パラメータ ​

source ​

string

ピボット ID、またはピボットされていないデータの場合は 'seed'。

返品 ​

object

実際に削除されたもの。

edges ​

edges: Edge[]

nodes ​

nodes: Node[]


removeEdge() ​

removeEdge(id): void

定義: Graph.ts:1062

ID に基づいてグラフからエッジを削除します。

パラメータ ​

id ​

string

削除するエッジの ID。 エッジが削除された後、onChange がトリガーされます。

返品 ​

void


removeFromSelection() ​

removeFromSelection(nodes): void

定義: Graph.ts:1648

現在の選択範囲からノードを削除し、残りの部分はそのまま残します。 ノードのみ、addToSelectionと同じ条件。

パラメータ ​

nodes ​

Node[]

削除する Node 。

返品 ​

void


removeNode() ​

removeNode(id): void

定義: Graph.ts:969

ID に基づいてグラフからノードを削除します。

ノードに接続されているエッジも削除します。

パラメータ ​

id ​

string

削除するノードの ID。 ノードとそのエッジが削除された後に onChange をトリガーします。

返品 ​

void


selectElement() ​

selectElement(element): void

定義: Graph.ts:1593

グラフ内の特定のノードまたはエッジを選択します。閉じたクラスターまたはグループ内に隠されたノード がまだ選択されています。キャンバスは、描画されたクラスターまたはグループを照らします。

パラメータ ​

element ​

Node または Edge を選択します。

Node | Edge

返品 ​

void


selectElements() ​

selectElements(elements): void

定義: Graph.ts:1610

複数のノードまたは複数のエッジを選択し、現在の選択を置き換えます。 複数形 selectElement、各要素のレンダリングされたハンドルを解決します。

ノードとエッジを一緒に選択することはできません (インタラクション レイヤーは 1 種類をクリアします) もう一方が設定されている場合)、混合配列は nodes を選択し、警告します。

パラメータ ​

elements ​

(Node | Edge)[]

Node または Edge を選択します。空の配列は選択をクリアします。

返品 ​

void


setData() ​

setData(nodes, edges, notes): void

定義: Graph.ts:852

グラフ内のすべての現在のノードとエッジを、提供されたデータで置き換えます。 新しいノードとエッジを設定する前に、既存のノードとエッジをクリアします。 更新後に onChange コールバックをトリガーします。

パラメータ ​

nodes ​

Node[] = []

設定するノードの配列。デフォルトは空の配列です。

edges ​

Edge[] = []

設定するエッジの配列。デフォルトは空の配列です。

notes ​

Note[] = []

返品 ​

void


setLegend() ​

setLegend(config?): void

定義: Graph.ts:450

実行時にキャンバスの凡例を置き換えます (UI.legend の命令型ツイン)。 グラフなしで開始されたグラフは、その場で構築されます。 false が空になります 凡例を削除してそのフィルターを削除し、true / undefined は元に戻ります render.nodeTypeAccessor から 1 つを導き出します。渡す LegendGroupOptions を使用して、一度に複数の次元でグラフにキーを設定します。

パラメータ ​

config? ​

表示する凡例、または削除する場合は false。

boolean | LegendOptions | LegendGroupOptions

返品 ​

void


setNotes() ​

setNotes(notes): Note[]

定義: Graph.ts:1282

ノードとエッジをそのままにして、グラフのメモを置き換えます。ノートは次のように照合されます id: すでにキャンバス上にあるものはその場で更新されるため、その描画はバインドされたままになります notes にないものが削除され、新しいものが追加されます。

パラメータ ​

notes ​

(Note | NoteOptions)[]

返品 ​

Note[]

グラフ上にメモが指定された順序で表示されます。

投げる ​

2 つのエントリが ID を共有する場合はエラー。それでは何も変わりません。


setVisibleNodes() ​

setVisibleNodes(nodes, notify): boolean

定義: Graph.ts:1356

何かが移動したかどうかを返すため、エッジのみのフィルター変更はそれ自体を再描画できます。 notify は、クエリ エンジンの最初のパスではオフです。これは、何かが実行される前に実行されます。 描画 — コンストラクター自身の simulation.update() / renderer.init() がそれに続きます。

パラメータ ​

nodes ​

Node[]

notify ​

boolean = true

返品 ​

boolean


showForecast() ​

showForecast(forecast): void

定義: Graph.ts:1740

アクション ** が行うことをペイントし、それ以外の要素は何も変更しません。 排水管が一緒に隠れてしまうものなど、その場にある排水管を取り除きます。 どこに着地するかを概説します。

ここで、emphasiseElements は、キャンバスからセットを後退させて読み取ります。 残りは、予測が「クリックすると何が起こるか」に答えるため、グラフを維持する必要があります。 変更されるいくつかの要素を通常通り読みます。 graph.history.preview(...) は既製のものを 1 つ返します。

パラメータ ​

forecast ​

GraphForecast

返品 ​

void


showNode() ​

showNode(node): void

定義: Graph.ts:1404

パラメータ ​

node ​

Node

返品 ​

void


toggleExpandNode() ​

toggleExpandNode(node): void

定義: Graph.ts:1415

パラメータ ​

node ​

Node

返品 ​

void


toggleExpandNodes() ​

toggleExpandNodes(nodes): void

定義: Graph.ts:1420

パラメータ ​

nodes ​

Node[]

返品 ​

void


toggleTable() ​

toggleTable(): void

定義: Graph.ts:1674

データ ドックが閉じている場合は開き、開いている場合は閉じます。

返品 ​

void


unHighlightElement() ​

unHighlightElement(element): void

定義: Graph.ts:1699

指定されたノードまたはエッジのハイライト クラスを削除します

パラメータ ​

element ​

Node または Edge を選択します。

Node | Edge

返品 ​

void


updateData() ​

updateData(newNodes?, newEdges?, triggerChangeEvent?): void

定義: Graph.ts:764

新しいノードやエッジでグラフを更新します。

グラフがすでに保持している ID が その場で更新: 要素 * が* — そのデータ、スタイル、重量はあなたが渡したものになりますが、オブジェクトは それ自体がアイデンティティを維持します。そのように機能する必要があります。そのエッジ、シミュレーション そして DOM バインディングはすべてそのオブジェクトを保持し、学習したすべてのことも同様に保持します。 それが建てられてから: どの情報源がそれを保証しているか、それがどこにあるか、それが存在するかどうか 固定された。入力要素の位置が引き続き優先されるため、updateData は移動できます 何かをリフレッシュするだけでなく。不明な ID が追加されます。

コンテナの children はここでは再構築されません。コンテナを通過させます。 removeNode および addNode を使用して、保持する内容を変更します。

呼び出し全体は 1 つのバッチです。すべての追加と変更を 1 つの dataBatchChanged リストします。 指定された順序で、要素の数に関係なく 1 回再レンダリングされます。

パラメータ ​

newNodes? ​

Node[]

更新または追加するノードのオプションの配列。

newEdges? ​

Edge[]

更新または追加するオプションのエッジの配列。

triggerChangeEvent? ​

boolean = true

インプレースの変更を発表します。追加はいずれかの方法で発表されます。

返品 ​

void


use() ​

use(plugin): this

定義: Graph.ts:246

PivotickPlugin をインストールします。いつでも呼び出すことができます - プラグインの UI 要素は現在のライフサイクル フェーズに追いつきます。返品 this チェーン接続用。

パラメータ ​

plugin ​

PivotickPlugin

返品 ​

this

プロパティ ​

editing ​

readonly editing: GraphEditingManager

定義: Graph.ts:45


history ​

readonly history: GraphHistory

定義: Graph.ts:57

キャンバスが何を保持し、表示するのか、そしてそれがどのようにして行われたのか: すべての取り込み、削除、 耐久性のある皮と手描きのエレメント、連続リバーシブル。有界と セッションスコープ — リロード後は存続しません。


i18n ​

readonly i18n: I18n

定義: Graph.ts:68

このグラフが独自のテキストを書き込む言語 (GraphOptions.i18n から): message 検索、複数形、数値、リスト、並べ替えの形式。ネストされたグラフは、 親の。


noteManager ​

noteManager: NoteManager

定義: Graph.ts:31


notifier ​

notifier: Notifier

定義: Graph.ts:32


pivots ​

readonly pivots: PivotManager

定義: Graph.ts:51

ピボット ランタイム: エンリッチメントを登録し、実行し、返される内容を優先順位付けします。 実行全体を元に戻します。ピボットするため、UI ではなく Graph 上に存在します data を生成します。これは、UI が構築される前に存在する必要があるためです。


queryEngine ​

queryEngine: GraphQueryEngine

定義: Graph.ts:35


renderer ​

renderer: GraphRenderer

定義: Graph.ts:33


simplify ​

readonly simplify: Simplification

定義: Graph.ts:62

同じ役割を果たすノードを、その場所に描画される 1 つのグループに折り畳みます。グループ ビューステート: getNodes()、getEdges()、テーブルと履歴はメンバーを参照します。


simulation ​

simulation: Simulation

定義: Graph.ts:34