mxDragSource | mxGraph Typescript Declarations

Hierarchy

mxDragSource

Index

Constructors

constructor

Properties

Constructors

constructor

new mxDragSource(element: HTMLElement, dropHandler?: Function): mxDragSource

- Defined in util/mxDragSource.d.ts:12
Constructs a new drag source for the given element.

Parameters
- element: HTMLElement
- Optional dropHandler: Function
Returns mxDragSource

Properties

autoscroll

autoscroll: boolean

Specifies if the graph should scroll automatically. Default is true.

checkEventSource

checkEventSource: boolean

Whether the event source should be checked in {@link graphContainerEvent}. Default is true.

currentDropTarget

currentDropTarget: mxCell

Holds the current drop target under the mouse.

currentGraph

currentGraph: mxGraph

Reference to the mxGraph that is the current drop target.

currentGuide

currentGuide: mxGuide

Holds an mxGuide for the currentGraph if {@link dragPreview} is not null.

currentHighlight

currentHighlight: mxCellHighlight

Holds an mxGuide for the currentGraph if {@link dragPreview} is not null.

note: wrong doc

currentPoint

currentPoint: mxPoint

Holds the current drop location.

dragElement

dragElement: HTMLElement

Holds the DOM node that is used to represent the drag preview. If this is null then the source element will be cloned and used for the drag preview.

dragElementOpacity

dragElementOpacity: number

Opacity of the drag element in %. Default is 70.

dragElementZIndex

dragElementZIndex: number

ZIndex for the drag element. Default is 100.

dragOffset

dragOffset: mxPoint

mxPoint that specifies the offset of the dragElement. Default is null.

dropHandler

dropHandler: Function

Holds the DOM node that is used to represent the drag preview. If this is null then the source element will be cloned and used for the drag preview.

element

element: HTMLElement

Reference to the DOM node which was made draggable.

enabled

enabled: boolean

Specifies if this drag source is enabled. Default is true.

gridEnabled

gridEnabled: boolean

Specifies if the grid should be allowed. Default is true.

guidesEnabled

guidesEnabled: boolean

Specifies if mxGuide should be enabled. Default is true.

highlightDropTargets

highlightDropTargets: boolean

Specifies if drop targets should be highlighted. Default is true.

previewElement

previewElement: mxRectangle

Optional mxRectangle that specifies the unscaled size of the preview.

Methods

createDragElement

createDragElement(evt: Event): Node

- Defined in util/mxDragSource.d.ts:161
Creates and returns a clone of the {@link dragElementPrototype} or the element if the former is not defined.

Parameters
- evt: Event
Returns Node

createPreviewElement

createPreviewElement(graph: mxGraph): HTMLElement

- Defined in util/mxDragSource.d.ts:167
Creates and returns an element which can be used as a preview in the given graph.

Parameters
- graph: mxGraph
Returns HTMLElement

dragEnter

dragEnter(graph: mxGraph, evt: Event): void

- Defined in util/mxDragSource.d.ts:247
Actives the given graph as a drop target.

Parameters
- graph: mxGraph
- evt: Event
Returns void

dragExit

dragExit(graph: mxGraph, evt: Event): void

- Defined in util/mxDragSource.d.ts:252
Deactivates the given graph as a drop target.

Parameters
- graph: mxGraph
- evt: Event
Returns void

dragOver

dragOver(graph: mxGraph, evt: Event): void

- Defined in util/mxDragSource.d.ts:258
Implements autoscroll, updates the currentPoint, highlights any drop targets and updates the preview.

Parameters
- graph: mxGraph
- evt: Event
Returns void

drop

drop(graph: mxGraph, evt: Event, dropTarget: mxCell, x: number, y: number): void

- Defined in util/mxDragSource.d.ts:264
Returns the drop target for the given graph and coordinates. This implementation uses mxGraph.getCellAt.

Parameters
- graph: mxGraph
- evt: Event
- dropTarget: mxCell
- x: number
- y: number
Returns void

getDropTarget

getDropTarget(graph: mxGraph, x: number, y: number, evt: PointerEvent): mxCell

- Defined in util/mxDragSource.d.ts:155
Returns the drop target for the given graph and coordinates. This implementation uses mxGraph.getCellAt.

Parameters
- graph: mxGraph
- x: number
- y: number
- evt: PointerEvent
Returns mxCell

getElementForEvent

getElementForEvent(evt: Event): Element

- Defined in util/mxDragSource.d.ts:219
Returns the topmost element under the given event.

Parameters
- evt: Event
Returns Element

getGraphForEvent

getGraphForEvent(evt: MouseEvent): mxGraph

