@antv/g6
Version:
A Graph Visualization Framework in JavaScript
30 lines (29 loc) • 813 B
TypeScript
import type { Graph } from '../runtime/graph';
export type BehaviorOptions = (string | CustomBehaviorOption | ((this: Graph) => CustomBehaviorOption))[];
export interface UpdateBehaviorOption {
key: string;
[key: string]: unknown;
}
export interface CustomBehaviorOption extends Record<string, any> {
/**
* <zh/> 交互类型
*
* <en/> Behavior type
*/
type: string;
/**
* <zh/> 交互 key,即唯一标识
*
* <en/> Behavior key, that is, the unique identifier
* @remarks
* <zh/> 用于标识交互,从而进一步操作此交互
*
* <en/> Used to identify the behavior for further operations
*
* ```ts
* // Update behavior options
* graph.updateBehavior({key: 'key', ...});
* ```
*/
key?: string;
}