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

3.8 KiB

title
DragComboOptions

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

behaviors.DragComboOptions

Properties

delegateStyle

Optional delegateStyle: Object

The drawing properties when the nodes are dragged. Only used when enableDelegate is true.

Index signature

▪ [key: string]: unknown

Type declaration

Name Type
fill? string
fillOpacity? number
lineDash? [number, number]
lineWidth? number
stroke? string
strokeOpacity? number

Defined in

packages/g6/src/stdlib/behavior/drag-combo.ts:27


enableDelegate

Optional enableDelegate: boolean

Whether to use a virtual rect moved with the dragging mouse instead of the node. Defaults to false.

Defined in

packages/g6/src/stdlib/behavior/drag-combo.ts:22


enableTransient

Optional enableTransient: boolean

Whether to draw dragging nodes in transient layer. Ignored when enableDelegate is true. Defaults to true.

Defined in

packages/g6/src/stdlib/behavior/drag-combo.ts:17


eventName

Optional eventName: string

The event name to trigger when drag end.

Defined in

packages/g6/src/stdlib/behavior/drag-combo.ts:55


hideRelatedEdges

Optional hideRelatedEdges: boolean

Whether to hide the related edges to avoid calculation while dragging nodes. Ignored when enableTransient or enableDelegate is true. Defaults to false.

Defined in

packages/g6/src/stdlib/behavior/drag-combo.ts:46


selectedState

Optional selectedState: string

The state name to be considered as "selected". Defaults to "selected".

Defined in

packages/g6/src/stdlib/behavior/drag-combo.ts:51


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/drag-combo.ts:63


throttle

Optional throttle: number

The time in milliseconds to throttle moving. Useful to avoid the frequent calculation. Defaults to 0.

Defined in

packages/g6/src/stdlib/behavior/drag-combo.ts:40


updateComboStructure

Optional updateComboStructure: boolean

Whether change the combo hierarchy structure or only change size.

Defined in

packages/g6/src/stdlib/behavior/drag-combo.ts:59