GraphClipboard

Clipboard implementation for IGraph instances.

Inheritance Hierarchy

GraphClipboard

Remarks

This implementation copies a given graph to an internally held clipboard graph. The clipboard graph can then be pasted to a target graph instance.

The clipboard can be configured to copy and paste items that depend on other items without copying the items it depends on, e.g. labels, ports, edges, and bends.

Also depending on the selection in the target graph, items can be pasted at multiple locations at once, e.g. a single label can be copied to the clipboard independently and pasted onto several selected target items.

Related Programming Samples

Graph Editor: Shows the graph editing features of the graph component.

Type Details

yfiles module: view-component
yfiles-umd modules: All view modules
Legacy UMD name: yfiles.graph.GraphClipboard

Constructors

GraphClipboard

()

Creates a new initially empty clipboard.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

pasteDelta - Point: A vector that will be used to move nodes and bends by after they have been pasted to the target graph. This option sets the pasteDelta property on the created object.
toClipboardCopier - GraphCopier: The GraphCopier instance that will be used to copy the graph to the clipboard. This option sets the toClipboardCopier property on the created object.
fromClipboardCopier - GraphCopier: The GraphCopier instance that will be used to copy the graph from the clipboard to the target graph. This option sets the fromClipboardCopier property on the created object.
duplicateCopier - GraphCopier: The GraphCopier instance that will be used to duplicate elements inside the graph. This option sets the duplicateCopier property on the created object.
idProvider - IClipboardIdProvider: The IClipboardIdProvider used by this instance to provide IDs for copied items. This option sets the idProvider property on the created object.
clipboardGraph - IGraph: The graph that contains the clipboard's contents. This option sets the clipboardGraph property on the created object.
parentNodeDetection - ParentNodeDetectionModes: Whether or not nodes should be automatically put into a group node and if so how this group will be determined. This option sets the parentNodeDetection property on the created object.
dependentCopyItems - GraphItemTypes: The type of items that depend on other elements but should automatically be copied implicitly to the clipboard if all elements that it depends on are explicitly selected for copying. This option sets the dependentCopyItems property on the created object.
independentCopyItems - GraphItemTypes: The type of items that can be copied and pasted independently of their owning element. This option sets the independentCopyItems property on the created object.
copyItems - GraphItemTypes: The type of items that can be copied and pasted at all using the clipboard. This option sets the copyItems property on the created object.
ignoreEdgesWithOneNode - boolean: Whether to paste edges whose source or target node was selected when copying to the clipboard while the other node was not. This option sets the ignoreEdgesWithOneNode property on the created object.

Properties

clipboardContext

: IGraphClipboardContext

Gets the clipboard context for the current clipboard operation.

Remarks

The context is only valid during cut, copy, pasteAndSelect, and duplicate and is null otherwise.

clipboardGraph

: IGraph

Gets or sets the graph that contains the clipboard's contents.

Throws

Exception({ name: 'ArgumentError' }): If value is null.

copyItems

: GraphItemTypes

Gets or sets the type of items that can be copied and pasted at all using the clipboard.

Remarks

If the corresponding element type is set in this property, items can be effectively copied.

If the corresponding element type is not set in this property, items will not be pasted, even if they have been explicitly selected. They may copied to the clipboard and become part of the clipboardGraph, nevertheless though, if they are required as dummy elements. But these elements will not be pasted to the target during paste or duplicate operations.

The default is ALL.

dependentCopyItems

: GraphItemTypes

Gets or sets the type of items that depend on other elements but should automatically be copied implicitly to the clipboard if all elements that it depends on are explicitly selected for copying.

Remarks

Labels depend on their owner, like ports depend on their owner. Also bends of course depend on their owning edge.

If the corresponding element type is set in this property, items that depend on other items are implicitly included in the copy operation, if all of the items that they depend on are included recursively, even if they are not included explicitly themselves.

The default is ALL minus NODE, which means that selecting a number of nodes will automatically select all elements that directly and indirectly depend on the existence of this set of nodes will be copied to the clipboard, too.

Technically nodes do not depend on anything. Setting this property to a value that includes NODE will include all child nodes for every selected group node.

duplicateCopier

: GraphCopier

Gets or sets the GraphCopier instance that will be used to duplicate elements inside the graph.

Remarks

This instance is lazily created using createDuplicateCopier.

empty

: boolean

Gets whether the clipboard graph is empty.

fromClipboardCopier

: GraphCopier

