logo

X6

  • Tutorials
  • API
  • Examples
  • Q&A
  • Change Log
  • XFlow
  • Productsantv logo arrow
  • 2.x
  • start
    • Introduction
    • Quick Start
  • component
    • XFlowGraph Canvas
    • Background
    • Grid
    • Clipboard Copy and Paste
    • History Undo Redo
    • Minimap
    • Snapline Alignment Lines
    • Transform
    • Control Controller
  • Hook
    • useGraphInstance
    • useGraphStore
    • useGraphEvent
    • useDnd
    • useClipboard
    • useExport
    • useHistory
    • useKeyboard
  • Store

useGraphEvent

Previous
useGraphStore
Next
useDnd

Resource

Ant Design
Galacea Effects
Umi-React Application Framework
Dumi-Component doc generator
ahooks-React Hooks Library

Community

Ant Financial Experience Tech
seeconfSEE Conf-Experience Tech Conference

Help

GitHub
StackOverflow

more productsMore Productions

Ant DesignAnt Design-Enterprise UI design language
yuqueYuque-Knowledge creation and Sharing tool
EggEgg-Enterprise-class Node development framework
kitchenKitchen-Sketch Tool set
GalaceanGalacean-Interactive solution
xtechLiven Experience technology
© Copyright 2025 Ant Group Co., Ltd..备案号:京ICP备15032932号-38

Loading...

Canvas Event Listener Hook

Basic Usage

useGraphEvent('blank:click', () => { ... });

Here is a simple example of using useGraphEvent to listen for node click events and randomly change the node color.

API

useGraphEvent<T extends keyof EventArgs>(
name: T,
callback: (args: EventArgs[T]) => void
);

Return Value

None

Parameters

For specific event types to listen to, please refer to X6 Events.

ParameterDescriptionTypeDefault Value
nameThe event to listen forT-
callbackThe callback for the event listener(args: EventArgs[T]) => void-