Interfaz: InterractionCallbacks<TElement>

Devoluciones

boolean

onBadgeClick()?

optional onBadgeClick: (event, node, badge, element) => void

Definido en: interfaces/InterractionCallbacks.ts:69

Se llama cuando se hace clic en cualquiera de las insignias de borde de un nodo, después de la propia insignia. onClick. Úselo para el comportamiento que comparte cada insignia; utilizar NodeBadge.onClick por la propia acción de una insignia.

Declararlo hace que cada insignia tome el cursor del puntero y consuma su clic, por lo que el nodo debajo tampoco está seleccionado.

Parámetros

event

PointerEvent

node

badge

NodeBadge

element

TElement

Devoluciones

void

onBeforeDelete()?

optional onBeforeDelete: (context) => DeleteDecision | Promise<DeleteDecision>

Definido en: interfaces/InterractionCallbacks.ts:277

Se llama cuando el usuario solicita eliminar elementos del gráfico, antes cualquier cosa es eliminado. La biblioteca resuelve primero todo el conjunto de objetivos, incluidos los bordes. que eliminar un nodo llevaría consigo (DeleteContext.cascadingEdges): para que un consumidor pueda conservar la totalidad consecuencia del gesto sin volver a derivar la cascada.

Regresar false / { accept: false } a vetar: no se elimina nada, no nodeRemove/edgeRemove/noteRemove se activa y la selección queda intacta.
Regrese true para eliminar exactamente lo que se solicitó.
Regrese { accept: true, nodes?, edges?, notes? } a estreche y elimine a un subconjunto - p.e. conserve solo lo que el backend realmente eliminó. Una clave omitida significa "según lo solicitado", por lo que { accept: true } equivale a true; pasar un matriz vacía para ahorrar ese tipo por completo. Elementos que no formaban parte del Se ignoran las solicitudes.

Puede ser asíncrono (persistir en la eliminación, luego decidir): se realiza un segundo gesto de eliminación ignorado mientras esté pendiente una decisión. DeleteContext.confirm abre un modal de confirmación para que los consumidores no reconstruyan uno.

Solo se bloquean las eliminaciones iniciadas por el usuario: programática graph.removeNode() / graph.removeEdge() / noteManager.removeNote() nunca invoques este gancho, así que El código del consumidor que impulsa el modelo no está bloqueado por la propia puerta del consumidor.

Parámetros

context

DeleteContext

Devoluciones

DeleteDecision | Promise<DeleteDecision>

onBeforeEdgeCreate()?

optional onBeforeEdgeCreate: (context) => EdgeCreateDecision | Promise<EdgeCreateDecision>

Definido en: interfaces/InterractionCallbacks.ts:241

Se llama durante un gesto de conexión, después de que se resuelve el nodo de destino, pero antes de se crea el borde (o enlace de nota). Actúa como el equivalente de borde de onBeforeNodeEditCommit: un gancho de validación/enriquecimiento/veto.

Regresar false / { accept: false } para vetar: la vista previa se elimina, no se agrega nada y el modo de conexión permanece activado para que el usuario pueda volver a intentarlo.
Regrese true para aceptar con los valores predeterminados.
Regrese { accept: true, data?, style?, id?, directed? } para aceptar y proporcione la carga útil/estilo/id/dirección del nuevo borde.

Puede ser asíncrono (por ejemplo, persistir en un backend antes de decidir); el borde de la sombra La vista previa persiste hasta que se cumple la promesa y no se realiza ningún nuevo gesto de conexión. aceptado mientras esté pendiente. Se activa tanto al hacer clic como al arrastrar para conectar. También se activa para enlaces de nota → nodo (EdgeCreateContext.kind 'note-link'), donde se ignoran los campos de decisión específicos de los bordes.

Parámetros

context

EdgeCreateContext

Devoluciones

EdgeCreateDecision | Promise<EdgeCreateDecision>

si se debe crear la conexión, opcionalmente con sus datos.

onBeforeEdgeEditCommit()?

optional onBeforeEdgeEditCommit: (context) => boolean | Promise<boolean>

Definido en: interfaces/InterractionCallbacks.ts:320

Se llama cuando una sesión de edición perimetral está a punto de confirmarse. Actúa como un validación/persistencia/gancho de veto, duplicación onBeforeNodeEditCommit: regresar false (o una promesa de ello) para rechazar, dejando los datos del borde intacto y el modal abierto. Si tiene éxito, los datos del borde se reemplazan y edgeChange se dispara en el bus de datos.

Parámetros

context

EdgeEditCommitContext

Devoluciones

boolean | Promise<boolean>

si el compromiso debe continuar

onBeforeIngest()?

optional onBeforeIngest: (context) => IngestDecision | Promise<IngestDecision>

Definido en: interfaces/InterractionCallbacks.ts:300

