DragRef — Angular | Spec-Zone.ru

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

API

class DragRef<T = any> {
  constructor(element: any, _config: DragRefConfig, _document: Document, _ngZone: NgZone, _viewportRuler: ViewportRuler, _dragDropRegistry: DragDropRegistry, _renderer: Renderer2): DragRef<T>;
  lockAxis: "x" | "y" | null;
  dragStartDelay: number | { touch: number; mouse: number; };
  previewClass: string | string[] | undefined;
  scale: number;
   get disabled(): boolean;
  readonly beforeStarted: any;
  readonly started: any;
  readonly released: any;
  readonly ended: any;
  readonly entered: any;
  readonly exited: any;
  readonly dropped: any;
  readonly moved: Observable<{ source: DragRef<any>; pointerPosition: { x: number; y: number; }; event: MouseEvent | TouchEvent; distance: Point; delta: { x: 0 | 1 | -1; y: 0 | 1 | -1; }; }>;
  data: T;
  constrainPosition?: DragConstrainPosition | undefined;
  getPlaceholderElement(): HTMLElement;
  getRootElement(): HTMLElement;
  getVisibleElement(): HTMLElement;
  withHandles(handles: any[]): this;
  withPreviewTemplate(template: DragPreviewTemplate<any> | null): this;
  withPlaceholderTemplate(template: DragHelperTemplate<any> | null): this;
  withRootElement(rootElement: any): this;
  withBoundaryElement(boundaryElement: any): this;
  withParent(parent: DragRef<unknown> | null): this;
  dispose(): void;
  isDragging(): boolean;
  reset(): void;
  resetToBoundary(): void;
  disableHandle(handle: HTMLElement): void;
  enableHandle(handle: HTMLElement): void;
  withDirection(direction: Direction): this;
  getFreeDragPosition(): Readonly<Point>;
  setFreeDragPosition(value: Point): this;
  withPreviewContainer(value: any): this;
}

constructor

DragRef<T>

@paramelementany

@param_configDragRefConfig

@param_documentDocument

@param_ngZoneNgZone

@param_viewportRulerViewportRuler

@param_dragDropRegistryDragDropRegistry

@param_rendererRenderer2

@returnsDragRef<T>

lockAxis

"x" | "y" | null

Ось, вдоль которой заблокировано перетаскивание.

dragStartDelay

number | { touch: number; mouse: number; }

Время в миллисекундах, которое нужно подождать после нажатия указателем пользователя, прежде чем начать перетаскивание элемента.

previewClass

string | string[] | undefined

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

scale

number

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

disabled

boolean

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

disabled

boolean

beforeStarted

any

Выдаёт событие во время подготовки последовательности перетаскивания.

started

any

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

released

any

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

ended

any

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

entered

any

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

exited

any

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

dropped

any

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

moved

Observable<{ source: DragRef<any>; pointerPosition: { x: number; y: number; }; event: MouseEvent | TouchEvent; distance: Point; delta: { x: 0 | 1 | -1; y: 0 | 1 | -1; }; }>

Выдаёт события во время перетаскивания элемента пользователем. Используйте с осторожностью: это событие срабатывает для каждого пикселя, на который пользователь переместил элемент.

data

T

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

constrainPosition

DragConstrainPosition | undefined

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

getPlaceholderElement

HTMLElement

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

@returnsHTMLElement

getRootElement

HTMLElement

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

@returnsHTMLElement

getVisibleElement

HTMLElement

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

@returnsHTMLElement

withHandles

this

Регистрирует маркеры, с помощью которых можно перетаскивать элемент.

@paramhandlesany[]

@returnsthis

withPreviewTemplate

this

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

@paramtemplateDragPreviewTemplate<any> | null

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

@returnsthis

withPlaceholderTemplate

this

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

@paramtemplateDragHelperTemplate<any> | null

Шаблон, из которого будет создан заполнитель.

@returnsthis

withRootElement

this

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

@paramrootElementany

@returnsthis

withBoundaryElement

this

Элемент, границами которого будет ограничено положение перетаскиваемого элемента.

@paramboundaryElementany

@returnsthis

withParent

this

Задаёт родительскую ссылку, внутри которой находится эта ссылка.

@paramparentDragRef<unknown> | null

@returnsthis

dispose

void

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

@returnsvoid

isDragging

boolean

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

@returnsboolean

reset

void

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

@returnsvoid

resetToBoundary

void

Перемещает перетаскиваемый элемент к краю граничного элемента.

@returnsvoid

disableHandle

void

Отключает маркер. Пока маркер отключён, он перехватывает и прерывает перетаскивание.

@paramhandleHTMLElement

Элемент-маркер, который нужно отключить.

@returnsvoid

enableHandle

void

Включает маркер, если он был отключён.

@paramhandleHTMLElement

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

@returnsvoid

withDirection

this

Задаёт направление макета перетаскиваемого элемента.

@paramdirectionDirection

@returnsthis

getFreeDragPosition

Readonly<Point>

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

@returnsReadonly<Point>

setFreeDragPosition

this

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

@paramvaluePoint

Новое положение, которое нужно задать.

@returnsthis

withPreviewContainer

this

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

@paramvalueany

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

@returnsthis