コンテンツへスキップ

pivotick v3.0.0


pivotick / ノード

クラス: Node ​

定義: Node.ts:42

グラフ内の単一のノード (頂点) を表します。

アクセサ ​

isGroup ​

署名を取得する ​

get isGroup(): boolean

定義: Node.ts:441

graph.simplify によって描かれたグループに当てはまります: メンバーの代役であり、決して離れることはありません データの。

返品 ​

boolean

コンストラクター ​

コンストラクター ​

new Node(id, data?, style?, domID?, children?): Node

定義: Node.ts:108

新しいノード インスタンスを作成します。

パラメータ ​

id ​

string

ノードの一意の識別子

data? ​

NodeData

ノードに関連付けられたオプションのデータ ペイロード

style? ​

Partial<NodeStyle>

domID? ​

string = ...

children? ​

Node[] = []

返品 ​

Node

メソッド ​

ancestorChain() ​

ancestorChain(): Node[]

定義: Node.ts:400

ノードのクラスター、一番外側から順 — ルート グラフのノードの場合は空です。

返品 ​

Node[]


canvasRepresentative() ​

canvasRepresentative(): Node

定義: Node.ts:419

キャンバスがこのノードに対して実際に描画するノード: その上にあるすべてのクラスターがそれ自体を描画する 展開されます。そうでない場合は、最も外側の折りたたまれたクラスター (それを隠しているボックス) が展開されます。 いずれの場合も、ドットが折り畳まれる閉じたグループ (存在する場合)。

これは、「表示されているかどうか」ではなく、「画面上のどのドットがこのノードを表しているか」という答えになります。 展開されたクラスターは、toDict() データから構築された別の サブグラフをレンダリングします。 ネストされたノードは、クラスターが開いている場合でも、このグラフによって描画されることはありません。

返品 ​

Node


clone() ​

clone(): Node

定義: Node.ts:284

返品 ​

Node


collapse() ​

collapse(): void

定義: Node.ts:388

返品 ​

void


degree() ​

degree(): number

定義: Node.ts:395

返品 ​

number


descendants() ​

descendants(): Node[]

定義: Node.ts:709

このノードの下にあるすべてのノードは深さが優先されます。

返品 ​

Node[]


expand() ​

expand(): void

定義: Node.ts:381

返品 ​

void


freeze() ​

freeze(): void

定義: Node.ts:335

返品 ​

void


getBorderBox() ​

getBorderBox(outset): NodeBorderBox | undefined

定義: Node.ts:513

ノードの長方形の境界線は outset または undefined だけ拡大されます。 ノードは円として固定されます。

パラメータ ​

outset ​

number = 0

返品 ​

NodeBorderBox | undefined


getBorderDistance() ​

getBorderDistance(dirX, dirY, outset): number

定義: Node.ts:525

ユニット方向に沿ったノードの中心から境界までの距離 (dirX, dirY)、outset によって成長 — エッジがその方向に離れる場合 始めるべきです。測定されたノードの場合は長方形、それ以外の場合は円の半径。 意図的にスタイル解決を行わない: これは、すべてのオブジェクトの両端で実行されます。 すべてのティックでエッジ。

パラメータ ​

dirX ​

number

dirY ​

number

outset ​

number = 0

返品 ​

number


getCircleRadius() ​

getCircleRadius(): number

定義: Node.ts:465

返品 ​

number


getCircleRadiusCollapsed() ​

getCircleRadiusCollapsed(): number

定義: Node.ts:473

返品 ​

number


getConnectedNodes() ​

getConnectedNodes(): Node[]

定義: Node.ts:184

返品 ​

Node[]


getConnectingNodes() ​

getConnectingNodes(): Node[]

定義: Node.ts:190

返品 ​

Node[]


getData() ​

getData(): NodeData

定義: Node.ts:129

ノードのデータを取得します。

返品 ​

NodeData


getEdgesIn() ​

getEdgesIn(): Edge[]

定義: Node.ts:200

返品 ​

Edge[]


getEdgesOut() ​

getEdgesOut(): Edge[]

定義: Node.ts:196

返品 ​

Edge[]


getGraphElement() ​

getGraphElement(): SVGGElement | null

定義: Node.ts:230

返品 ​

SVGGElement | null


getLayoutRadius() ​

getLayoutRadius(): number

定義: Node.ts:496

レイアウトがこのノードを配置する半径: 宣言されたフットプリントがある場合、 それ以外の場合は、図面が測定したものは何でも。あらゆる勢力がこれを読んでいる。引き出しが読んでいる getCircleRadius、これは描画サイズです。

返品 ​

number


getLayoutSize() ​

getLayoutSize(): number | undefined

定義: Node.ts:487