Se llama una vez, con todo el conjunto de candidatos, justo antes de que un pivote lo ingiera. la única puerta en la tubería de ingesta.

Regrese false / { accept: false } para vetar: nada aterriza y corre informes 'vetoed'.
Regrese true para ingerir exactamente lo que se eligió.
Regrese { accept: true, nodes?, edges? } a estreche la ingesta a un subconjunto - p.e. sólo lo que confirmó el backend. Una clave omitida significa "como solicitado", por lo que { accept: true } equivale a true; pasar un vacío matriz para aterrizar nada de ese tipo.

Se llama una vez por ingesta con todo el lote, nunca por candidato: un pivote que encontró 1.800 correlaciones no debe convertirse en 1.800 llamadas de gancho, y el Ganchos de ruta de escritura por gesto (onBeforeEdgeCreate, onBeforeDelete) Se tratan deliberadamente de gestos del usuario en lugar de una fusión programática. puertas autoIngest también gira, que es lo que los mantiene gobernados.

Puede ser asíncrono (persistir y luego decidir). IngestContext.confirm abre el modal de confirmación compartida.

Parámetros

context

IngestContext

Devoluciones

IngestDecision | Promise<IngestDecision>

onBeforeNodeCreate()?

optional onBeforeNodeCreate: (context) => NodeCreateDecision | Promise<NodeCreateDecision>

Definido en: interfaces/InterractionCallbacks.ts:342

Se llama cuando el usuario crea un nodo de forma interactiva (Crear ▸ Agregar nodo, o el "Agregar nodo aquí" del menú contextual del lienzo), una vez que se conoce la posición del espacio del gráfico y antes de agregar el nodo. Espejos onBeforeEdgeCreate:

Regrese false / { accept: false } para vetar: no se agrega nada.
Regrese true para aceptar el nodo predeterminado de la biblioteca.
Regrese { accept: true, id?, data?, style? } para aceptar y suministrar el nuevo ID/carga útil/estilo del nodo.

Puede ser asíncrono y NodeCreateContext.promptData abre lo mismo forma declarativa o modal personalizado HTML que utiliza el gancho de borde. En ausencia de este gancho, el La herramienta todavía funciona: simplemente crea un nodo predeterminado sin nombre. programático graph.addNode() nunca está cerrado.

Parámetros

context

NodeCreateContext

Devoluciones

NodeCreateDecision | Promise<NodeCreateDecision>

onBeforeNodeEditCommit()?

optional onBeforeNodeEditCommit: (context) => boolean | Promise<boolean>

Definido en: interfaces/InterractionCallbacks.ts:216

Se llama cuando una sesión de edición de nodo está a punto de confirmarse. Actúa como un validación/persistencia/gancho de veto: devolver false (o una promesa de ello) a rechazar, dejando los datos del nodo intactos y el modal abierto. En el éxito el Los datos del nodo se reemplazan y nodeChange se activa en el bus de datos.

Parámetros

context

NodeEditCommitContext

Devoluciones

boolean | Promise<boolean>

booleano que indica si la confirmación debe continuar o no

onCanvasBeforeZoom()?

optional onCanvasBeforeZoom: (event) => void

Definido en: interfaces/InterractionCallbacks.ts:176

Se llama cuando el lienzo está a punto de ampliarse.

Parámetros

event

unknown

Devoluciones

void

onCanvasClick()?

optional onCanvasClick: (event) => void

Definido en: interfaces/InterractionCallbacks.ts:162

Se llama cuando se hace clic en el lienzo.

Parámetros

event

PointerEvent

Devoluciones

void

onCanvasContextmenu()?

optional onCanvasContextmenu: (event) => void

Definido en: interfaces/InterractionCallbacks.ts:186

Se llama cuando se hace clic derecho en el lienzo.

Parámetros

event

PointerEvent

Devoluciones

void

onCanvasMousemove()?

optional onCanvasMousemove: (event) => void

Definido en: interfaces/InterractionCallbacks.ts:191

Se llama cuando el mouse se mueve sobre el lienzo.

Parámetros

event

MouseEvent

Devoluciones

void

onCanvasPointerDown()?

optional onCanvasPointerDown: (event) => void

Definido en: interfaces/InterractionCallbacks.ts:167

Se llama cuando un usuario apunta hacia abajo en el lienzo.

Parámetros

event

PointerEvent

Devoluciones

void

onCanvasPointerUp()?

optional onCanvasPointerUp: (event) => void

Definido en: interfaces/InterractionCallbacks.ts:171

Se llama cuando un usuario señala el lienzo.

Parámetros

event

PointerEvent

Devoluciones

void

onCanvasZoom()?

optional onCanvasZoom: (event) => void

Definido en: interfaces/InterractionCallbacks.ts:181

Se llama cuando se hace zoom en el lienzo.