- Defined in util/mxDragSource.d.ts:149
Returns the graph for the given mouse event. This implementation returns null.

Parameters
- evt: MouseEvent
Returns mxGraph

graphContainsEvent

graphContainsEvent(graph: mxGraph, evt: Event): boolean

- Defined in util/mxDragSource.d.ts:224
Returns true if the given graph contains the given event.

Parameters
- graph: mxGraph
- evt: Event
Returns boolean

isActive

isActive(): boolean

- Defined in util/mxDragSource.d.ts:172
Returns true if this drag source is active.

Returns boolean

isEnabled

isEnabled(): boolean

- Defined in util/mxDragSource.d.ts:118
Returns enabled.

Returns boolean

isGridEnabled

isGridEnabled(): boolean

- Defined in util/mxDragSource.d.ts:138
Returns gridEnabled.

Returns boolean

isGuidesEnabled

isGuidesEnabled(): boolean

- Defined in util/mxDragSource.d.ts:128
Returns guidesEnabled.

Returns boolean

mouseDown

mouseDown(evt: mxMouseEvent): void

- Defined in util/mxDragSource.d.ts:199
Returns the drop target for the given graph and coordinates. This implementation uses mxGraph.getCellAt.

To ignore popup menu events for a drag source, this function can be overridden as follows.
example
```
var mouseDown = dragSource.mouseDown;

dragSource.mouseDown(evt)
{
  if (!mxEvent.isPopupTrigger(evt))
  {
    mouseDown.apply(this, arguments);
  }
};
```
Parameters
- evt: mxMouseEvent
Returns void

mouseMove

mouseMove(evt: MouseEvent): void

- Defined in util/mxDragSource.d.ts:231
Gets the graph for the given event using getGraphForEvent, updates the currentGraph, calling dragEnter and dragExit on the new and old graph, respectively, and invokes dragOver if currentGraph is not null.

Parameters
- evt: MouseEvent
Returns void

mouseUp

mouseUp(evt: MouseEvent): void

- Defined in util/mxDragSource.d.ts:237
Processes the mouse up event and invokes drop, dragExit and stopDrag as required.

Parameters
- evt: MouseEvent
Returns void

removeDragElement

removeDragElement(): void

- Defined in util/mxDragSource.d.ts:214
Removes and destroys the dragElement.

Returns void

removeListeners

removeListeners(): void

- Defined in util/mxDragSource.d.ts:242
Actives the given graph as a drop target.

Returns void

reset

reset(): void

- Defined in util/mxDragSource.d.ts:177
Stops and removes everything and restores the state of the object.

Returns void

setEnabled

setEnabled(value: boolean): void

- Defined in util/mxDragSource.d.ts:123
Sets enabled.

Parameters
- value: boolean
Returns void

setGridEnabled

setGridEnabled(value: boolean): void

- Defined in util/mxDragSource.d.ts:143
Sets gridEnabled.

Parameters
- value: boolean
Returns void

setGuidesEnabled

setGuidesEnabled(value: boolean): void

- Defined in util/mxDragSource.d.ts:133
Sets guidesEnabled.

Parameters
- value: boolean
Returns void

startDrag

startDrag(evt: mxMouseEvent): void

- Defined in util/mxDragSource.d.ts:204
Creates the dragElement using createDragElement.

Parameters
- evt: mxMouseEvent
Returns void

stopDrag

stopDrag(): void

- Defined in util/mxDragSource.d.ts:209
Invokes removeDragElement.

Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

element: HTMLElement

Optional dropHandler: Function

Returns mxDragSource

Properties

autoscroll

checkEventSource

currentDropTarget

currentGraph

currentGuide

currentHighlight

currentPoint

dragElement

dragElementOpacity

dragElementZIndex

dragOffset

dropHandler

element

enabled

gridEnabled

guidesEnabled

highlightDropTargets

previewElement

Methods

createDragElement

Parameters

evt: Event

Returns Node

createPreviewElement

Parameters

graph: mxGraph

Returns HTMLElement

dragEnter

Parameters

graph: mxGraph

evt: Event

Returns void

dragExit

Parameters

graph: mxGraph

evt: Event

Returns void

dragOver

Parameters

graph: mxGraph

evt: Event

Returns void

drop

Parameters

graph: mxGraph

evt: Event

dropTarget: mxCell

x: number

y: number

Returns void

getDropTarget

Parameters

graph: mxGraph

x: number

y: number

evt: PointerEvent

Returns mxCell

getElementForEvent

Parameters

evt: Event

Returns Element

getGraphForEvent

Parameters

evt: MouseEvent

Returns mxGraph

graphContainsEvent

Parameters

graph: mxGraph