Gets or sets the GraphCopier instance that will be used to copy the graph from the clipboard to the target graph.

Remarks

This instance is lazily created using createFromClipboardCopier.

idProvider

: IClipboardIdProvider

Gets or sets the IClipboardIdProvider used by this instance to provide IDs for copied items.

Remarks

The default implementation simply uses a reference to the original item as ID.

Custom ID can be used to map between elements in different graphs.

ignoreEdgesWithOneNode

: boolean

Gets or sets whether to paste edges whose source or target node was selected when copying to the clipboard while the other node was not.

Remarks

The default is false.

independentCopyItems

: GraphItemTypes

Gets or sets the type of items that can be copied and pasted independently of their owning element.

Remarks

Labels depend on their owner, like ports depend on their owner. Also bends of course depend on their owning edge.

If the corresponding element type is set in this property, items can be copied alone to the clipboard and be pasted onto different owning elements.

This enables copying of a label to one or more owners, without having to copy the owner of the label. Also ports can be copied to other IPortOwners and bends to other edges.

The default is ALL which means that all elements can be copied to the clipboard even if the items that they depend on are not copied to the clipboard.

Technically owning elements are still part of the clipboard as dummy elements, but these elements will not be pasted to the target during paste or duplicate operations.

parentNodeDetection

: ParentNodeDetectionModes

Gets or sets whether or not nodes should be automatically put into a group node and if so how this group will be determined.

Remarks

This property is used by getTargetNode to decide what node to yield as the target group node for the newly pasted node.

The default is SELECTION|PREVIOUS_PARENT.

pasteDelta

: Point

Gets or sets a vector that will be used to move nodes and bends by after they have been pasted to the target graph.

toClipboardCopier

: GraphCopier

Gets or sets the GraphCopier instance that will be used to copy the graph to the clipboard.

Remarks

This instance is lazily created using createToClipboardCopier.

Methods

clear

()

Clears the clipboard's contents.

copy

(sourceGraph: IGraph, filter: function(IModelItem):boolean)

Copies the elements indicated by the filter to the clipboard graph.

Remarks

For each element copied to the clipboard graph the onElementCopied delegate will be called. The actual work of this method is delegated to the toClipboardCopier's copy method.

Parameters

options - Object
A map of options to pass to the method.

sourceGraph - IGraph

The graph to copy the contents from.

filter - function(IModelItem):boolean

The filter to apply to the source graph's elements.

Signature Details

function(obj: IModelItem) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - IModelItem: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

createClipboardGraph

() : IGraph

Creates the graph used for the clipboard.

Returns

↪IGraph: A new readily configured DefaultGraph instance.

createClipBoardHelperCopyFilter

() : function(IModelItem):boolean

Creates a predicate that is based upon the outcome of the shouldCopy method that can be found in the lookup of the provided IModelItem.

Returns

↪function(IModelItem):boolean

A predicate that uses shouldCopy.

Signature Details

function(obj: IModelItem) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - IModelItem: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

createClipBoardHelperCutFilter

() : function(IModelItem):boolean

Creates a predicate that is based upon the outcome of the shouldCut method that can be found in the lookup of the provided IModelItem.

Returns

↪function(IModelItem):boolean

A predicate that uses shouldCut.

Signature Details

function(obj: IModelItem) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - IModelItem: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

createClipBoardHelperPasteFilter

() : function(IModelItem):boolean

Creates a predicate that is based upon the outcome of the shouldPaste method that can be found in the lookup of the provided IModelItem.

Returns

↪function(IModelItem):boolean

A predicate that uses shouldPaste.

Signature Details

function(obj: IModelItem) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - IModelItem: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

createContext

(sourceGraph: IGraph, targetGraph: IGraph) : IGraphClipboardContext

Factory method that creates the context for the upcoming calls to the IClipboardHelper methods.

Parameters

options - Object
A map of options to pass to the method.

sourceGraph - IGraph: The source graph of the operation.
targetGraph - IGraph: The target graph of the operation.

Returns

↪IGraphClipboardContext: A context that has the properties configured according to the parameters.

createDefaultClipboardIdProvider

() : IClipboardIdProvider

Creates the default IClipboardIdProvider used by this instance to provide IDs for copied items.

Remarks

The default implementation simply uses a reference to the original item as ID.

Custom ID can be used to map between elements in different graphs.

createDefaultCopyFilter

(selection: IGraphSelection, graph: IGraph) : function(IModelItem):boolean