Parámetros

event

unknown

Devoluciones

void

onEdgeBlur()?

optional onEdgeBlur: (edge, element) => void

Definido en: interfaces/InterractionCallbacks.ts:102

Se llama cuando el usuario deselecciona un borde.

Parámetros

edge

element

TElement

Devoluciones

void

onEdgeClick()?

optional onEdgeClick: (event, edge, element) => void

Definido en: interfaces/InterractionCallbacks.ts:84

Se llama cuando el usuario selecciona una arista.

Parámetros

event

PointerEvent

edge

element

TElement

Devoluciones

void

onEdgeContextmenu()?

optional onEdgeContextmenu: (event, edge, element) => void

Definido en: interfaces/InterractionCallbacks.ts:92

Se llama cuando se hace clic derecho en un borde.

Parámetros

event

PointerEvent

edge

element

TElement

Devoluciones

void

onEdgeDbclick()?

optional onEdgeDbclick: (event, edge, element) => void

Definido en: interfaces/InterractionCallbacks.ts:88

Se llama cuando el usuario selecciona una arista.

Parámetros

event

PointerEvent

edge

element

TElement

Devoluciones

void

onEdgeEdit()?

optional onEdgeEdit: (session) => HTMLDivElement

Definido en: interfaces/InterractionCallbacks.ts:310

Se llama cuando comienza una sesión de edición perimetral. Actúa como un gancho de interfaz de usuario, reflejando onNodeEdit: devuelve el cuerpo para inyectarlo en el modal de edición. una costumbre el cuerpo es dueño del borrador: muta session.draft (o llama a session.setDraft) como el usuario escribe, porque la biblioteca no tiene un formulario para leer al enviar.

Parámetros

session

EdgeEditSession

La sesión de edición de borde

Devoluciones

HTMLDivElement

Un HTML Div que será inyectado en el cuerpo del modal

onEdgeEditCancel()?

optional onEdgeEditCancel: (edge) => void

Definido en: interfaces/InterractionCallbacks.ts:325

Se llama cuando se cancela una sesión de edición perimetral.

Parámetros

edge

Devoluciones

void

onEdgeHoverIn()?

optional onEdgeHoverIn: (event, edge, element) => void

Definido en: interfaces/InterractionCallbacks.ts:107

Se llama cuando un usuario pasa el cursor sobre un borde.

Parámetros

event

PointerEvent

edge

element

TElement

Devoluciones

void

onEdgeHoverOut()?

optional onEdgeHoverOut: (event, edge, element) => void

Definido en: interfaces/InterractionCallbacks.ts:111

Se llama cuando un usuario pasa el cursor sobre un borde.

Parámetros

event

PointerEvent

edge

element

TElement

Devoluciones

void

onEdgeSelect()?

optional onEdgeSelect: (edge, element) => void

Definido en: interfaces/InterractionCallbacks.ts:97

Se llama cuando el usuario selecciona una arista.

Parámetros

edge

element

TElement

Devoluciones

void

onNodeBlur()?

optional onNodeBlur: (node, element) => void

Definido en: interfaces/InterractionCallbacks.ts:59

Se llama cuando el usuario deselecciona un nodo.

Parámetros

node

element

TElement

Devoluciones

void

onNodeClick()?

optional onNodeClick: (event, node, element) => void

Definido en: interfaces/InterractionCallbacks.ts:16

Se llama cuando se hace clic en un nodo.

Parámetros

event

PointerEvent

node

element

TElement

Devoluciones

void

onNodeContextmenu()?

optional onNodeContextmenu: (event, node, element) => void

Definido en: interfaces/InterractionCallbacks.ts:26

Se llama cuando se hace clic derecho en un nodo.

Parámetros

event

PointerEvent

node

element

TElement

Devoluciones

void

onNodeDbclick()?

optional onNodeDbclick: (event, node, element) => void

Definido en: interfaces/InterractionCallbacks.ts:21

Se llama cuando se hace doble clic en un nodo.

Parámetros

event

PointerEvent

node

element

TElement

Devoluciones

void

onNodeDragended()?

optional onNodeDragended: (event, node) => void

Definido en: interfaces/InterractionCallbacks.ts:79

Se llama cuando finaliza el arrastre de un nodo.

Parámetros

event

MouseEvent

node

Devoluciones

void

onNodeDragging()?

optional onNodeDragging: (event, node) => void

Definido en: interfaces/InterractionCallbacks.ts:74

Se llama cuando se arrastra un nodo.

Parámetros

event

MouseEvent

node

Devoluciones

void

onNodeEdit()?

optional onNodeEdit: (session) => HTMLDivElement

Definido en: interfaces/InterractionCallbacks.ts:208

Se llama cuando comienza una sesión de edición de nodo. Actúa como un gancho de interfaz de usuario.

