draaipunt / InterractionCallbacks / InterractionCallbacks
Interface: InterractionCallbacks<TElement>
Gedefinieerd in: interfaces/InterractionCallbacks.ts:12
Typ parameters
TElement
TElement = unknown
Eigenschappen
isValidConnection()?
optionalisValidConnection: (source,target) =>boolean
Gedefinieerd in: interfaces/InterractionCallbacks.ts:251
Live geldigheidspredikaat geëvalueerd tijdens het verbindingsgebaar als cursor zweeft kandidaatdoelen (à la React Flow's isValidConnection). Keer terug false om het zweefdoel als ongeldig te markeren: de schaduwrand wordt weergegeven in een ongeldige stijl, en het loslaten/klikken ervan creëert niets (in dat geval onBeforeEdgeCreate wordt niet geraadpleegd). Loopt bij elke wijzerbeweging, dus het moet synchroon en goedkoop zijn.
Parameters
source
target
Retouren
boolean
onBadgeClick()?
optionalonBadgeClick: (event,node,badge,element) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:69
Wordt aangeroepen wanneer op een van de randbadges van een knooppunt wordt geklikt, na die van die badge onClick. Gebruik het voor gedrag dat elke badge deelt; gebruik NodeBadge.onClick voor de eigen actie van één badge.
Als u dit aangeeft, neemt elke badge de muisaanwijzer en verbruikt hij de klik, dus het onderliggende knooppunt is niet ook geselecteerd.
Parameters
event
PointerEvent
node
badge
element
TElement
Retouren
void
onBeforeDelete()?
optionalonBeforeDelete: (context) =>DeleteDecision|Promise<DeleteDecision>
Gedefinieerd in: interfaces/InterractionCallbacks.ts:277
Wordt aangeroepen wanneer de gebruiker vraagt om grafiekelementen te verwijderen, before alles is verwijderd. De bibliotheek lost eerst de hele doelset op, inclusief de randen dat het verwijderen van een knooppunt met zich mee zou brengen (DeleteContext.cascadingEdges) — zodat een consument de volledige tijd kan volhouden consequentie van het gebaar zonder de cascade opnieuw af te leiden.
- Zet
false/{ accept: false }terug naar veto: er wordt niets verwijderd, neenodeRemove/edgeRemove/noteRemovewordt geactiveerd en de selectie blijft intact. - Retourneer
trueom precies te verwijderen wat er is gevraagd. - Zet
{ accept: true, nodes?, edges?, notes? }terug naar narrow de verwijdering naar een subset - b.v. bewaar alleen wat de backend daadwerkelijk heeft verwijderd. Een weggelaten sleutel betekent "zoals gevraagd", dus{ accept: true }is gelijk aantrue; passeren een lege array om dat soort volledig te sparen. Elementen die geen deel uitmaakten van de verzoek worden genegeerd.
Kan asynchroon zijn (de verwijdering voortzetten en vervolgens beslissen) - een tweede verwijderingsgebaar is dat wel genegeerd terwijl een beslissing in behandeling is. DeleteContext.confirm opent een bevestigingsmodaliteit, zodat consumenten er geen opnieuw kunnen opbouwen.
Alleen door de gebruiker geïnitieerde verwijderingen zijn beveiligd: programmatisch graph.removeNode() / graph.removeEdge() / noteManager.removeNote() roep deze hook nooit aan, dus De consumentencode die het model aanstuurt, wordt niet geblokkeerd door de eigen poort van de consument.
Parameters
context
Retouren
DeleteDecision | Promise<DeleteDecision>
onBeforeEdgeCreate()?
optionalonBeforeEdgeCreate: (context) =>EdgeCreateDecision|Promise<EdgeCreateDecision>
Gedefinieerd in: interfaces/InterractionCallbacks.ts:241
Wordt aangeroepen tijdens een verbindingsgebaar, nadat het doelknooppunt is opgelost maar voor wordt de rand (of notitielink) gemaakt. Fungeert als het randequivalent van onBeforeNodeEditCommit: een validatie-/verrijkings-/vetohaak.
- Zet
false/{ accept: false }terug naar veto: het voorbeeld wordt verwijderd, er wordt niets toegevoegd en de verbindingsmodus blijft ingeschakeld, zodat de gebruiker het opnieuw kan proberen. - Retourneer
trueom te accepteren met standaardwaarden. - Retourneer
{ accept: true, data?, style?, id?, directed? }om en te accepteren geef de payload/style/id/direction van de nieuwe rand op.
Kan asynchroon zijn (bijv. doorgaan naar een backend alvorens een beslissing te nemen); de schaduwrand preview blijft bestaan totdat de belofte wordt waargemaakt, en er is geen nieuw connect-gebaar aanvaard zolang deze in behandeling is. Brandt voor zowel klikken als slepen om verbinding te maken. Wordt ook geactiveerd voor notitie → knooppuntkoppelingen (EdgeCreateContext.kind 'note-link'), waarbij de randspecifieke velden van de beslissing worden genegeerd.
Parameters
context
Retouren
EdgeCreateDecision | Promise<EdgeCreateDecision>
of de verbinding tot stand moet worden gebracht, eventueel met de bijbehorende gegevens.
onBeforeEdgeEditCommit()?
optionalonBeforeEdgeEditCommit: (context) =>boolean|Promise<boolean>
Gedefinieerd in: interfaces/InterractionCallbacks.ts:320
Wordt aangeroepen wanneer een edge-bewerkingssessie op het punt staat te worden vastgelegd. Fungeert als een validatie / volharding / vetohaak, spiegelen onBeforeNodeEditCommit: return false (of een belofte ervan) om te weigeren, waarbij de gegevens van de rand achterblijven onaangeroerd en het modale open. Bij succes worden de gegevens van de rand vervangen en edgeChange wordt geactiveerd op de databus.
Parameters
context
Retouren
boolean | Promise<boolean>
of de verbintenis moet doorgaan
onBeforeIngest()?
optionalonBeforeIngest: (context) =>IngestDecision|Promise<IngestDecision>
Gedefinieerd in: interfaces/InterractionCallbacks.ts:300
Eén keer gebeld, met de hele kandidaat ingesteld, net voordat een draaipunt het opneemt - de enige poort op de innamepijpleiding.
- Keer
false/{ accept: false }terug naar veto: er landt niets en de run rapporteert'vetoed'. - Geef
trueterug om precies op te nemen wat er is gekozen. - Retourneer
{ accept: true, nodes?, edges? }naar narrow de opname naar een subset - bijv. alleen wat de backend bevestigde. Een weggelaten sleutel betekent 'als' aangevraagd", dus{ accept: true }is gelijk aantrue; passeer een lege klaar om niets van dat soort te landen.
Eén keer per ingest gebeld met de gehele batch, nooit per kandidaat: een pivot die 1.800 correlaties vond, mag niet veranderen in 1.800 hook-calls, en de schrijfpadhaken per gebaar (onBeforeEdgeCreate, onBeforeDelete) gaan bewust over gebruikersgebaren in plaats van over een programmatische samenvoeging. Het poorten autoIngest draait ook, wat hen onder controle houdt.
Kan asynchroon zijn (aanhouden en dan beslissen). IngestContext.confirm opent het gedeeld bevestigingsmodaal.
Parameters
context
Retouren
IngestDecision | Promise<IngestDecision>
onBeforeNodeCreate()?
optionalonBeforeNodeCreate: (context) =>NodeCreateDecision|Promise<NodeCreateDecision>
Gedefinieerd in: interfaces/InterractionCallbacks.ts:342
Wordt aangeroepen wanneer de gebruiker interactief een knooppunt maakt (Maken ▸ Knooppunt toevoegen, of de canvascontextmenu's "Add Node Here"), zodra de positie van de grafiekruimte bekend is en voordat het knooppunt wordt toegevoegd. Spiegels onBeforeEdgeCreate:
- Zet
false/{ accept: false }terug naar veto — er wordt niets toegevoegd. - Retourneer
trueom het standaardknooppunt van de bibliotheek te accepteren. - Retourneer
{ accept: true, id?, data?, style? }om het nieuwe te accepteren en te leveren node's id/payload/stijl.
Kan asynchroon zijn en NodeCreateContext.promptData opent hetzelfde declaratieve vorm of custom-HTML modaal die de edge hook gebruikt. Bij afwezigheid van deze haak de tool werkt nog steeds - het creëert gewoon een standaard, naamloos knooppunt. Programmatisch graph.addNode() is nooit afgesloten.
Parameters
context
Retouren
NodeCreateDecision | Promise<NodeCreateDecision>
onBeforeNodeEditCommit()?
optionalonBeforeNodeEditCommit: (context) =>boolean|Promise<boolean>
Gedefinieerd in: interfaces/InterractionCallbacks.ts:216
Wordt aangeroepen wanneer een knooppuntbewerkingssessie op het punt staat te worden vastgelegd. Fungeert als een validatie / volharding / vetohaak: retourneer false (of een belofte ervan) naar weigeren, waardoor de gegevens van het knooppunt onaangeroerd blijven en het modale open blijft. Bij succes de de gegevens van het knooppunt worden vervangen en nodeChange wordt geactiveerd op de databus.
Parameters
context
Retouren
boolean | Promise<boolean>
Booleaanse waarde die aangeeft of de commit moet doorgaan of niet
onCanvasBeforeZoom()?
optionalonCanvasBeforeZoom: (event) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:176
Wordt opgeroepen als het canvas op het punt staat te worden ingezoomd.
Parameters
event
unknown
Retouren
void
onCanvasClick()?
optionalonCanvasClick: (event) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:162
Wordt opgeroepen wanneer op het canvas wordt geklikt.
Parameters
event
PointerEvent
Retouren
void
onCanvasContextmenu()?
optionalonCanvasContextmenu: (event) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:186
Wordt opgeroepen wanneer er met de rechtermuisknop op het canvas wordt geklikt.
Parameters
event
PointerEvent
Retouren
void
onCanvasMousemove()?
optionalonCanvasMousemove: (event) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:191
Wordt opgeroepen wanneer de muis over het canvas beweegt.
Parameters
event
MouseEvent
Retouren
void
onCanvasPointerDown()?
optionalonCanvasPointerDown: (event) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:167
Wordt aangeroepen wanneer een gebruiker op het canvas naar beneden wijst.
Parameters
event
PointerEvent
Retouren
void
onCanvasPointerUp()?
optionalonCanvasPointerUp: (event) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:171
Wordt aangeroepen wanneer een gebruiker naar het canvas wijst.
Parameters
event
PointerEvent
Retouren
void
onCanvasZoom()?
optionalonCanvasZoom: (event) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:181
Wordt opgeroepen wanneer op het canvas wordt ingezoomd.
Parameters
event
unknown
Retouren
void
onEdgeBlur()?
optionalonEdgeBlur: (edge,element) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:102
Wordt aangeroepen wanneer een rand door de gebruiker wordt gedeselecteerd.
Parameters
edge
element
TElement
Retouren
void
onEdgeClick()?
optionalonEdgeClick: (event,edge,element) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:84
Wordt opgeroepen wanneer een rand door de gebruiker wordt geselecteerd.
Parameters
event
PointerEvent
edge
element
TElement
Retouren
void
onEdgeContextmenu()?
optionalonEdgeContextmenu: (event,edge,element) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:92
Wordt opgeroepen wanneer er met de rechtermuisknop op een rand wordt geklikt.
Parameters
event
PointerEvent
edge
element
TElement
Retouren
void
onEdgeDbclick()?
optionalonEdgeDbclick: (event,edge,element) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:88
Wordt opgeroepen wanneer een rand door de gebruiker wordt geselecteerd.
Parameters
event
PointerEvent
edge
element
TElement
Retouren
void
onEdgeEdit()?
optionalonEdgeEdit: (session) =>HTMLDivElement
Gedefinieerd in: interfaces/InterractionCallbacks.ts:310
Wordt aangeroepen wanneer een edge-bewerkingssessie start. Fungeert als een UI-haak, spiegeling onNodeEdit: retourneer de hoofdtekst om in het bewerkingsmodal te injecteren. Een gewoonte instantie is eigenaar van het concept — muteer session.draft (of noem session.setDraft) als de gebruiker typt, omdat de bibliotheek geen formulier heeft om te lezen bij het indienen.
Parameters
session
EdgeEditSession
De edge-bewerkingssessie
Retouren
HTMLDivElement
Een HTML Div die in het lichaam van de modaal wordt geïnjecteerd
onEdgeEditCancel()?
optionalonEdgeEditCancel: (edge) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:325
Wordt aangeroepen wanneer een edge-bewerkingssessie wordt geannuleerd.
Parameters
edge
Retouren
void
onEdgeHoverIn()?
optionalonEdgeHoverIn: (event,edge,element) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:107
Wordt opgeroepen wanneer een gebruiker over een rand zweeft.
Parameters
event
PointerEvent
edge
element
TElement
Retouren
void
onEdgeHoverOut()?
optionalonEdgeHoverOut: (event,edge,element) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:111
Wordt opgeroepen wanneer een gebruiker over een rand zweeft.
Parameters
event
PointerEvent
edge
element
TElement
Retouren
void
onEdgeSelect()?
optionalonEdgeSelect: (edge,element) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:97
Wordt opgeroepen wanneer een rand door de gebruiker wordt geselecteerd.
Parameters
edge
element
TElement
Retouren
void
onNodeBlur()?
optionalonNodeBlur: (node,element) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:59
Wordt aangeroepen wanneer een knooppunt door de gebruiker wordt gedeselecteerd.
Parameters
node
element
TElement
Retouren
void
onNodeClick()?
optionalonNodeClick: (event,node,element) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:16
Wordt aangeroepen wanneer op een knooppunt wordt geklikt.
Parameters
event
PointerEvent
node
element
TElement
Retouren
void
onNodeContextmenu()?
optionalonNodeContextmenu: (event,node,element) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:26
Wordt aangeroepen wanneer er met de rechtermuisknop op een knooppunt wordt geklikt.
Parameters
event
PointerEvent
node
element
TElement
Retouren
void
onNodeDbclick()?
optionalonNodeDbclick: (event,node,element) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:21
Wordt aangeroepen wanneer op een knooppunt wordt dubbelgeklikt.
Parameters
event
PointerEvent
node
element
TElement
Retouren
void
onNodeDragended()?
optionalonNodeDragended: (event,node) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:79
Wordt aangeroepen wanneer het slepen van een knooppunt eindigt.
Parameters
event
MouseEvent
node
Retouren
void
onNodeDragging()?
optionalonNodeDragging: (event,node) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:74
Wordt aangeroepen wanneer een knooppunt wordt gesleept.
Parameters
event
MouseEvent
node
Retouren
void
onNodeEdit()?
optionalonNodeEdit: (session) =>HTMLDivElement
Gedefinieerd in: interfaces/InterractionCallbacks.ts:208
Wordt aangeroepen wanneer een knooppuntbewerkingssessie start. Fungeren als een UI-hook.
Parameters
session
NodeEditSession
De knooppuntbewerkingssessie
Retouren
HTMLDivElement
Een HTML Div die in het lichaam van de modaal wordt geïnjecteerd
onNodeEditCancel()?
optionalonNodeEditCancel: (node) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:220
Wordt aangeroepen wanneer een knooppuntbewerkingssessie wordt geannuleerd
Parameters
node
Retouren
void
onNodeHoverIn()?
optionalonNodeHoverIn: (event,node,element) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:31
Wordt aangeroepen wanneer een gebruiker over een knooppunt zweeft.
Parameters
event
PointerEvent
node
element
TElement
Retouren
void
onNodeHoverOut()?
optionalonNodeHoverOut: (event,node,element) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:35
Wordt aangeroepen wanneer een gebruiker buiten een knooppunt zweeft.
Parameters
event
PointerEvent
node
element
TElement
Retouren
void
onNodePointerDown()?
optionalonNodePointerDown: (event,node,element) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:40
Wordt aangeroepen wanneer een gebruiker een knooppunt naar beneden wijst.
Parameters
event
PointerEvent
node
element
TElement
Retouren
void
onNodePointerUp()?
optionalonNodePointerUp: (event,node,element) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:44
Wordt aangeroepen wanneer een gebruiker een knooppunt naar boven wijst.
Parameters
event
PointerEvent
node
element
TElement
Retouren
void
onNodeSelect()?
optionalonNodeSelect: (node,element) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:49
Wordt aangeroepen wanneer een knooppunt door de gebruiker wordt geselecteerd.
Parameters
node
element
TElement
Retouren
void
onNodesSelect()?
optionalonNodesSelect: (selection) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:54
Wordt aangeroepen wanneer knooppunten door de gebruiker worden geselecteerd.
Parameters
selection
NodeSelection<TElement>[]
Retouren
void
onNoteClick()?
optionalonNoteClick: (event,note,element) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:116
Wordt gebeld wanneer op een notitie wordt geklikt.
Parameters
event
PointerEvent
note
element
TElement
Retouren
void
onNoteContextmenu()?
optionalonNoteContextmenu: (event,note,element) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:126
Wordt opgeroepen wanneer er met de rechtermuisknop op een notitie wordt geklikt.
Parameters
event
PointerEvent
note
element
TElement
Retouren
void
onNoteDbclick()?
optionalonNoteDbclick: (event,note,element) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:121
Wordt opgeroepen wanneer er op een notitie wordt dubbelgeklikt.
Parameters
event
PointerEvent
note
element
TElement
Retouren
void
onNoteDragging()?
optionalonNoteDragging: (event,note) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:157
Wordt aangeroepen wanneer een gebruiker een knooppunt naar boven wijst.
Parameters
event
PointerEvent
note
Retouren
void
onNoteHandleClick()?
optionalonNoteHandleClick: (event,note,handle) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:149
Wordt aangeroepen wanneer een gebruiker een knooppunt naar beneden wijst.
Parameters
event
PointerEvent
note
handle
HTMLElement
Retouren
void
onNoteHandlePointerDown()?
optionalonNoteHandlePointerDown: (event,note,handle) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:153
Wordt aangeroepen wanneer een gebruiker een knooppunt naar boven wijst.
Parameters
event
PointerEvent
note
handle
HTMLElement
Retouren
void
onNoteHoverIn()?
optionalonNoteHoverIn: (event,note,element) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:131
Wordt opgeroepen wanneer een gebruiker over een notitie beweegt.
Parameters
event
PointerEvent
note
element
TElement
Retouren
void
onNoteHoverOut()?
optionalonNoteHoverOut: (event,note,element) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:135
Wordt opgeroepen wanneer een gebruiker buiten een notitie zweeft.
Parameters
event
PointerEvent
note
element
TElement
Retouren
void
onNotePointerDown()?
optionalonNotePointerDown: (event,note,element) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:140
Wordt aangeroepen wanneer een gebruiker een knooppunt naar beneden wijst.
Parameters
event
PointerEvent
note
element
TElement
Retouren
void
onNotePointerUp()?
optionalonNotePointerUp: (event,note,element) =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:144
Wordt aangeroepen wanneer een gebruiker een knooppunt naar boven wijst.
Parameters
event
PointerEvent
note
element
TElement
Retouren
void
onSimulationSlowTick()?
optionalonSimulationSlowTick: () =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:201
Wordt gebeld wanneer elke tiende van de simulatie tikt.
Retouren
void
onSimulationTick()?
optionalonSimulationTick: () =>void
Gedefinieerd in: interfaces/InterractionCallbacks.ts:196
Wordt gebeld wanneer de simulatie tikt.
Retouren
void