UNPKG

2.31 kBTypeScriptView Raw
1// Type definitions for ag-grid v18.1.2
2// Project: http://www.ag-grid.com/
3// Definitions by: Niall Crosby <https://github.com/ag-grid/>
4/** Adds drag listening onto an element. In ag-Grid this is used twice, first is resizing columns,
5 * second is moving the columns and column groups around (ie the 'drag' part of Drag and Drop. */
6export declare class DragService {
7 private loggerFactory;
8 private eventService;
9 private gridOptionsWrapper;
10 private columnApi;
11 private gridApi;
12 private currentDragParams;
13 private dragging;
14 private mouseEventLastTime;
15 private mouseStartEvent;
16 private touchLastTime;
17 private touchStart;
18 private onMouseUpListener;
19 private onMouseMoveListener;
20 private onTouchEndListener;
21 private onTouchMoveListener;
22 private logger;
23 private dragEndFunctions;
24 private dragSources;
25 private init();
26 private destroy();
27 private removeListener(dragSourceAndListener);
28 removeDragSource(params: DragListenerParams): void;
29 private setNoSelectToBody(noSelect);
30 addDragSource(params: DragListenerParams, includeTouch?: boolean): void;
31 private onTouchStart(params, touchEvent);
32 private onMouseDown(params, mouseEvent);
33 private isEventNearStartEvent(currentEvent, startEvent);
34 private getFirstActiveTouch(touchList);
35 private onCommonMove(currentEvent, startEvent);
36 private onTouchMove(touchEvent);
37 private onMouseMove(mouseEvent);
38 onTouchUp(touchEvent: TouchEvent): void;
39 onMouseUp(mouseEvent: MouseEvent): void;
40 onUpCommon(eventOrTouch: MouseEvent | Touch): void;
41}
42export interface DragListenerParams {
43 /** After how many pixels of dragging should the drag operation start. Default is 4px. */
44 dragStartPixels?: number;
45 /** Dom element to add the drag handling to */
46 eElement: HTMLElement;
47 /** Some places may wish to ignore certain events, eg range selection ignores shift clicks */
48 skipMouseEvent?: (mouseEvent: MouseEvent) => boolean;
49 /** Callback for drag starting */
50 onDragStart: (mouseEvent: MouseEvent | Touch) => void;
51 /** Callback for drag stopping */
52 onDragStop: (mouseEvent: MouseEvent | Touch) => void;
53 /** Callback for mouse move while dragging */
54 onDragging: (mouseEvent: MouseEvent | Touch) => void;
55}