Parámetros

session

NodeEditSession

La sesión de edición de nodos

Devoluciones

HTMLDivElement

Un HTML Div que será inyectado en el cuerpo del modal

onNodeEditCancel()?

optional onNodeEditCancel: (node) => void

Definido en: interfaces/InterractionCallbacks.ts:220

Se llama cuando se cancela una sesión de edición de nodo

Parámetros

node

Devoluciones

void

onNodeHoverIn()?

optional onNodeHoverIn: (event, node, element) => void

Definido en: interfaces/InterractionCallbacks.ts:31

Se llama cuando un usuario pasa el cursor sobre un nodo.

Parámetros

event

PointerEvent

node

element

TElement

Devoluciones

void

onNodeHoverOut()?

optional onNodeHoverOut: (event, node, element) => void

Definido en: interfaces/InterractionCallbacks.ts:35

Se llama cuando un usuario sale de un nodo.

Parámetros

event

PointerEvent

node

element

TElement

Devoluciones

void

onNodePointerDown()?

optional onNodePointerDown: (event, node, element) => void

Definido en: interfaces/InterractionCallbacks.ts:40

Se llama cuando un usuario apunta hacia un nodo.

Parámetros

event

PointerEvent

node

element

TElement

Devoluciones

void

onNodePointerUp()?

optional onNodePointerUp: (event, node, element) => void

Definido en: interfaces/InterractionCallbacks.ts:44

Se llama cuando un usuario señala un nodo.

Parámetros

event

PointerEvent

node

element

TElement

Devoluciones

void

onNodeSelect()?

optional onNodeSelect: (node, element) => void

Definido en: interfaces/InterractionCallbacks.ts:49

Se llama cuando el usuario selecciona un nodo.

Parámetros

node

element

TElement

Devoluciones

void

onNodesSelect()?

optional onNodesSelect: (selection) => void

Definido en: interfaces/InterractionCallbacks.ts:54

Se llama cuando el usuario selecciona los nodos.

Parámetros

selection

NodeSelection<TElement>[]

Devoluciones

void

onNoteClick()?

optional onNoteClick: (event, note, element) => void

Definido en: interfaces/InterractionCallbacks.ts:116

Se llama cuando se hace clic en una nota.

Parámetros

event

PointerEvent

note

element

TElement

Devoluciones

void

onNoteContextmenu()?

optional onNoteContextmenu: (event, note, element) => void

Definido en: interfaces/InterractionCallbacks.ts:126

Se llama cuando se hace clic derecho en una nota.

Parámetros

event

PointerEvent

note

element

TElement

Devoluciones

void

onNoteDbclick()?

optional onNoteDbclick: (event, note, element) => void

Definido en: interfaces/InterractionCallbacks.ts:121

Se llama cuando se hace doble clic en una nota.

Parámetros

event

PointerEvent

note

element

TElement

Devoluciones

void

onNoteDragging()?

optional onNoteDragging: (event, note) => void

Definido en: interfaces/InterractionCallbacks.ts:157

Se llama cuando un usuario señala un nodo.

Parámetros

event

PointerEvent

note

Devoluciones

void

onNoteHandleClick()?

optional onNoteHandleClick: (event, note, handle) => void

Definido en: interfaces/InterractionCallbacks.ts:149

Se llama cuando un usuario apunta hacia un nodo.

Parámetros

event

PointerEvent

note

handle

HTMLElement

Devoluciones

void

onNoteHandlePointerDown()?

optional onNoteHandlePointerDown: (event, note, handle) => void

Definido en: interfaces/InterractionCallbacks.ts:153

Se llama cuando un usuario señala un nodo.

Parámetros

event

PointerEvent

note

handle

HTMLElement

Devoluciones

void

onNoteHoverIn()?

optional onNoteHoverIn: (event, note, element) => void

Definido en: interfaces/InterractionCallbacks.ts:131

Se llama cuando un usuario pasa el cursor sobre una nota.

Parámetros

event

PointerEvent

note

element

TElement

Devoluciones

void

onNoteHoverOut()?

optional onNoteHoverOut: (event, note, element) => void

Definido en: interfaces/InterractionCallbacks.ts:135

Se llama cuando un usuario sale de una nota.

Parámetros

event

PointerEvent

note

element

TElement

Devoluciones

void

onNotePointerDown()?

optional onNotePointerDown: (event, note, element) => void

Definido en: interfaces/InterractionCallbacks.ts:140

Se llama cuando un usuario apunta hacia un nodo.

Parámetros

event

PointerEvent

note

element

TElement

Devoluciones

void

onNotePointerUp()?

optional onNotePointerUp: (event, note, element) => void

Definido en: interfaces/InterractionCallbacks.ts:144

Se llama cuando un usuario señala un nodo.

Parámetros

event

PointerEvent

note