宣言されたフットプリントの半幅、または図面がスペースを所有する場合は undefined。

返品 ​

number | undefined


getPotential() ​

getPotential(pivotId): number | undefined

定義: Node.ts:647

1 つのピボットに対して宣言されたポテンシャル、または引数なしで宣言された合計 特定のピボットはありません。 undefined 何もなかったとき。

パラメータ ​

pivotId ​

string = SUMMARY_POTENTIAL

返品 ​

number | undefined


getPotentials() ​

getPotentials(): Map<string, number>

定義: Node.ts:652

このノード上で宣言されたすべてのポテンシャル。ピボット ID によってキー設定されます。

返品 ​

Map<string, number>


getSources() ​

getSources(): string[]

定義: Node.ts:538

このノードを保証するソース — ピボット ID、およびデータの 'seed' 最初からここにありました。ノードは複数のピボットによって一度に保証されます。 graph.removeBySource は最後のものがなくなった場合にのみ削除します。

返品 ​

string[]


getStyle() ​

getStyle(): Partial<NodeStyle>

定義: Node.ts:207

ノードのデータを取得します。

返品 ​

Partial<NodeStyle>


hasChildren() ​

hasChildren(): boolean

定義: Node.ts:723

返品 ​

boolean


hasSource() ​

hasSource(source): boolean

定義: Node.ts:543

source がこのノードを保証するかどうか。 'seed' はピボットされていないデータに当てはまります。

パラメータ ​

source ​

string

返品 ​

boolean


hide() ​

hide(): void

定義: Node.ts:360

返品 ​

void


markAsChild() ​

markAsChild(parentNode, childrenDepth): void

定義: Node.ts:727

パラメータ ​

parentNode ​

Node

childrenDepth ​

number

返品 ​

void


markAsParent() ​

markAsParent(): void

定義: Node.ts:733

返品 ​

void


removeChildById() ​

removeChildById(id): Node | undefined

定義: Node.ts:698

1 つの子とその子自身のサブツリーをドロップします。削除された子を返します。 呼び出し元はその子孫の後でクリーンアップできます。

パラメータ ​

id ​

string

返品 ​

Node | undefined


setBorderBox() ​

setBorderBox(width, height): void

定義: Node.ts:505

ノードの境界線が中心のwidth×heightの長方形であることを宣言します 実際には としてレンダリングされるため、エッジは境界円ではなくその上で停止します。 after setCircleRadius と呼ぶとクリアされます。

パラメータ ​

width ​

number

height ​

number

返品 ​

void


setChildren() ​

setChildren(children): void

定義: Node.ts:656

パラメータ ​

children ​

Node[]

返品 ​

void


setCircleRadius() ​

setCircleRadius(radius): void

定義: Node.ts:460

ノードの円の半径を設定します。測定された長方形の境界線も削除します。 半径はより大まかな事実であるため、ノードのサイズを変更するすべての呼び出し元は、 アンカーリングはデフォルトで正しく、レンダリングされた内容を認識するのはドロワーのみです。 setBorderBox を通じて形状を再度オプトインします。

パラメータ ​

radius ​

number

返品 ​

void


setCircleRadiusCollapsed() ​

setCircleRadiusCollapsed(radius): void

定義: Node.ts:469

パラメータ ​

radius ​

number

返品 ​

void


setData() ​

setData(newData): void

定義: Node.ts:137

ノードのデータを更新します。

パラメータ ​

newData ​

NodeData

新たに設定するデータ

返品 ​

void


setLayoutSize() ​

setLayoutSize(halfWidth): void

定義: Node.ts:482

このノードがレイアウト内で確保するボックスをグラフ単位の半角で宣言します。 setCircleRadius とは異なり、これは一定です。描画は内部で変更できます。 何も動かずに。

パラメータ ​

halfWidth ​

number | undefined

返品 ​

void


setPotential() ​

コールシグネチャ ​

setPotential(count): void

定義: Node.ts:627

このノードにあとどれだけあるかを、何も要求せずに宣言します。 リムバッジが示すもの。 0 は宣言をクリアします。

ピボット ID の場合、それはそのピボットの番号であり、そのバッジがそのピボットを開きます。と カウントだけで言えば、すべての合計です。これは、 'summary' リムバッジの優先 — プロバイダーがさらにある場合に宣言するもの リムで名前を付けることはできません。

ここの他のセッターと同様にノードをダーティとしてマークします。そのため、バッジが 次のレンダリング — 他に何も実行しようとしていない場合は、graph.renderer.update() を呼び出します。

ts
node.setPotential('correlations', 2143) // this provider has this much
node.setPotential(2199)                 // everything has this much
パラメータ ​
count ​

number

返品 ​

void

コールシグネチャ ​

setPotential(pivotId, count): void

