g6/packages/site/docs/apis/behaviors/WIP-TrackCanvas3DOptions.en.md
2023-11-07 21:39:59 +08:00

2.0 KiB

title
TrackCanvas3DOptions

Overview - v5.0.0-beta.21 / Modules / behaviors / TrackCanvas3DOptions

behaviors.TrackCanvas3DOptions

Properties

eventName

Optional eventName: string

The event name to trigger when drag end.

Defined in

packages/g6/src/stdlib/behavior/track-canvas-3d.ts:24


secondaryKey

Optional secondaryKey: string

The assistance secondary key to trigger the behavior. If it is not assigned, triggered only by trigger. You can also assigned it with a key on keyboard e.g. 'shift', to make the behavior triggered only when the key is pressing and trigger is happening.

Defined in

packages/g6/src/stdlib/behavior/track-canvas-3d.ts:20


shouldBegin

Optional shouldBegin: (event: IG6GraphEvent) => boolean

Type declaration

▸ (event): boolean

Whether allow the behavior happen on the current item.

Parameters
Name Type
event IG6GraphEvent
Returns

boolean

Defined in

packages/g6/src/stdlib/behavior/track-canvas-3d.ts:28


trigger

Optional trigger: "drag" | "directionKeys"

The way to tranlate the canvas. 'drag' (default) means dragged by mouse, 'directionKeys' means the up/down/left/right key on keyBoard.

Defined in

packages/g6/src/stdlib/behavior/track-canvas-3d.ts:13