@antv/g6
Version:
A Graph Visualization Framework in JavaScript
43 lines (42 loc) • 1.34 kB
TypeScript
import type { RuntimeContext } from '../runtime/types';
import type { IElementEvent, ViewportAnimationEffectTiming } from '../types';
import type { BaseBehaviorOptions } from './base-behavior';
import { BaseBehavior } from './base-behavior';
/**
* <zh/> 聚焦元素交互配置项
*
* <en/> Focus element behavior options
*/
export interface FocusElementOptions extends BaseBehaviorOptions {
/**
* <zh/> 是否启用动画以及动画配置
*
* <en/> Whether to enable animation
*/
animation?: ViewportAnimationEffectTiming;
/**
* <zh/> 是否启用聚焦功能
*
* <en/> Whether to enable the function of focusing on the element
* @defaultValue true
*/
enable?: boolean | ((event: IElementEvent) => boolean);
}
/**
* <zh/> 聚焦元素交互行为
*
* <en/> Focus element behavior
* @remarks
* <zh/> 点击元素时,将元素聚焦到视图中心。
*
* <en/> When an element is clicked, the element is focused to the center of the view.
*/
export declare class FocusElement extends BaseBehavior<FocusElementOptions> {
static defaultOptions: Partial<FocusElementOptions>;
constructor(context: RuntimeContext, options: FocusElementOptions);
private bindEvents;
private focus;
private validate;
private unbindEvents;
destroy(): void;
}