Creates a predicate for use in the onCopy method.

Remarks

This filter uses two predicates to decide whether a graph item can be copied. The base set of items specified by this filter is induced by the createSelectionFilter. Optionally, this set can be restricted further by an shouldCopy predicate. If such a predicate returns false for the item itself or any item this item depends on, then the item will not be copied. Items without such a predicate are handled solely according to their selection state.

Parameters

options - Object
A map of options to pass to the method.

selection - IGraphSelection: The selection model to base the filter on.
graph - IGraph: The graph to use for determining adjacency.

Returns

↪function(IModelItem):boolean

A predicate that filters subgraph induced by the selection of nodes and restricted by an optional shouldCopy predicate.

Signature Details

function(obj: IModelItem) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - IModelItem: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

createDefaultCutFilter

(selection: IGraphSelection, graph: IGraph) : function(IModelItem):boolean

Creates a predicate for use in the cut method.

Remarks

This filter uses two predicates to decide whether a graph item can be cut. The base set of items specified by this filter is induced by the createSelectionFilter. Optionally, this set can be restricted further by an shouldCut predicate. If such a predicate returns false for the item itself or any item this item depends on, then the item will not be cut. Items without such a predicate are handled solely according to their selection state.

Parameters

options - Object
A map of options to pass to the method.

selection - IGraphSelection: The selection model to base the filter on.
graph - IGraph: The graph to use for determining adjacency.

Returns

↪function(IModelItem):boolean

A predicate that filters subgraph induced by the selection of nodes and restricted by an optional shouldCut predicate.

Signature Details

function(obj: IModelItem) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - IModelItem: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

createDefaultDuplicateFilter

(selection: IGraphSelection, graph: IGraph) : function(IModelItem):boolean

Creates a predicate for use in the duplicate method.

Remarks

By default this method uses the same filter implementation as createDefaultCopyFilter: This filter uses two predicates to decide whether a graph item will be duplicated. The base set of items specified by this filter is induced by the createSelectionFilter. Optionally, this set can be restricted further by an shouldCopy predicate. If such a predicate returns false for the item itself or any item this item depends on, then the item will not be copied. Items without such a predicate are handled solely according to their selection state.

Parameters

options - Object
A map of options to pass to the method.

selection - IGraphSelection: The selection model to base the filter on.
graph - IGraph: The graph to use for determining adjacency.

Returns

↪function(IModelItem):boolean

A predicate that filters subgraph induced by the selection of nodes and restricted by an optional shouldCopy predicate.

Signature Details

function(obj: IModelItem) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - IModelItem: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

createDuplicateCopier

() : GraphCopier

Factory method that creates the duplicateCopier.

Returns

↪GraphCopier: A new GraphCopier instance.

createFromClipboardCopier

() : GraphCopier

Factory method that creates the fromClipboardCopier.

Returns

↪GraphCopier: A new GraphCopier instance.

createSelectionFilter

(selection: IGraphSelection, graph: IGraph) : function(IModelItem):boolean

Creates a predicate for use in the cut and onCopy methods.

Remarks

This predicate is based on the element induced by the set of selected nodes, e.g. each edge that has both of its adjacent port owners selected will be included as well as each label and port whose owner is included. Also ports where no adjacent edge is included (but edges exist), will not be included, unless the autoCleanUp is set to false.

Parameters

options - Object
A map of options to pass to the method.

selection - IGraphSelection: The selection model to base the filter on.
graph - IGraph: The graph to use for determining adjacency.

Returns

↪function(IModelItem):boolean

A predicate that filters subgraph induced by the selection of nodes.

Signature Details

function(obj: IModelItem) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - IModelItem: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

createToClipboardCopier

() : GraphCopier

Factory method that creates the toClipboardCopier.

Returns

↪GraphCopier: A new GraphCopier instance.

cut

(sourceGraph: IGraph, filter: function(IModelItem):boolean)

Cuts the items indicated by filter to the clipboard and removes them from the graph.

Remarks

This method delegates the core work to onCopy which will use the toClipboardCopier to copy the cut elements to the clipboard.

Parameters

options - Object
A map of options to pass to the method.

sourceGraph - IGraph

The graph to cut the items from.

filter - function(IModelItem):boolean

The filter to use.

Signature Details

function(obj: IModelItem) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - IModelItem: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

duplicate

(context: IInputModeContext, sourceGraph: IGraph, filter: function(IModelItem):boolean, elementDuplicated?: function(IModelItem, IModelItem):void)

