An ItemDropInputMode<T> specialized to the drag and drop of IPorts.
Remarks
Examples
PortDropInputMode is installed as child mode of a GraphEditorInputMode and can be retrieved from the portDropInputMode property.const portDropInputMode = mode.portDropInputModeType Details
- yfiles module
- view-editor
- yfiles-umd modules
- view-editor, view-table, view
- Legacy UMD name
- yfiles.input.PortDropInputMode
See Also
Constructors
Constructs a new instance of class DropInputMode for the expected data type.
Remarks
Parameters
A map of options to pass to the method.
- expectedType - string
- isValidPortOwnerPredicate - function(IPortOwner, IPort):boolean
The callback for testing whether an existing port owner in the graph can be used as owner for the currently dragged port. This option sets the isValidPortOwnerPredicate property on the created object.
Signature Details
function(arg1: IPortOwner, arg2: IPort) : booleanEncapsulates a method that has two parameters and returns a value of the type specified by theTResultparameter.Parameters
- arg1 - IPortOwner
- The first parameter of the method that this delegate encapsulates.
- arg2 - IPort
- The second parameter of the method that this delegate encapsulates.
Returns
- boolean
- The return value of the method that this delegate encapsulates.
- useBestMatchingParameter - boolean
A value indicating whether the default implementation of getNewPortLocationModelParameter should directly use the parameter stored in the dragged item or whether the current drop location should be also taken into account. This option sets the useBestMatchingParameter property on the created object.
- showPreview - boolean
Whether a preview of the dragged element is displayed during the drag This option sets the showPreview property on the created object.
- snappingEnabled - boolean
Whether dragged items are snapped. This option sets the snappingEnabled property on the created object.
- disableSnappingRecognizer - function(Object, EventArgs):boolean
The event recognizer that determines whether to disable snapping temporarily. This option sets the disableSnappingRecognizer property on the created object.
Signature Details
function(eventSource: any, evt: EventArgs) : booleanA callback that recognizes events.Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
- highlightDropTarget - boolean
Whether the drop target is highlighted. This option sets the highlightDropTarget property on the created object.
- snapContext - SnapContext
The snapContext which is used to snap the dragged element during the drag. This option sets the snapContext property on the created object.
- dropTarget - IModelItem
The drop target at snappedMousePosition This option sets the dropTarget property on the created object.
- itemCreator - function(IInputModeContext, IGraph, Object, IModelItem, Point):IPort
The callback for item creation. This option sets the itemCreator property on the created object.
Signature Details
function(context: IInputModeContext, graph: IGraph, dropData: any, dropTarget: IModelItem, dropLocation: Point) : IPortCreates a copy of the dragged item in graph at the specified location.Parameters
- context - IInputModeContext
- The context for which the item should be created.
- graph - IGraph
- The
in which to create the item. - dropData - any
- The data containg the item that was dragged and should therefore be created.
- dropTarget - IModelItem
- The
on which the item is dropped. - dropLocation - Point
- The location the item should be created.
Returns
- IPort
- The item that has been created, or
nullif no item should be created.
- priority - number
- exclusive - boolean
A value indicating whether this mode will be the only one running when it has the mutex. This option sets the exclusive property on the created object.
- enabled - boolean
The enabled state of this input mode. This option sets the enabled property on the created object.
- dragDropEffect - DragDropEffects
The DragDropEffects that will be used for drags on the canvas. This option sets the dragDropEffect property on the created object.
- validDropHitTestable - IHitTestable
The IHitTestable that determines whether the given location is a valid drop location. This option sets the validDropHitTestable property on the created object.
- captureMouseInputDuringDrag - boolean
A value indicating whether to capture mouse input during drag operations. This option sets the captureMouseInputDuringDrag property on the created object.
Constructs a new instance of class DropInputMode for the expected data type.
Remarks
Parameters
A map of options to pass to the method.
- expectedType - string[]
- isValidPortOwnerPredicate - function(IPortOwner, IPort):boolean
The callback for testing whether an existing port owner in the graph can be used as owner for the currently dragged port. This option sets the isValidPortOwnerPredicate property on the created object.
Signature Details
function(arg1: IPortOwner, arg2: IPort) : booleanEncapsulates a method that has two parameters and returns a value of the type specified by theTResultparameter.Parameters
- arg1 - IPortOwner
- The first parameter of the method that this delegate encapsulates.
- arg2 - IPort
- The second parameter of the method that this delegate encapsulates.
Returns
- boolean
- The return value of the method that this delegate encapsulates.
- useBestMatchingParameter - boolean
A value indicating whether the default implementation of getNewPortLocationModelParameter should directly use the parameter stored in the dragged item or whether the current drop location should be also taken into account. This option sets the useBestMatchingParameter property on the created object.
- showPreview - boolean
Whether a preview of the dragged element is displayed during the drag This option sets the showPreview property on the created object.
- snappingEnabled - boolean
Whether dragged items are snapped. This option sets the snappingEnabled property on the created object.
- disableSnappingRecognizer - function(Object, EventArgs):boolean
The event recognizer that determines whether to disable snapping temporarily. This option sets the disableSnappingRecognizer property on the created object.
Signature Details
function(eventSource: any, evt: EventArgs) : booleanA callback that recognizes events.Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
- highlightDropTarget - boolean
Whether the drop target is highlighted. This option sets the highlightDropTarget property on the created object.
- snapContext - SnapContext
The snapContext which is used to snap the dragged element during the drag. This option sets the snapContext property on the created object.
- dropTarget - IModelItem
The drop target at snappedMousePosition This option sets the dropTarget property on the created object.
- itemCreator - function(IInputModeContext, IGraph, Object, IModelItem, Point):IPort
The callback for item creation. This option sets the itemCreator property on the created object.
Signature Details
function(context: IInputModeContext, graph: IGraph, dropData: any, dropTarget: IModelItem, dropLocation: Point) : IPortCreates a copy of the dragged item in graph at the specified location.Parameters
- context - IInputModeContext
- The context for which the item should be created.
- graph - IGraph
- The
in which to create the item. - dropData - any
- The data containg the item that was dragged and should therefore be created.
- dropTarget - IModelItem
- The
on which the item is dropped. - dropLocation - Point
- The location the item should be created.
Returns
- IPort
- The item that has been created, or
nullif no item should be created.
- priority - number
- exclusive - boolean
A value indicating whether this mode will be the only one running when it has the mutex. This option sets the exclusive property on the created object.
- enabled - boolean
The enabled state of this input mode. This option sets the enabled property on the created object.
- dragDropEffect - DragDropEffects
The DragDropEffects that will be used for drags on the canvas. This option sets the dragDropEffect property on the created object.
- validDropHitTestable - IHitTestable
The IHitTestable that determines whether the given location is a valid drop location. This option sets the validDropHitTestable property on the created object.
- captureMouseInputDuringDrag - boolean
A value indicating whether to capture mouse input during drag operations. This option sets the captureMouseInputDuringDrag property on the created object.
Constructs a new instance of class PortDropInputMode for the type IPort.
Parameters
A map of options to pass to the method.
- isValidPortOwnerPredicate - function(IPortOwner, IPort):boolean
The callback for testing whether an existing port owner in the graph can be used as owner for the currently dragged port. This option sets the isValidPortOwnerPredicate property on the created object.
Signature Details
function(arg1: IPortOwner, arg2: IPort) : booleanEncapsulates a method that has two parameters and returns a value of the type specified by theTResultparameter.Parameters
- arg1 - IPortOwner
- The first parameter of the method that this delegate encapsulates.
- arg2 - IPort
- The second parameter of the method that this delegate encapsulates.
Returns
- boolean
- The return value of the method that this delegate encapsulates.
- useBestMatchingParameter - boolean
A value indicating whether the default implementation of getNewPortLocationModelParameter should directly use the parameter stored in the dragged item or whether the current drop location should be also taken into account. This option sets the useBestMatchingParameter property on the created object.
- showPreview - boolean
Whether a preview of the dragged element is displayed during the drag This option sets the showPreview property on the created object.
- snappingEnabled - boolean
Whether dragged items are snapped. This option sets the snappingEnabled property on the created object.
- disableSnappingRecognizer - function(Object, EventArgs):boolean
The event recognizer that determines whether to disable snapping temporarily. This option sets the disableSnappingRecognizer property on the created object.
Signature Details
function(eventSource: any, evt: EventArgs) : booleanA callback that recognizes events.Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
- highlightDropTarget - boolean
Whether the drop target is highlighted. This option sets the highlightDropTarget property on the created object.
- snapContext - SnapContext
The snapContext which is used to snap the dragged element during the drag. This option sets the snapContext property on the created object.
- dropTarget - IModelItem
The drop target at snappedMousePosition This option sets the dropTarget property on the created object.
- itemCreator - function(IInputModeContext, IGraph, Object, IModelItem, Point):IPort
The callback for item creation. This option sets the itemCreator property on the created object.
Signature Details
function(context: IInputModeContext, graph: IGraph, dropData: any, dropTarget: IModelItem, dropLocation: Point) : IPortCreates a copy of the dragged item in graph at the specified location.Parameters
- context - IInputModeContext
- The context for which the item should be created.
- graph - IGraph
- The
in which to create the item. - dropData - any
- The data containg the item that was dragged and should therefore be created.
- dropTarget - IModelItem
- The
on which the item is dropped. - dropLocation - Point
- The location the item should be created.
Returns
- IPort
- The item that has been created, or
nullif no item should be created.
- priority - number
- exclusive - boolean
A value indicating whether this mode will be the only one running when it has the mutex. This option sets the exclusive property on the created object.
- enabled - boolean
The enabled state of this input mode. This option sets the enabled property on the created object.
- dragDropEffect - DragDropEffects
The DragDropEffects that will be used for drags on the canvas. This option sets the dragDropEffect property on the created object.
- validDropHitTestable - IHitTestable
The IHitTestable that determines whether the given location is a valid drop location. This option sets the validDropHitTestable property on the created object.
- captureMouseInputDuringDrag - boolean
A value indicating whether to capture mouse input during drag operations. This option sets the captureMouseInputDuringDrag property on the created object.
Properties
Gets or sets a value indicating whether to capture mouse input during drag operations.
Remarks
true and thus prevents mouse events from being processed by visuals in the canvas.Defined in
Gets the installed controller.
Defined in
Gets or sets the event recognizer that determines whether to disable snapping temporarily.
Signature Details
function(eventSource: any, evt: EventArgs) : boolean
Parameters
- eventSource - any
- The source of the event.
- evt - EventArgs
- The arguments of the event to be decided to handle.
Returns
- boolean
trueif theevtis considered to be handled.
Defined in
Gets or sets the DragDropEffects that will be used for drags on the canvas.
Defined in
Gets the currently dragged IModelItem instance.
Gets the data carried by a drag operation.
Gets the mouse position after dropping an item.
Remarks
Defined in
Gets the drop target at snappedMousePosition
Gets or sets the enabled state of this input mode.
Remarks
Examples
mode.nodeDropInputMode.enabled = falseDefined in
Gets or sets a value indicating whether this mode will be the only one running when it has the mutex.
Remarks
The value of this property will be delegated to the exclusive property of the controller.
If this mode is marked as exclusive and has the mutex, all other modes added to the same MultiplexingInputMode will be deactivated. Otherwise it will always run concurrently with all other modes.
Defined in
Gets or sets whether the drop target is highlighted.
Gets the context instance this mode is currently installed in or null if this instance is not installed.
Remarks
Implements
Gets a value indicating whether a drag operation is currently in progress.
Defined in
Gets or sets the callback for testing whether an existing port owner in the graph can be used as owner for the currently dragged port.
Remarks
The default implementation checks whether a valid port model parameter could be found for the combination of port owner and dragged port.
Note that during native drag and drop, draggedItem is always null and cannot be used for this check.
Signature Details
function(arg1: IPortOwner, arg2: IPort) : boolean
TResult parameter.Parameters
- arg1 - IPortOwner
- The first parameter of the method that this delegate encapsulates.
- arg2 - IPort
- The second parameter of the method that this delegate encapsulates.
Returns
- boolean
- The return value of the method that this delegate encapsulates.
Gets or sets the callback for item creation.
Remarks
Signature Details
function(context: IInputModeContext, graph: IGraph, dropData: any, dropTarget: IModelItem, dropLocation: Point) : IPort
Parameters
- context - IInputModeContext
- The context for which the item should be created.
- graph - IGraph
- The
in which to create the item. - dropData - any
- The data containg the item that was dragged and should therefore be created.
- dropTarget - IModelItem
- The
on which the item is dropped. - dropLocation - Point
- The location the item should be created.
Returns
- IPort
- The item that has been created, or
nullif no item should be created.
See Also
Defined in
Gets the last processed drag event argument.
Defined in
Gets the current mouse position during drag operations.
Remarks
Defined in
Gets the graph displayed as item preview.
Gets the priority of this input mode.
Remarks
See Also
Implements
Gets or sets whether a preview of the dragged element is displayed during the drag
Gets or sets the snapContext which is used to snap the dragged element during the drag.
Remarks
null (the default) this input mode tries to obtain the snapContext from the IInputModeContext. To explicitly disable snapping, a snapContext implementation that does nothing has to be set to this instance.See Also
Defined in
Gets the current snapped mouse position during drag operations.
Remarks
Defined in
Gets or sets whether dragged items are snapped.
Gets or sets a value indicating whether the default implementation of getNewPortLocationModelParameter should directly use the parameter stored in the dragged item or whether the current drop location should be also taken into account.
Remarks
false, which means to use the parameter directly.Gets or sets the IHitTestable that determines whether the given location is a valid drop location.
Methods
Called to adjust the dropEffect accordingly.
Parameters
A map of options to pass to the method.
- evt - DragEventArgs
- The event args of the drag event to adjust the effects for.
Returns
- ↪boolean
trueif the drag event is handled by this input mode.
Overrides
Cleanly cancels this mode.
Implements
Cleanup method that calls cleanUpSnapContext, cleanUpPreview and cleanUpDropTarget.
Remarks
Defined in
Cleans up the drop target and its highlighting.
Defined in
Cleans up the item preview.
Cleans up the snap context.
Defined in
Callback registered on the SnapContext that collects SnapResults for the dragged element.
Remarks
Parameters
A map of options to pass to the method.
- source - Object
- The SnapContext this callback is registered at.
- evt - CollectSnapResultsEventArgs
- The arguments describing the movement SnapResults shall be collected for.
Overrides
Helper method that yields a suitably configured InputModeEventArgs for this input mode.
Returns
- ↪InputModeEventArgs
- An input mode event argument that is configured for this instance.
Defined in
createPort
(context: IInputModeContext, graph: IGraph, draggedPort: IPort, dropTarget: IPortOwner, parameter: IPortLocationModelParameter) : IPortCreates the port in the graph after it's been dropped.
Remarks
Parameters
A map of options to pass to the method.
- context - IInputModeContext
- The context for which the port should be created.
- graph - IGraph
- The Graph in which to create the port.
- draggedPort - IPort
- The port that was dragged and should therefore be created.
- dropTarget - IPortOwner
- The IPortOwner on which the port is dropped.
- parameter - IPortLocationModelParameter
- The IPortLocationModelParameter of the new port.
Returns
- ↪IPort
- a newly created label.
See Also
Looks for a valid port owner at the dragLocation.
Parameters
A map of options to pass to the method.
- dragLocation - Point
- The location to return the drop target for.
Returns
- ↪IModelItem
- A port owner or
nullif no valid port owner was found at the drop location.
Overrides
getNewPortLocationModelParameter
(owner: IPortOwner, draggedPort: IPort, dragLocation: Point) : IPortLocationModelParameterDetermine the IPortLocationModelParameter the port should have if it were dropped at dragLocation over owner.
Remarks
If useBestMatchingParameter is true, this implementation returns just the locationParameter of the draggedPort if it can be used for owner and null otherwise. The dragLocation is ignored in that case.
If useBestMatchingParameter is false, this implementation will use the model of the draggedPort if it is compatible with owner to determine the parameter that corresponds best to the current dragLocation.
Parameters
A map of options to pass to the method.
- owner - IPortOwner
- The port owner where the port would be created. May be
null. - draggedPort - IPort
- The port that is currently dragged.
- dragLocation - Point
- The current drag location.
Returns
See Also
Initializes the drop target.
Defined in
Initializes the item preview.
Remarks
See Also
Defined in
Initializes the snapping context.
Installs this mode into the given canvas.
Remarks
Parameters
A map of options to pass to the method.
- context - IInputModeContext
- the context to install this mode into
- controller - ConcurrencyController
- The controller for this mode.
See Also
Implements
Default backing method for isValidPortOwnerPredicate
Remarks
owner and draggedPort.Parameters
A map of options to pass to the method.
- owner - IPortOwner
- The port owner where the port would be created. May be
null. - draggedPort - IPort
- The port that is currently dragged.
Returns
- ↪boolean
trueiffownercan be used to drop a port.
Called after cancel has been called.
Remarks
Can be overridden in subclasses to perform additional actions after the mode has been canceled.
This implementation does nothing.
Defined in
Called after the active property of the installed ConcurrencyController has been set to true.
Remarks
Can be overridden in subclasses to perform additional actions after the mode has been activated.
Overriding implementations should call the base implementation.
Defined in
Called after the active property of the installed ConcurrencyController has been set to false.
Remarks
Can be overridden in subclasses to perform additional actions after the mode has been deactivated.
Overriding implementations should call the base implementation.
Overrides
Called once a drag has been dropped on the canvas.
Overrides
Called once a drag has entered the canvas.
Remarks
Overrides
Called whenever a drag is over the canvas.
Overrides
Called once a drag has left the canvas.
Overrides
Called whenever a new item is created
Defined in
Called after tryStop has been called.
Remarks
Can be overridden in subclasses to perform additional actions after the mode has been stopped.
This implementation does nothing.
Defined in
Subclasses shall fill the specified graph that is used to preview the dragged item.
Parameters
A map of options to pass to the method.
- previewGraph - IGraph
- The preview graph to fill.
See Also
Overrides
Sets the drag location and calls updatePreview to update the layout of item preview based on the mouse coordinates and the results of the snapContext.
Parameters
A map of options to pass to the method.
- location - Point
- The current location of the mouse in world coordinates.
Overrides
Overridden to only return true if this instance does not currently have the input mutex.
Uninstalls this mode from the canvas.
Remarks
Parameters
A map of options to pass to the method.
- context - IInputModeContext
- the context
Implements
Calls getDropTarget for snappedMousePosition and sets the returned item as dropTarget.
Remarks
Parameters
A map of options to pass to the method.
- dragLocation - Point
- The location to update the drop target for.
Defined in
Subclasses shall update the preview graph so the dragged item is displayed at the specified dragLocation.
Parameters
A map of options to pass to the method.
See Also
Overrides
Events
Occurs when a drag operation is dropped onto the CanvasComponent into which this instance is installed.
Remarks
No event is raised
- if this instance is not enabled,
- if another concurrent input mode is active or
- the data from the drag operation does not conform to the expected type.
To get additional data for the event, clients should use the sender which is set to the sending DropInputMode. The EventArgs provide no useful data.
See Also
Defined in
Event Registration
addDragDroppedListener(function(this, InputModeEventArgs):void)Event Deregistration
removeDragDroppedListener(function(this, InputModeEventArgs):void)Signature Details
function(sender: this, evt: InputModeEventArgs)
Parameters
- sender - this
- The source of the event.
- evt - InputModeEventArgs
- An object that contains the event data.
Occurs when a drag operation enters the CanvasComponent into which this instance is installed.
Remarks
No event is raised
- if this instance is not enabled,
- if another concurrent input mode is active or
- the data from the drag operation does not conform to the expected type.
To get additional data for the event, clients should use the sender which is set to the sending DropInputMode. The EventArgs provide no useful data.
See Also
Defined in
Event Registration
addDragEnteredListener(function(this, InputModeEventArgs):void)Event Deregistration
removeDragEnteredListener(function(this, InputModeEventArgs):void)Signature Details
function(sender: this, evt: InputModeEventArgs)
Parameters
- sender - this
- The source of the event.
- evt - InputModeEventArgs
- An object that contains the event data.
Occurs when a drag operation leaves the CanvasComponent into which this instance is installed.
Remarks
No event is raised
- if this instance is not enabled,
- if another concurrent input mode is active or
- the data from the drag operation does not conform to the expected type.
To get additional data for the event, clients should use the sender which is set to the sending DropInputMode. The EventArgs provide no useful data.
See Also
Defined in
Event Registration
addDragLeftListener(function(this, InputModeEventArgs):void)Event Deregistration
removeDragLeftListener(function(this, InputModeEventArgs):void)Signature Details
function(sender: this, evt: InputModeEventArgs)
Parameters
- sender - this
- The source of the event.
- evt - InputModeEventArgs
- An object that contains the event data.
Occurs when a drag operation drags over the CanvasComponent into which this instance is installed.
Remarks
No event is raised
- if this instance is not enabled,
- if another concurrent input mode is active or
- the data from the drag operation does not conform to the expected type.
To get additional data for the event, clients should use the sender which is set to the sending DropInputMode. The EventArgs provide no useful data.
See Also
Defined in
Event Registration
addDragOverListener(function(this, InputModeEventArgs):void)Event Deregistration
removeDragOverListener(function(this, InputModeEventArgs):void)Signature Details
function(sender: this, evt: InputModeEventArgs)
Parameters
- sender - this
- The source of the event.
- evt - InputModeEventArgs
- An object that contains the event data.
Occurs when a new item gets created by this input mode.
Defined in
Event Registration
addItemCreatedListener(function(this, ItemEventArgs<IPort>):void)Event Deregistration
removeItemCreatedListener(function(this, ItemEventArgs<IPort>):void)Signature Details
function(sender: this, evt: ItemEventArgs<IPort>)
Parameters
- sender - this
- The source of the event.
- evt - ItemEventArgs<IPort>
- An object that contains the event data.
Static Methods
startDrag
(dragSource: HTMLElement | SVGElement, port: IPort, dragDropEffects?: DragDropEffects, useCssCursors?: boolean, dragPreview?: HTMLElement | SVGElement) : DragSourceStarts a drag and drop operation for a IPort.
Remarks
This method creates a DragSource, and then invokes startDrag with a DragDropItem that contains the port and the corresponding type.
If useCssCursors is enabled, the following CSS classes are assigned to elements hovered during a drag operation, depending on the allowed drag-drop operations for these elements:
yfiles-cursor-dragdrop-moveyfiles-cursor-dragdrop-linkyfiles-cursor-dragdrop-allyfiles-cursor-dragdrop-no-drop
Parameters
A map of options to pass to the method.
- dragSource - HTMLElement | SVGElement
- The source of the drag operation.
- port - IPort
- The port to drag.
- dragDropEffects - DragDropEffects
- The allowed drag drop effects.
- useCssCursors - boolean
- Whether to adjust the classes of elements being hovered over during the drag. The default is
true. - dragPreview - HTMLElement | SVGElement
- Optional element that should be shown during dragging, e.g. outside of the GraphComponent. Note that this feature requires support for CSS pointer-events and should not be used in browsers that do not support it.