Home Reference Source
public class | source

Mirror

Extends:

* → Mirror

Mirror plugin which controls the mirror positioning while dragging

Constructor Summary

Public Constructor
public

constructor(draggable: Draggable)

Mirror constructor.

Member Summary

Public Members
public

initialScrollOffset: {"x": *, "y": *}

Initial scroll offset for touch devices because the mirror is positioned fixed

public
public
public
public

Mirror options

public

scrollOffset: {"x": *, "y": *}

Scroll offset for touch devices because the mirror is positioned fixed

Method Summary

Public Methods
public
public
public
public

attach()

Attaches plugins event listeners

public

detach()

Detaches plugins event listeners

public

Returns options passed through draggable

Private Methods
private

Mirror created handler

private

Mirror move handler

Public Constructors

public constructor(draggable: Draggable) source

Mirror constructor.

Params:

NameTypeAttributeDescription
draggable Draggable

Draggable instance

Public Members

public initialScrollOffset: {"x": *, "y": *} source

Initial scroll offset for touch devices because the mirror is positioned fixed

Properties:

NameTypeAttributeDescription
scrollOffset Object
scrollOffset.x Number
scrollOffset.y Number

public initialX: * source

public initialY: * source

public mirrorOffset: * source

public options: Object source

Mirror options

Properties:

NameTypeAttributeDescription
options Object
options.constrainDimensions Boolean
options.xAxis Boolean
options.yAxis Boolean
options.cursorOffsetX Number | null
options.cursorOffsetY Number | null

public scrollOffset: {"x": *, "y": *} source

Scroll offset for touch devices because the mirror is positioned fixed

Properties:

NameTypeAttributeDescription
scrollOffset Object
scrollOffset.x Number
scrollOffset.y Number

Public Methods

public [onDragStart]() source

public [onDragStop]() source

public [onScroll]() source

public attach() source

Attaches plugins event listeners

public detach() source

Detaches plugins event listeners

public getOptions(): Object source

Returns options passed through draggable

Return:

Object

Private Methods

private [onMirrorCreated](mirrorEvent: MirrorCreatedEvent): Promise source

Mirror created handler

Params:

NameTypeAttributeDescription
mirrorEvent MirrorCreatedEvent

Return:

Promise

private [onMirrorMove](mirrorEvent: MirrorMoveEvent): Promise source

Mirror move handler

Params:

NameTypeAttributeDescription
mirrorEvent MirrorMoveEvent

Return:

Promise