pivotick v3.0.0

---

pivotick / GraphUI / Dica de ferramenta

Interface: Tooltip

Definido em: interfaces/GraphUI.ts:1044

Propriedades

allowPinning?

optional allowPinning: boolean

Definido em: interfaces/GraphUI.ts:1054

---

edgeHeaderMap

edgeHeaderMap: Partial<HeaderMapEntry<Edge>>

Definido em: interfaces/GraphUI.ts:1081

---

edgePropertiesMap()

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

Definido em: interfaces/GraphUI.ts:1085

Pode ser async — a lista de propriedades mostra um espaço reservado até ser resolvida.

Parâmetros

edge

Edge

ctx

RenderContext

Retorno

PropertyEntry[] | Promise<PropertyEntry[]>

---

enabled?

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

Definido em: interfaces/GraphUI.ts:1053

Que paira mostra uma dica de ferramenta.

• true / false: tudo ou nada.
• { nodes, edges, groups }: por tipo. Uma chave ausente é true, então { edges: false } significa tudo, menos arestas.
• (element, kind) => boolean: perguntado em cada pairar. Aquele que lança conta como false.

Padrão

true

---

nodeHeaderMap

nodeHeaderMap: Partial<HeaderMapEntry<Node>>

Definido em: interfaces/GraphUI.ts:1080

---

nodePropertiesMap()

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

Definido em: interfaces/GraphUI.ts:1083

Pode ser async — a lista de propriedades mostra um espaço reservado até ser resolvida.

Parâmetros

node

Node

ctx

RenderContext

Retorno

PropertyEntry[] | Promise<PropertyEntry[]>

---

render?

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

Definido em: interfaces/GraphUI.ts:1094

Renderizador personalizado para a dica de ferramenta. Este conteúdo substituirá a dica de ferramenta padrão

Padrão

undefined

Exemplo

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

Observações

Um string retornado é renderizado como texto simples; retorne um HTMLElement para renderizar HTML. Pode ser async, nos mesmos termos de Tooltip.renderNodeExtra.

---

renderEdgeExtra()?

optional renderEdgeExtra: (edge, ctx) => RenderResult

Definido em: interfaces/GraphUI.ts:1070

Renderizador personalizado para dicas de ferramentas de borda. Este conteúdo é adicionado após a dica de ferramenta padrão.

Pode ser async, nos mesmos termos de Tooltip.renderNodeExtra.

Parâmetros

edge

Edge

ctx

RenderContext

Retorno

RenderResult

Padrão

undefined

---

renderGroupExtra()?

optional renderGroupExtra: (group, ctx) => RenderResult

Definido em: interfaces/GraphUI.ts:1079

Renderizador personalizado para a dica de ferramenta de um grupo, feito por UI.simplify. Adicionado após seus membros e os nós aos quais ele está vinculado. Um grupo pula render e renderNodeExtra, que tratam dos dados de um nó.

Pode ser async, nos mesmos termos de Tooltip.renderNodeExtra.

Parâmetros

group

GroupInfo

ctx

RenderContext

Retorno

RenderResult

Padrão

undefined

---

renderNodeExtra()?

optional renderNodeExtra: (node, ctx) => RenderResult

Definido em: interfaces/GraphUI.ts:1063

Renderizador personalizado para dicas de ferramentas de nós. Este conteúdo é adicionado após a dica de ferramenta padrão.

Pode ser async — a dica de ferramenta mostra um espaço reservado, depois troca o conteúdo e se reposiciona. Passar o mouse sobre outro nó primeiro descarta o resultado obsoleto e aborta ctx.signal.

Parâmetros

node

Node

ctx

RenderContext

Retorno

RenderResult

Padrão

undefined

---

setPosition()?

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

Definido em: interfaces/GraphUI.ts:1095

Parâmetros

tooltip

HTMLElement

hoveredBCR

DOMRect

canvasBbox

DOMRect

Retorno

void