Duplicates the elements indicated by the filter.

Remarks

The clipboardGraph is not altered by this operation.

Parameters

options - Object
A map of options to pass to the method.

context - IInputModeContext

The current IInputModeContext.

sourceGraph - IGraph

The graph whose elements should be duplicated.

filter - function(IModelItem):boolean

A predicate which returns true for elements which should be duplicated.

Signature Details

function(obj: IModelItem) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - IModelItem: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

elementDuplicated - function(IModelItem, IModelItem):void

An element copied callback which gets invoked for each element which has been duplicated. The two parameters passed into the callback are guaranteed to be part of the sourceGraph.

Signature Details

function(original: IModelItem, copy: IModelItem)

Callback delegate used by GraphCopier and the like.

Parameters

original - IModelItem: The element that has been copied.
copy - IModelItem: The copy of the original element.

getClipboardHelper

(item: IModelItem) : IClipboardHelper

Retrieves the IClipboardHelper instance associated with the given item.

Remarks

This implementation uses the item's lookup method to retrieve the helper instance.

Parameters

options - Object
A map of options to pass to the method.

item - IModelItem: The item to find the clipboard helper for.

Returns

↪IClipboardHelper: An instance or null.

getFoldingEdgeState

(edge: IEdge, id: FoldingEdgeStateId) : IEdge

Gets a folding state of an edge for a given FoldingEdgeStateId.

Remarks

This method might be overridden to map folding states for edges whose source or target node's hierarchy might have changed during a paste operation.

Parameters

options - Object
A map of options to pass to the method.

edge - IEdge: The edge to get the folding state for.
id - FoldingEdgeStateId: The original FoldingEdgeStateId to get the folding state for. Passing null will return the folding state which was visible when the edge was copied into the clipboard.

Returns

↪IEdge: The folding state which is mapped to the given id. May be null.

getId

(clipboardItem: IModelItem) : any

Returns the ID which is linked with the given clipboard item.

Remarks

Meant for use in methods getTargetNode, getTargetPort, getTargetLabeledItem, getTargetPortOwner, or getTargetEdge. Can be used together with the idProvider to retrieve the item in the original graph from which the clipboardItem has been copied.

Parameters

options - Object
A map of options to pass to the method.

clipboardItem - IModelItem: An IModelItem which lives in the clipboard graph.

Returns

↪any: The IModelItem which lives in the original graph. The ID which represents the item from which clipboardItem has originally been copied into the clipboard. idProvider's getItem can be used to retrieve the original item. Note that both, the returned ID as well as the item returned by getItem might be null.

Examples

Retrieving the original item which has been copied into the clipboard

/**
 * @param {!ILabel} clipboardLabel - The label to be copied.
 * @returns {?ILabelOwner}
 */
getTargetLabeledItem(clipboardLabel) {
  // clipboardLabel lives in the clipboard graph

  // get the original label, i.e. the label which has been copied from the original graph
  const originalLabel = this.idProvider.getItem(
    this.clipboardContext,
    this.getId(clipboardLabel)
  )

  // return the original label's owner as the pasted label's owner
  return originalLabel.owner
}/**
 * @param clipboardLabel - The label to be copied.
 */
getTargetLabeledItem(clipboardLabel: ILabel): ILabelOwner | null {
  // clipboardLabel lives in the clipboard graph

  // get the original label, i.e. the label which has been copied from the original graph
  const originalLabel = this.idProvider.getItem(
    this.clipboardContext!,
    this.getId(clipboardLabel)
  ) as ILabel

  // return the original label's owner as the pasted label's owner
  return originalLabel.owner
}

getLabelLayoutParameter

(copier: GraphCopier, graph: IGraph, label: ILabel, newOwner: ILabelOwner) : ILabelModelParameter

Gets a ILabelModelParameter for the given label to be placed at the given newOwner.

Remarks

Implementations might delegate to copyLabelLayoutParameter to copy the existing parameter or use the nodeDefaults or edgeDefaults to create a new one. Note that the type of the owner might have changed during the copy operation.

Parameters

options - Object
A map of options to pass to the method.

copier - GraphCopier: The GraphCopier whose copyLabelLayoutParameter method can be used to copy the existing parameter.
graph - IGraph: The IGraph whose nodeDefaults or edgeDefaults can be used to create a new parameter.
label - ILabel: The label to be copied.
newOwner - ILabelOwner: The new owner for the label.

Returns

