pivotick v3.0.0

---

pivotick / GraphUI / 工具提示

接口: Tooltip

定义于：interfaces/GraphUI.ts:1044

属性

allowPinning?

optional allowPinning: boolean

定义于：interfaces/GraphUI.ts:1054

---

edgeHeaderMap

edgeHeaderMap: Partial<HeaderMapEntry<Edge>>

定义于：interfaces/GraphUI.ts:1081

---

edgePropertiesMap()

edgePropertiesMap: (edge, ctx) => PropertyEntry[] | Promise<PropertyEntry[]>

定义于：interfaces/GraphUI.ts:1085

可能是 async — 属性列表显示一个占位符，直到它解析为止。

参数

edge

Edge

ctx

RenderContext

返回值

PropertyEntry[] | Promise<PropertyEntry[]>

---

enabled?

optional enabled: boolean | TooltipKinds | (element, kind) => boolean

定义于：interfaces/GraphUI.ts:1053

悬停时会显示工具提示。

• true / false：全部或无。
• { nodes, edges, groups }：每种。缺少的键是 true，因此 { edges: false } 表示除边之外的所有内容。
• (element, kind) => boolean：每次悬停时都会询问。投掷的算作 false。

默认值

true

---

nodeHeaderMap

nodeHeaderMap: Partial<HeaderMapEntry<Node>>

定义于：interfaces/GraphUI.ts:1080

---

nodePropertiesMap()

nodePropertiesMap: (node, ctx) => PropertyEntry[] | Promise<PropertyEntry[]>

定义于：interfaces/GraphUI.ts:1083

可能是 async — 属性列表显示一个占位符，直到它解析为止。

参数

node

Node

ctx

RenderContext

返回值

PropertyEntry[] | Promise<PropertyEntry[]>

---

render?

optional render: string | HTMLElement | (element, ctx) => RenderResult

定义于：interfaces/GraphUI.ts:1094

工具提示的自定义渲染器。此内容将覆盖默认工具提示

默认值

undefined

示例

(element) => `element id: ${element.id}`

备注

返回的 string 呈现为纯文本；返回 HTMLElement 来渲染 HTML。可能是 async，与 Tooltip.renderNodeExtra 相同。

---

renderEdgeExtra()?

optional renderEdgeExtra: (edge, ctx) => RenderResult

定义于：interfaces/GraphUI.ts:1070

边缘工具提示的自定义渲染器。此内容添加在默认工具提示之后。

可能是 async，与 Tooltip.renderNodeExtra 相同。

参数

edge

Edge

ctx

RenderContext

返回值

RenderResult

默认值

undefined

---

renderGroupExtra()?

optional renderGroupExtra: (group, ctx) => RenderResult

定义于：interfaces/GraphUI.ts:1079

组工具提示的自定义渲染器，由 UI.simplify 制作。添加在其成员及其链接到的节点之后。一组会跳过render和renderNodeExtra，它们是关于一个节点的数据。

可能是 async，与 Tooltip.renderNodeExtra 相同。

参数

group

GroupInfo

ctx

RenderContext

返回值

RenderResult

默认值

undefined

---

renderNodeExtra()?

optional renderNodeExtra: (node, ctx) => RenderResult

定义于：interfaces/GraphUI.ts:1063

节点工具提示的自定义渲染器。此内容添加在默认工具提示之后。

可能是 async — 工具提示显示一个占位符，然后交换内容并重新定位自身。将鼠标悬停在另一个节点上首先会丢弃过时的结果并中止 ctx.signal。

参数

node

Node

ctx

RenderContext

返回值

RenderResult

默认值

undefined

---

setPosition()?

optional setPosition: (tooltip, hoveredBCR, canvasBbox) => void

定义于：interfaces/GraphUI.ts:1095

参数

tooltip

HTMLElement

hoveredBCR

DOMRect

canvasBbox

DOMRect

返回值

void