定義: Node.ts:628

このノードにあとどれだけあるかを、何も要求せずに宣言します。 リムバッジが示すもの。 0 は宣言をクリアします。

ピボット ID の場合、それはそのピボットの番号であり、そのバッジがそのピボットを開きます。と カウントだけで言えば、すべての合計です。これは、 'summary' リムバッジの優先 — プロバイダーがさらにある場合に宣言するもの リムで名前を付けることはできません。

ここの他のセッターと同様にノードをダーティとしてマークします。そのため、バッジが 次のレンダリング — 他に何も実行しようとしていない場合は、graph.renderer.update() を呼び出します。

ts
node.setPotential('correlations', 2143) // this provider has this much
node.setPotential(2199)                 // everything has this much
パラメータ ​
pivotId ​

string

count ​

number

返品 ​

void


setStyle() ​

setStyle(newStyle): void

定義: Node.ts:215

ノードのデータを更新します。

パラメータ ​

newStyle ​

Partial<NodeStyle>

新たに設定するデータ

返品 ​

void


show() ​

show(): void

定義: Node.ts:356

返品 ​

void


toDict() ​

toDict(dataOnly): Record<string, unknown>

定義: Node.ts:239

ノードを単純な JSON オブジェクト表現に変換します。

パラメータ ​

dataOnly ​

boolean = false

デフォルト: false

返品 ​

Record<string, unknown>


toggleExpand() ​

toggleExpand(expanded?): void

定義: Node.ts:364

パラメータ ​

expanded? ​

boolean

返品 ​

void


toggleVisibility() ​

toggleVisibility(visible): void

定義: Node.ts:347

パラメータ ​

visible ​

boolean

返品 ​

void


toSimulationDTO() ​

toSimulationDTO(): SimulationNodeDTO

定義: Node.ts:267

シミュレーション ワーカーの構造化された複製可能なペイロード (ライブの親/子/_サブグラフなし) clone() とは異なり、参照)。スタイルからは機能が取り除かれています。解決可能なチャネルはすべて、 持っていても、力で読み取られることはないので、送信しても DataCloneError のリスクしかありません。

返品 ​

SimulationNodeDTO


unfreeze() ​

unfreeze(): void

定義: Node.ts:341

返品 ​

void


unionChildren() ​

unionChildren(children): Node[]

定義: Node.ts:674

children を ID でマージ: 新しいものが追加され、一致するものが残ります 彼ら自身の子が順番にマージされ、どれも削除されることはありません。の ユニオンは、ピボットがコンテナを再検出して、見つかったものを追加する方法です。 すでにそこにあるものを邪魔する。

パラメータ ​

children ​

Node[]

返品 ​

Node[]

新しく追加されたすべてのノードを任意の深さで作成できるため、呼び出し元は登録して それらにタグを付けます。


updateData() ​

updateData(partialData): void

定義: Node.ts:147

部分的なデータを現在のノード データにマージします。 データの一部のみを更新する場合に便利です。

パラメータ ​

partialData ​

Partial<NodeData>

マージする部分的なデータ オブジェクト

返品 ​

void


updateStyle() ​

updateStyle(partialStyle): void

定義: Node.ts:225

部分的なデータを現在のノード データにマージします。 データの一部のみを更新する場合に便利です。

パラメータ ​

partialStyle ​

Partial<NodeStyle>

マージする部分的なデータ オブジェクト

返品 ​

void

プロパティ ​

children ​

children: Node[]

定義: Node.ts:45


childrenDepth ​

childrenDepth: number

定義: Node.ts:64


defaultCircleRadius ​

defaultCircleRadius: number = 10

定義: Node.ts:49


domID ​

readonly domID: string

定義: Node.ts:101


expanded? ​

optional expanded: boolean

定義: Node.ts:61


frozen? ​

optional frozen: boolean

定義: Node.ts:59


fx? ​

optional fx: number

定義: Node.ts:56


fy? ​

optional fy: number

定義: Node.ts:57


id ​

readonly id: string

定義: Node.ts:43


isChild ​

isChild: boolean

定義: Node.ts:63

このノードが折りたたまれたクラスター内の子である場合は True


isParent ​

isParent: boolean

定義: Node.ts:66

このノードに子ノードがある場合は True


parentNode? ​

optional parentNode: Node

定義: Node.ts:68

親クラスター ノードへの参照 (このノードが子の場合)


visible ​

visible: boolean

定義: Node.ts:60


vx? ​

optional vx: number

定義: Node.ts:54


vy? ​

optional vy: number

定義: Node.ts:55


weight? ​

optional weight: number

定義: Node.ts:58


x? ​

optional x: number

定義: Node.ts:52


y? ​

optional y: number

定義: Node.ts:53