DropListRef — Angular

Ссылка на список для перетаскивания. Используется для управления контейнером или его удаления.

API

class DropListRef<T = any> {
  constructor(element: any, _dragDropRegistry: DragDropRegistry, _document: any, _ngZone: NgZone, _viewportRuler: ViewportRuler): DropListRef<T>;
  element: any;
  disabled: boolean;
  sortingDisabled: boolean;
  lockAxis: "x" | "y" | null;
  autoScrollDisabled: boolean;
  autoScrollStep: number;
  hasAnchor: boolean;
  enterPredicate: (drag: DragRef<any>, drop: DropListRef<any>) => boolean;
  sortPredicate: (index: number, drag: DragRef<any>, drop: DropListRef<any>) => boolean;
  readonly beforeStarted: any;
  readonly entered: any;
  readonly exited: any;
  readonly dropped: any;
  readonly sorted: any;
  readonly receivingStarted: any;
  readonly receivingStopped: any;
  data: T;
  dispose(): void;
  isDragging(): boolean;
  start(): void;
  enter(item: DragRef<any>, pointerX: number, pointerY: number, index?: number | undefined): void;
  exit(item: DragRef<any>): void;
  drop(item: DragRef<any>, currentIndex: number, previousIndex: number, previousContainer: DropListRef<any>, isPointerOverContainer: boolean, distance: Point, dropPoint: Point, event: MouseEvent | TouchEvent): void;
  withItems(items: DragRef<any>[]): this;
  withDirection(direction: Direction): this;
  connectedTo(connectedTo: DropListRef<any>[]): this;
  withOrientation(orientation: DropListOrientation): this;
  withScrollableParents(elements: HTMLElement[]): this;
  withElementContainer(container: HTMLElement): this;
  getScrollableParents(): readonly HTMLElement[];
  getItemIndex(item: DragRef<any>): number;
  getItemAtIndex(index: number): DragRef<any> | null;
  isReceiving(): boolean;
}

constructor

DropListRef<T>

@paramelementany

@param_dragDropRegistryDragDropRegistry

@param_documentany

@param_ngZoneNgZone

@param_viewportRulerViewportRuler

@returnsDropListRef<T>

element

any

Элемент, к которому привязан список для перетаскивания.

disabled

boolean

Отключена ли возможность начинать перетаскивание из этого контейнера.

sortingDisabled

boolean

Отключена ли сортировка элементов в списке.

lockAxis

"x" | "y" | null

Блокирует перемещение перетаскиваемых элементов внутри контейнера вдоль указанной оси.

autoScrollDisabled

boolean

Отключена ли автоматическая прокрутка представления, когда указатель пользователя приближается к краям.

autoScrollStep

number

Количество пикселей прокрутки за каждый кадр при автоматической прокрутке элемента.

hasAnchor

boolean

Должны ли элементы списка оставлять узел-якорь при перемещении из исходного контейнера.

enterPredicate

(drag: DragRef<any>, drop: DropListRef<any>) => boolean

Функция, определяющая, разрешено ли переместить элемент в контейнер для перетаскивания.

sortPredicate

(index: number, drag: DragRef<any>, drop: DropListRef<any>) => boolean

Функция, определяющая, можно ли поместить элемент на определённую позицию при сортировке.

beforeStarted

any

Срабатывает непосредственно перед началом перетаскивания.

entered

any

Срабатывает, когда пользователь перемещает новый перетаскиваемый элемент в этот контейнер.

exited

any

Срабатывает, когда пользователь удаляет элемент из контейнера, перетаскивая его в другой контейнер.

dropped

any

Срабатывает, когда пользователь отпускает элемент внутри контейнера.

sorted

any

Срабатывает, когда пользователь меняет элементы местами во время перетаскивания.

receivingStarted

any

Срабатывает, когда начинается перетаскивание в списке, связанном с текущим.

receivingStopped

any

Срабатывает, когда прекращается перетаскивание из списка, связанного с текущим.

data

T

Произвольные данные, которые можно прикрепить к списку для перетаскивания.

dispose

void

Удаляет функциональность перетаскивания из элемента DOM.

@returnsvoid

isDragging

boolean

Выполняется ли сейчас перетаскивание элемента из этого списка.

@returnsboolean

start

void

Начинает перетаскивание элемента.

@returnsvoid

enter

void

Пытается переместить элемент в контейнер.

@paramitemDragRef<any>

Элемент, перемещённый в контейнер.

@parampointerXnumber

Положение элемента вдоль оси X.

@parampointerYnumber

Положение элемента вдоль оси Y.

@paramindexnumber | undefined

Индекс, на который был помещён элемент. Если не указан, контейнер попытается определить его автоматически.

@returnsvoid

exit

void

Удаляет элемент из контейнера после того, как пользователь перетащил его в другой контейнер.

@paramitemDragRef<any>

Перетащенный элемент.

@returnsvoid

drop

void

Помещает элемент в этот контейнер.

@paramitemDragRef<any>

Элемент, помещаемый в контейнер.

@paramcurrentIndexnumber

Индекс, на который следует вставить элемент.

@parampreviousIndexnumber

Индекс элемента на момент начала перетаскивания.

@parampreviousContainerDropListRef<any>

Контейнер, из которого был перетащен элемент.

@paramisPointerOverContainerboolean

Находился ли указатель пользователя над контейнером в момент отпускания элемента.

@paramdistancePoint

Расстояние, на которое пользователь перетащил элемент с начала перетаскивания.

@paramdropPointPoint

@parameventMouseEvent | TouchEvent

Событие, вызвавшее отпускание элемента.

@returnsvoid

withItems

this

Задаёт перетаскиваемые элементы, входящие в этот список.

@paramitemsDragRef<any>[]

Элементы, входящие в этот список.

@returnsthis

withDirection

this

Задаёт направление размещения списка для перетаскивания.

@paramdirectionDirection

@returnsthis

connectedTo

this

Задаёт контейнеры, связанные с этим контейнером. Если связаны два или более контейнера, пользователь сможет перемещать элементы между ними.

@paramconnectedToDropListRef<any>[]

Другие контейнеры, с которыми следует связать текущие контейнеры.

@returnsthis

withOrientation

this

Задаёт ориентацию контейнера.

@paramorientationDropListOrientation

Новая ориентация контейнера.

@returnsthis

withScrollableParents

this

Задаёт родительские элементы, которые можно прокручивать во время перетаскивания.

@paramelementsHTMLElement[]

Элементы, которые можно прокручивать.

@returnsthis

withElementContainer

this

Настраивает список для перетаскивания так, чтобы в качестве контейнера для перетаскиваемых элементов использовался другой элемент. Это полезно, когда у вас нет полного контроля над DOM-структурой, обеспечивающей перетаскивание. Обратите внимание, что альтернативный контейнер должен быть потомком списка для перетаскивания.

@paramcontainerHTMLElement

Новый элемент-контейнер.

@returnsthis

getScrollableParents

readonly HTMLElement[]

Возвращает прокручиваемые родительские элементы, зарегистрированные для этого контейнера перетаскивания.

@returnsreadonly HTMLElement[]

getItemIndex

number

Определяет индекс элемента в контейнере.

@paramitemDragRef<any>

Элемент, индекс которого нужно определить.

@returnsnumber

getItemAtIndex

DragRef<any> | null

Возвращает элемент по указанному индексу.

@paramindexnumber

Индекс элемента, который нужно получить.

@returnsDragRef<any> | null

isReceiving

boolean

Может ли список принять элемент, который сейчас перетаскивается внутри связанного списка для перетаскивания.

@returnsboolean