↪ILabelModelParameter: An ILabelModelParameter for the copied label.

getMemento

(clipboardItem: IModelItem) : any

Retrieves the memento associated with an item in the clipboard graph that has been stored with the item during onElementCopied and onElementCut.

Parameters

options - Object
A map of options to pass to the method.

clipboardItem - IModelItem: The item in the clipboard graph.

Returns

↪any: The object returned by the IClipboardHelper methods or null.

getPortLocationParameter

(copier: GraphCopier, graph: IGraph, originalPort: IPort, newOwner: IPortOwner) : IPortLocationModelParameter

Gets a IPortLocationModelParameter for the given originalPort to be placed at the given newOwner.

Remarks

Implementations might delegate to copyPortLocationParameter to copy the existing parameter or use the nodeDefaults or edgeDefaults to create a new one. Note that the type of the owner might have changed during the copy operation.

Parameters

options - Object
A map of options to pass to the method.

copier - GraphCopier: The GraphCopier whose copyPortLocationParameter method can be used to copy the existing parameter.
graph - IGraph: The IGraph whose nodeDefaults or edgeDefaults can be used to create a new parameter.
originalPort - IPort: The port to be copied.
newOwner - IPortOwner: The new owner for the port.

Returns

↪IPortLocationModelParameter: An IPortLocationModelParameter for the copied port.

getTargetEdge

(clipboardBend: IBend) : IEdge

Provides an IEdge where the given clipboardBend can be added to.

Remarks

Called from within paste for IBends whose edge is not copied to provide a new owner. Might return null if no target for the given clipboardBend is found. In this case the bend will not be copied.

Parameters

options - Object
A map of options to pass to the method.

clipboardBend - IBend: The bend to be copied from the clipboardGraph.

Returns

↪IEdge: An IEdge for the bend to be added to or null if the bend should not be copied.

getTargetLabeledItem

(clipboardLabel: ILabel) : ILabelOwner

Provides an ILabelOwner where the given clipboardLabel can be added to.

Remarks

Called from within paste for ILabels whose owners are not copied to provide a new owner. Might return null if no target for the given clipboardLabel is found. In this case the label will not be copied.

Parameters

options - Object
A map of options to pass to the method.

clipboardLabel - ILabel: The label to be copied from the clipboardGraph.

Returns

↪ILabelOwner: An ILabelOwner for the label to be added to or null if the label should not be copied.

Examples

Retrieving the original item which has been copied into the clipboard

/**
 * @param {!ILabel} clipboardLabel - The label to be copied.
 * @returns {?ILabelOwner}
 */
getTargetLabeledItem(clipboardLabel) {
  // clipboardLabel lives in the clipboard graph

  // get the original label, i.e. the label which has been copied from the original graph
  const originalLabel = this.idProvider.getItem(
    this.clipboardContext,
    this.getId(clipboardLabel)
  )

  // return the original label's owner as the pasted label's owner
  return originalLabel.owner
}/**
 * @param clipboardLabel - The label to be copied.
 */
getTargetLabeledItem(clipboardLabel: ILabel): ILabelOwner | null {
  // clipboardLabel lives in the clipboard graph

  // get the original label, i.e. the label which has been copied from the original graph
  const originalLabel = this.idProvider.getItem(
    this.clipboardContext!,
    this.getId(clipboardLabel)
  ) as ILabel

  // return the original label's owner as the pasted label's owner
  return originalLabel.owner
}

getTargetNode

(clipboardNode: INode) : INode

Provides a parent group node for the given clipboardNode.

Remarks

Called from within paste for INodes to place them inside a group node. Might return null if the given node should be placed at the root or if the graph is not grouped.

Parameters

options - Object
A map of options to pass to the method.

clipboardNode - INode: The node to be copied from the clipboardGraph.

Returns

↪INode: The new parent group of the node or null if the node should be placed at the root of the hierarchy or if the graph is not grouped.

getTargetPort

(clipboardEdge: IEdge, atSource: boolean) : IPort

Provides an IPort where the given clipboardEdge can be added to.

Remarks

Called from within paste for IEdges whose source or target ports are not copied to provide a new port. Might return null if no target for the given clipboardEdge is found. In this case the edge will not be copied.

Parameters

options - Object
A map of options to pass to the method.

clipboardEdge - IEdge: The edge to be copied from the clipboardGraph.
atSource - boolean: Whether to look for a source port.

Returns

↪IPort: An IPort for the edge to be added to or null if the edge should not be copied.

