Vue TreeList - rowDragging
allowReordering
This property limits row reordering to the UI and does not affect the data source. You should also handle the effects of the drag and drop to the data source in code. If users reorder rows inside a single component, implement the onReorder handler.
For information on drag and drop between components, refer to the group topic.
dragDirection
dragTemplate
Name | Type | Description |
---|---|---|
itemData | any |
The item's data. |
itemElement |
The container of the item being dragged. It is an HTML Element or a jQuery Element when you use jQuery. |
dropFeedbackMode
This property accepts the following values:
"indicate"
Rows do not animate, a blue square appears at the place where the dragged row is going to be placed."push"
Rows move apart with animation, allowing room for the dragged row to be placed. To use this mode, ensure that allowDropInsideItem is disabled.
group
Set this property to identical values for the UI components you want to collect into a single group. This allows users to drag and drop rows between components, but only in the UI. To handle drag and drop in code, implement the onAdd and onRemove handlers. Both these handlers are executed simultaneously when a row is dropped to the target component, but onAdd is executed in the target component, while onRemove is executed in the source component.
onAdd
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
dropInsideItem |
Indicates if the dragged row is dropped inside another row. Available only for the TreeList UI component. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
fromComponent | | |
The instance of the row's source UI component. |
fromData | any |
Custom data associated with the source UI component. |
fromIndex |
The row's original position. If the row is dragged from another UI component, the value is -1. |
|
itemData | any |
The data object of the row being dragged. |
itemElement |
The container of the item being dragged. It is an HTML Element or a jQuery Element when you use jQuery. |
|
toComponent | | |
The instance of the row's target UI component. |
toData | any |
Custom data associated with the target UI component. |
toIndex |
The position in which the row is placed. If the row is dragged away from the UI component, the value is -1. |
onDragChange
Name | Type | Description |
---|---|---|
cancel |
Allows you to cancel the gesture. |
|
component |
The UI component's instance. |
|
dropInsideItem |
Indicates if the dragged row is dropped inside another row. Available only for the TreeList UI component. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
fromComponent | | |
The instance of the row's source UI component. Works only for element drag and drop between components. |
fromData | any |
Custom data associated with the source UI component. Works only for element drag and drop between components. |
fromIndex |
The row's original position. If the row is dragged from another UI component, the value is -1. |
|
itemData | any |
The row's data before the drag operation. |
itemElement |
The container of the item being dragged. It is an HTML Element or a jQuery Element when you use jQuery. |
|
toComponent | | |
The instance of the row's target UI component. Works only for element drag and drop between components. |
toData | any |
Custom data associated with the target UI component. Works only for element drag and drop between components. |
toIndex |
The position in which the row is placed. If the row is dragged away from the UI component, the value is -1. |
onDragEnd
Name | Type | Description |
---|---|---|
cancel |
Allows you to cancel the gesture. |
|
component |
The UI component's instance. |
|
dropInsideItem |
Indicates if the dragged row is dropped inside another row. Available only for the TreeList UI component. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
fromComponent | | |
The instance of the row's source UI component. Works only for element drag and drop between components. |
fromData | any |
Custom data associated with the source UI component. Works only for element drag and drop between components. |
fromIndex |
The row's original position. If the row is dragged from another UI component, the value is -1. |
|
itemData | any |
The row's data before the drag operation. |
itemElement |
The container of the item being dragged. It is an HTML Element or a jQuery Element when you use jQuery. |
|
toComponent | | |
The instance of the row's target UI component. Works only for element drag and drop between components. |
toData | any |
Custom data associated with the target UI component. Works only for element drag and drop between components. |
toIndex |
The position in which a row is placed. If the row is dragged away from the UI component, the value is -1. |
onDragMove
Name | Type | Description |
---|---|---|
cancel |
Allows you to cancel the gesture. |
|
component |
The UI component's instance. |
|
dropInsideItem |
Indicates if the dragged row is dropped inside another row. Available only for the TreeList UI component. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
fromComponent | | |
The instance of the row's source UI component. Works only for element drag and drop between components. |
fromData | any |
Custom data associated with the source UI component. Works only for element drag and drop between components. |
fromIndex |
The row's original position. If the row is dragged from another UI component, the value is -1. |
|
itemData | any |
The row's data before the drag operation. |
itemElement |
The container of the item being dragged. It is an HTML Element or a jQuery Element when you use jQuery. |
|
toComponent | | |
The instance of the row's target UI component. Works only for element drag and drop between components. |
toData | any |
Custom data associated with the target UI component. Works only for element drag and drop between components. |
toIndex |
The position in which the row is placed. If the row is dragged away from the UI component, the value is -1. |
onDragStart
Name | Type | Description |
---|---|---|
cancel |
Allows you to cancel the gesture. |
|
component |
The UI component's instance. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
fromData | any |
Custom data associated with the source UI component. Works only for element drag and drop between components. |
fromIndex |
The row's original position. If the row is dragged from another UI component, the value is -1. |
|
itemData | any |
The row's data before the drag operation. |
itemElement |
The container of the item being dragged. It is an HTML Element or a jQuery Element when you use jQuery. |
onRemove
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
fromComponent | | |
The instance of the row's source UI component. |
fromData | any |
Custom data associated with the source UI component. |
fromIndex |
The row's original position. If the row is dragged from another UI component, the value is -1. |
|
itemData | any |
The data object of the row being dragged. |
itemElement |
The container of the item being dragged. It is an HTML Element or a jQuery Element when you use jQuery. |
|
toComponent | | |
The instance of the row's target UI component. |
toData | any |
Custom data associated with the target UI component. |
toIndex |
The position in which a row is placed. If the row is dragged away from the UI component, the value is -1. |
onReorder
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
dropInsideItem |
Indicates if the dragged row is dropped inside another row. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
fromComponent | | |
The instance of the row's source UI component. |
fromData | any |
Custom data associated with the source UI component. |
fromIndex |
The row's original position. If the row is dragged from another UI component, the value is -1. |
|
itemData | any |
The data object of the row being dragged. |
itemElement |
The container of the item being dragged. It is an HTML Element or a jQuery Element when you use jQuery. |
|
promise |
Assign a Promise to this field to perform an asynchronous operation. |
|
toComponent | | |
The instance of the row's target UI component. |
toData | any |
Custom data associated with the target UI component. |
toIndex |
The position in which a row is placed. If the row is dragged away from the UI component, the value is -1. |
scrollSensitivity
Specifies the distance in pixels from the edge of viewport at which scrolling should start. Applies only if autoScroll is true.
scrollSpeed
Specifies the scrolling speed when dragging a row beyond the viewport. Applies only if autoScroll is true.
If you have technical questions, please create a support ticket in the DevExpress Support Center.