API REFERENCE
SyGridRowDragSessionReport
Fields, allowed values, and APIs that use SyGridRowDragSessionReport.
Type definition
A question mark (?) marks an optional field; readonly marks a value you should not change directly. A union (|) accepts one of the listed forms. Functions are callbacks that Grid invokes at the relevant point.
export interface SyGridRowDragSessionReport {
readonly enabled: boolean;
readonly loaded: boolean;
readonly gesture: {
readonly phase: 'idle' | 'pending' | 'armed' | 'yielded';
readonly pointerType: 'mouse' | 'pen' | 'touch' | null;
readonly travelled: number;
readonly yieldReason: string | null;
readonly [extra: string]: unknown;
} | null;
readonly session: {
readonly dragId: string;
readonly mode: 'managed' | 'unmanaged';
readonly phase: 'dragging' | 'ended';
readonly item: SyGridRowDragItem;
readonly target: SyGridRowDragTarget | null;
readonly [extra: string]: unknown;
} | null;
readonly report: unknown;
readonly events: ReadonlyArray<unknown>;
readonly residue: ReadonlyArray<string>;
readonly keyboard: { readonly grabbed: boolean; readonly originIndex: number; readonly currentIndex: number } | null;
readonly zones: ReadonlyArray<string>;
readonly lastAutoScroll: unknown;
}APIs using this type
- getRowDragSession
Reads current row drag session progress.