getTargetPortOwner

(clipboardPort: IPort) : IPortOwner

Provides an IPortOwner where the given clipboardPort can be added to.

Remarks

Called from within paste for IPorts whose owners are not copied to provide a new owner. Might return null if no target for the given clipboardPort is found. In this case the port will not be copied.

Parameters

options - Object
A map of options to pass to the method.

clipboardPort - IPort: The port to be copied from the clipboardGraph.

Returns

↪IPortOwner: An IPortOwner for the port to be added to or null if the port should not be copied.

isDummy

(item: IModelItem) : boolean

Whether the given item is a "dummy" item which should not be pasted.

Remarks

A dummy item is used to keep IModelItems which cannot exist without an owner in the clipboardGraph (e.g. ILabels).

Parameters

options - Object
A map of options to pass to the method.

item - IModelItem: The item to test.

Returns

↪boolean: true if the item is a "dummy" item.

onCopy

(sourceGraph: IGraph, filter: function(IModelItem):boolean, targetGraph: IGraph, targetRootNode: INode, elementCopiedCallback: function(IModelItem, IModelItem):void)

Calls copy on the current toClipboardCopier instance or fromClipboardCopier instance, depending on whether the targetGraph is the clipboardGraph instance.

Parameters

options - Object
A map of options to pass to the method.

sourceGraph - IGraph

The source graph to pass to copy

filter - function(IModelItem):boolean

The predicate to pass on.

Signature Details

function(obj: IModelItem) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - IModelItem: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

targetGraph - IGraph

The target graph to pass on.

targetRootNode - INode

The node to use as the root node in the grouped targetGraph.

elementCopiedCallback - function(IModelItem, IModelItem):void

The delegate to pass on. For each element that is copied during the operation to the clipboard, this callback will be passed the original and the copy of the item. In case the sourceGraph is a folding view graph both elements are passed as master elements or folding state elements if a master element does not exist.

Signature Details

function(original: IModelItem, copy: IModelItem)

Callback delegate used by GraphCopier and the like.

Parameters

original - IModelItem: The element that has been copied.
copy - IModelItem: The copy of the original element.

onElementCopied

(original: IModelItem, copy: IModelItem)

A callback that will be invoked for each item that has been copied into the clipboard graph in response to a onCopy operation.

Remarks

This implementation will lookup a IClipboardHelper for each item in the original graph and remember the memento retrieved by the copy method for later use during the onElementPasted operation.

Parameters

options - Object
A map of options to pass to the method.

original - IModelItem: The original element from the source graph instance. If the source graph is a managed folding view, this is always a master item.
copy - IModelItem: The copy from the clipboard graph.

onElementCut

(original: IModelItem, copy: IModelItem)

A callback function that will be invoked for each item that has been copied into the clipboard graph in response to a cut operation.

Remarks

This implementation will lookup a IClipboardHelper for each item in the original graph and remember the memento retrieved by the cut method for later use during the onElementPasted operation.

Parameters

options - Object
A map of options to pass to the method.

original - IModelItem: The original element from the source graph instance. If the source graph is a managed folding view, this is always a master item.
copy - IModelItem: The copy from the clipboard graph.

onElementPasted

(original: IModelItem, copy: IModelItem)

A callback function that will be invoked for each item that has been pasted into the target graph in response to a pasteAndSelect operation.

Remarks

This method will use a previously stored IClipboardHelper to let it finish its work.

Parameters

options - Object
A map of options to pass to the method.

original - IModelItem: The original element from the clipboard graph instance. If the target graph is a managed folding view, this is always a master item.
copy - IModelItem: The copy from the target graph.

onPaste

(sourceGraph: IGraph, filter: function(IModelItem):boolean, targetGraph: IGraph, targetRootNode: INode, elementCopiedCallback: function(IModelItem, IModelItem):void, targetFilter: function(IModelItem):boolean)

Calls copy on the current fromClipboardCopier instance, depending on whether the targetGraph is the clipboardGraph instance.

Parameters

options - Object
A map of options to pass to the method.

sourceGraph - IGraph

The source graph to pass to copy

filter - function(IModelItem):boolean

The predicate to pass on.

Signature Details

function(obj: IModelItem) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - IModelItem: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

targetGraph - IGraph

The target graph to pass on.

targetRootNode - INode

The node to use as the root node in the grouped targetGraph.

elementCopiedCallback - function(IModelItem, IModelItem):void

