pivotick v3.0.0

---

pivotick / 节点

类: Node

定义于：Node.ts:42

表示图中的单个节点（顶点）。

访问器

isGroup

Getter 签名

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

为一个主元声明的潜力，或者（无参数）为没有特定主元声明的总潜力。 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

删除一个孩子及其自己的子树。返回被删除的子级，以便调用者可以在其后代之后进行清理。

参数

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' 轮辋徽章更喜欢的数字 - 当提供者数量超出轮辋所能命名的数量时要声明的数字。

像这里的所有其他 setter 一样将节点标记为脏，因此徽章出现在下一个渲染上 - 如果没有其他事情要调用，则调用 graph.renderer.update()。

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' 轮辋徽章更喜欢的数字 - 当提供者数量超出轮辋所能命名的数量时要声明的数字。

像这里的所有其他 setter 一样将节点标记为脏，因此徽章出现在下一个渲染上 - 如果没有其他事情要调用，则调用 graph.renderer.update()。

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

默认值：假

返回值

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

按 id 合并 children：添加新的，匹配的保持不变——它们自己的子级依次合并——并且没有一个被删除。联合是指重新发现容器的拓展如何添加它发现的内容而不干扰已有的内容。

参数

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