pivotick v3.0.0

---

pivotick / GraphUI / Tooltip

Interface: Tooltip

Definiert in: interfaces/GraphUI.ts:1044

Eigenschaften

allowPinning?

optional allowPinning: boolean

Definiert in: interfaces/GraphUI.ts:1054

---

edgeHeaderMap

edgeHeaderMap: Partial<HeaderMapEntry<Edge>>

Definiert in: interfaces/GraphUI.ts:1081

---

edgePropertiesMap()

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

Definiert in: interfaces/GraphUI.ts:1085

Kann async sein – die Eigenschaftsliste zeigt einen Platzhalter an, bis er aufgelöst wird.

Parameter

edge

Edge

ctx

RenderContext

Rückgabewert

PropertyEntry[] | Promise<PropertyEntry[]>

---

enabled?

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

Definiert in: interfaces/GraphUI.ts:1053

Welche Hover zeigen einen Tooltip an.

• true / false: alle oder keine.
• { nodes, edges, groups }: pro Art. Ein fehlender Schlüssel ist true, also bedeutet { edges: false } alles außer Kanten.
• (element, kind) => boolean: Wird bei jedem Hover gefragt. Einer, der wirft, zählt als false.

Standardwert

true

---

nodeHeaderMap

nodeHeaderMap: Partial<HeaderMapEntry<Node>>

Definiert in: interfaces/GraphUI.ts:1080

---

nodePropertiesMap()

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

Definiert in: interfaces/GraphUI.ts:1083

Kann async sein – die Eigenschaftsliste zeigt einen Platzhalter an, bis er aufgelöst wird.

Parameter

node

Node

ctx

RenderContext

Rückgabewert

PropertyEntry[] | Promise<PropertyEntry[]>

---

render?

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

Definiert in: interfaces/GraphUI.ts:1094

Benutzerdefinierter Renderer für den Tooltip. Dieser Inhalt überschreibt den Standard-Tooltip

Standardwert

undefined

Beispiel

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

Bemerkungen

Ein zurückgegebenes string wird als einfacher Text gerendert; Geben Sie ein HTMLElement zurück, um HTML zu rendern. Kann async sein, zu den gleichen Bedingungen wie Tooltip.renderNodeExtra.

---

renderEdgeExtra()?

optional renderEdgeExtra: (edge, ctx) => RenderResult

Definiert in: interfaces/GraphUI.ts:1070

Benutzerdefinierter Renderer für Kanten-Tooltips. Dieser Inhalt wird nach dem Standard-Tooltip hinzugefügt.

Kann async sein, zu den gleichen Bedingungen wie Tooltip.renderNodeExtra.

Parameter

edge

Edge

ctx

RenderContext

Rückgabewert

RenderResult

Standardwert

undefined

---

renderGroupExtra()?

optional renderGroupExtra: (group, ctx) => RenderResult

Definiert in: interfaces/GraphUI.ts:1079

Benutzerdefinierter Renderer für den Tooltip einer Gruppe, erstellt von UI.simplify. Wird nach seinen Mitgliedern und den Knoten, mit denen es verknüpft ist, hinzugefügt. Eine Gruppe überspringt render und renderNodeExtra, bei denen es um die Daten eines Knotens geht.

Kann async sein, zu den gleichen Bedingungen wie Tooltip.renderNodeExtra.

Parameter

group

GroupInfo

ctx

RenderContext

Rückgabewert

RenderResult

Standardwert

undefined

---

renderNodeExtra()?

optional renderNodeExtra: (node, ctx) => RenderResult

Definiert in: interfaces/GraphUI.ts:1063

Benutzerdefinierter Renderer für Knoten-Tooltips. Dieser Inhalt wird nach dem Standard-Tooltip hinzugefügt.

Möglicherweise async – der Tooltip zeigt einen Platzhalter an, tauscht dann den Inhalt aus und positioniert sich neu. Wenn Sie zuerst mit der Maus über einen anderen Knoten fahren, wird das veraltete Ergebnis gelöscht und ctx.signal abgebrochen.

Parameter

node

Node

ctx

RenderContext

Rückgabewert

RenderResult

Standardwert

undefined

---

setPosition()?

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

Definiert in: interfaces/GraphUI.ts:1095

Parameter

tooltip

HTMLElement

hoveredBCR

DOMRect

canvasBbox

DOMRect

Rückgabewert

void