The delegate to pass on. For each element that is copied during the operation to the clipboard, this callback will be passed the original and the copy of the item. In case the targetGraph is a folding view graph the original element is passed as master elements or folding state elements if a master element does not exist. The copied element is always part of the targetGraph.

Signature Details

function(original: IModelItem, copy: IModelItem)

Callback delegate used by GraphCopier and the like.

Parameters

original - IModelItem: The element that has been copied.
copy - IModelItem: The copy of the original element.

targetFilter - function(IModelItem):boolean

This predicate is used to determine which INodes and IEdges can be used as targets for paste operations, e.g. if a labels or ports are copied without their owners. If null all model items can be used as targets.

Signature Details

function(obj: IModelItem) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - IModelItem: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

paste

(targetGraph: IGraph, filter?: function(IModelItem):boolean, elementPasted?: function(IModelItem, IModelItem):void, targetFilter?: function(IModelItem):boolean, context?: IInputModeContext)

Pastes the contents from the clipboardGraph to the targetGraph after applying a filter.

Remarks

For each element pasted into the graph the elementPasted delegate will be invoked and the onElementPasted method will be called. The actual work of this method is delegated to the fromClipboardCopier's copy method. Providing a valid targetFilter allows for pasting ILabels, IPorts, and IEdges without valid owners.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

targetGraph - IGraph

The graph to paste the contents in.

filter - function(IModelItem):boolean

The filter to apply to the clipboard graph.

Signature Details

function(obj: IModelItem) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - IModelItem: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

elementPasted - function(IModelItem, IModelItem):void

The callback to use for each element that has been pasted. For each element that is copied during the operation to the clipboard, this callback will be passed the original and the copy of the item. In case the targetGraph is a folding view graph the original element is passed as master elements or folding state elements if a master element does not exist. The copied element is always part of the targetGraph.

Signature Details

function(original: IModelItem, copy: IModelItem)

Callback delegate used by GraphCopier and the like.

Parameters

original - IModelItem: The element that has been copied.
copy - IModelItem: The copy of the original element.

targetFilter - function(IModelItem):boolean

A filter which returns true for model items which can be used as target for clipboard items which need an owner (e.g. ILabels which were copied without their owner). If null all model items can be used as targets.

Signature Details

function(obj: IModelItem) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - IModelItem: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

context - IInputModeContext

A valid input mode context. Passing a valid input mode context is required for keeping orthogonal edges at group nodes whose size might be adjusted after the paste operation.

pasteAndSelect

(targetGraph: IGraph, selection: IGraphSelection)

Pastes the clipboardGraph's contents into the targetGraph, selecting all pasted elements.

Remarks

The actual work of this method is delegated to the fromClipboardCopier's copy method.

Parameters

options - Object
A map of options to pass to the method.

targetGraph - IGraph: The graph to paste into.
selection - IGraphSelection: The selection model to set the selection on.

removeElements

(sourceGraph: IGraph, predicate: function(IModelItem):boolean)

Removes elements from the graph based on a predicate.

Parameters

options - Object
A map of options to pass to the method.

sourceGraph - IGraph

The graph to remove elements from.

predicate - function(IModelItem):boolean

The predicate that decides which elements to remove.

Signature Details

function(obj: IModelItem) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - IModelItem: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

Events

ElementsCopied

Occurs when the copy operation finished successfully.

Event Registration

addElementsCopiedListener(function(this, EventArgs):void)

Event Deregistration

removeElementsCopiedListener(function(this, EventArgs):void)

Signature Details

function(sender: this, evt: EventArgs)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - EventArgs: An object that contains the event data.

ElementsCopying

Occurs before the copy operation starts.

Event Registration

addElementsCopyingListener(function(this, EventArgs):void)

Event Deregistration

removeElementsCopyingListener(function(this, EventArgs):void)

Signature Details

function(sender: this, evt: EventArgs)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - EventArgs: An object that contains the event data.

ElementsCut

Occurs when the cut operation finished successfully.

Event Registration

addElementsCutListener(function(this, EventArgs):void)

Event Deregistration

removeElementsCutListener(function(this, EventArgs):void)

Signature Details

function(sender: this, evt: EventArgs)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - EventArgs: An object that contains the event data.

ElementsCutting

Occurs before the cut operation starts.

Event Registration

addElementsCuttingListener(function(this, EventArgs):void)

Event Deregistration

removeElementsCuttingListener(function(this, EventArgs):void)

Signature Details

