Interface RowDragOptionsIf

Options of row dragging (TableOptionsIf.rowDragOptions). Rows get a drag handle in every column with ColumnDefIf.rowDrag (or TableFactory.createTableModel({ rows, rowDrag: true })).

Example

const tableOptions: TableOptionsIf = {
  ...new TableOptions(),
  rowDragOptions: { managed: false, autoScrollMaxSpeedInPx: 40 }   // events only – the app moves the rows
};

Since

1.1.95

Hierarchy

  • RowDragOptionsIf

Implemented by

Properties

autoScrollMaxSpeedInPx autoScrollZoneInPx dragThresholdInPx ghostText? managed multiRow treeDropInside

Properties

autoScrollMaxSpeedInPx

autoScrollMaxSpeedInPx: number

Maximum auto-scroll speed in px per animation frame (default 24).

autoScrollZoneInPx

autoScrollZoneInPx: number

Height in px of the zone at the top and bottom edge of the body that scrolls automatically (default 40).

dragThresholdInPx

dragThresholdInPx: number

Distance in px the pointer has to move before a drag starts (default 4) – below it is a click on the handle.

Optional ghostText

ghostText?: ((rows) => string)

Type declaration

    • (rows): string

    • Text of the drag ghost. Default: the text of the handle cell of the first row, "(+2)" for two more rows. The text is shown as text (never as HTML).

      Parameters

      • rows: any[]

      Returns string

managed

managed: boolean

true (default): the table moves the rows itself (AreaModelIf.moveRows) – only while the table is neither sorted (a column with sort state asc/desc) nor filtered. false: the table only reports the drag (onRowDragStart/Move/End), the app moves the rows (e.g. after the server confirmed), always allowed.

multiRow

multiRow: boolean

true (default): grabbing a selected row drags all rows with a selection (their order stays).

treeDropInside

treeDropInside: boolean

true (default): tree – dropping on the middle of a row makes the rows its children.

Settings

Member Visibility

Theme

On This Page