function(sender: this, evt: EventArgs)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - EventArgs: An object that contains the event data.

ElementsDuplicated

Occurs when the duplicate operation finished successfully.

Event Registration

addElementsDuplicatedListener(function(this, EventArgs):void)

Event Deregistration

removeElementsDuplicatedListener(function(this, EventArgs):void)

Signature Details

function(sender: this, evt: EventArgs)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - EventArgs: An object that contains the event data.

ElementsDuplicating

Occurs before the duplicate operation starts.

Event Registration

addElementsDuplicatingListener(function(this, EventArgs):void)

Event Deregistration

removeElementsDuplicatingListener(function(this, EventArgs):void)

Signature Details

function(sender: this, evt: EventArgs)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - EventArgs: An object that contains the event data.

ElementsPasted

Occurs when the paste operation finished successfully.

Event Registration

addElementsPastedListener(function(this, EventArgs):void)

Event Deregistration

removeElementsPastedListener(function(this, EventArgs):void)

Signature Details

function(sender: this, evt: EventArgs)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - EventArgs: An object that contains the event data.

ElementsPasting

Occurs before the paste operation starts.

Event Registration

addElementsPastingListener(function(this, EventArgs):void)

Event Deregistration

removeElementsPastingListener(function(this, EventArgs):void)

Signature Details

function(sender: this, evt: EventArgs)

Represents the method that will handle an event when the event provides data.

Parameters

sender - this: The source of the event.
evt - EventArgs: An object that contains the event data.

Static Methods

createWrappedFilter

(coreFilter: function(IModelItem):boolean, graph: IGraph, restrictive: boolean) : function(IModelItem):boolean

Creates an induced predicate from coreFilter for use in the cut and onCopy methods that takes dependent items into account.

Remarks

This method can create a predicate for only a core set of items which is then extended or restricted depending on the predicate values of graph item dependencies.

The restrictive parameter determines whether the result restricts or extends the set of elements handled by coreFilter:

If restrictive is false, an item is allowed if either coreFilter returns true for itself or if all items it depends on (e.g. label/port owner, source/target port etc.) are allowed by coreFilter.
If restrictive is true, an item is forbidden if either coreFilter returns false for itself or if any item it depends on (e.g. label/port owner, source/target port etc.) is forbidden by coreFilter.

Parameters

options - Object
A map of options to pass to the method.

coreFilter - function(IModelItem):boolean

The core predicate for the base set of elements.

Signature Details

function(obj: IModelItem) : boolean

Represents the method that defines a set of criteria and determines whether the specified object meets those criteria.

Parameters

obj - IModelItem: The object to compare against the criteria defined within the method represented by this delegate.

Returns

boolean: true if obj meets the criteria defined within the method represented by this delegate; otherwise, false.

graph - IGraph

The graph to use for determining adjacency.

restrictive - boolean

Whether to create a restriction or extension for the coreFilter predicate

isFoldingStateElement

(owner: IModelItem, item: IModelItem) : boolean

Whether the given item exists in a folding state of its owner.

Parameters

options - Object
A map of options to pass to the method.

owner - IModelItem: The owner of the given item.
item - IModelItem: An ILabel, IPort, or IBend.

Returns

↪boolean: true if the given item exists in a folding state.

GraphClipboard

Remarks

Related Programming Samples

Type Details

See Also

Constructors

GraphClipboard

ParametersOptions Overload

Properties

clipboardContext

Remarks

clipboardGraph

Throws

See Also

copyItems

Remarks

See Also

dependentCopyItems

Remarks

See Also

duplicateCopier

Remarks

See Also

empty

fromClipboardCopier

Remarks

See Also

idProvider

Remarks

ignoreEdgesWithOneNode

Remarks

independentCopyItems

Remarks

See Also

parentNodeDetection

Remarks

See Also

pasteDelta

See Also

toClipboardCopier

Remarks

See Also

Methods

clear

copy

Remarks

Parameters

Signature Details

Parameters

Returns

createClipboardGraph

Returns

createClipBoardHelperCopyFilter

Returns

Signature Details

Parameters

Returns

See Also

createClipBoardHelperCutFilter

Returns

Signature Details

Parameters

Returns

See Also

createClipBoardHelperPasteFilter

Returns

Signature Details

Parameters

Returns

See Also

createContext

Parameters

Returns

createDefaultClipboardIdProvider

Remarks

createDefaultCopyFilter

Remarks

Parameters

Returns

Signature Details