Context passed from the GraphClipboard to the ClipboardGraphCopier about the items to copy.
Remarks
Type Details
- yFiles module
- view
Properties
All items to be copied as master items.
Remarks
All items from the sourceGraph that should be copied.
Remarks
All items to be copied that cannot be represented as master items.
Remarks
The GraphClipboard that created this instance.
The IFoldingView of the sourceGraph.
Remarks
null if the source graph is not a managed view.The graph to copy the items from.
Remarks
The IFoldingView of the targetGraph.
Remarks
null if the target graph is not a managed view.The graph to copy the items to.
Remarks
Methods
Adds an item to be copied.
Parameters
A map of options to pass to the method.
- item - IModelItem
- The item to be copied. If the sourceGraph is a managed view, this item has to be an item from the view's masterGraph.
- isHelper - boolean
- Whether the item is only copied to maintain the structural integrity of the clipboardGraph.
Returns
- ↪boolean
falseif the item is already registered and therefore not added again.
Adds an item without master representation to be copied.
Parameters
A map of options to pass to the method.
- item - IModelItem
- The item to be copied if the item is not represented by a master item. If the sourceGraph is not a managed view nothing should be added here.
- isHelper - boolean
- Whether the item is only copied to maintain the structural integrity of the clipboardGraph.
Returns
- ↪boolean
falseif the item is already registered and therefore not added again.
Gets the IClipboardHelper for the given item.
Parameters
A map of options to pass to the method.
- item - IModelItem
- The item to get the helper for.
Returns
Gets the bends whose owners are not copied.
Remarks
Returns
- ↪IEnumerable<IBend>
- All bends which should be copied but whose owners don't.
Gets the labels whose owners are not copied.
Remarks
Returns
- ↪IEnumerable<ILabel>
- All labels that should be copied but whose owners don't.
Gets the ports whose owners are not copied.
Remarks
Returns
- ↪IEnumerable<IPort>
- All ports that should be copied but whose owners don't.
Returns whether the item is no item to copy or was only copied to the clipboardGraph as it is required to maintain its structural integrity.
Parameters
A map of options to pass to the method.
- item - IModelItem
- The item to check.
Returns
- ↪boolean
- Whether the item is only copied to clipboard for integrity.
Whether the item should be copied by copy.
Remarks
true if the item should be copied, regardless of whether the item is represented as master item, without master representation, or only to maintain structural integrity.Parameters
A map of options to pass to the method.
- item - IModelItem
- The item to query for.
Returns
- ↪boolean
trueif the item should be copied in a clipboard operation.
Whether the item was added as master item and should be copied by copy.
Remarks
true if the item should be copied as master item.Parameters
A map of options to pass to the method.
- item - IModelItem
- The item to query for.
Returns
- ↪boolean
trueif the item is a master item that should be copied in a clipboard operation.
Whether the item was added as view state item and should be copied by copy.
Remarks
true if the item should be copied without master representation.Parameters
A map of options to pass to the method.
- item - IModelItem
- The item to query for.
Returns
- ↪boolean
trueif the item is a view state item that should be copied in a clipboard operation.
Marks an item in the clipboardGraph that should not be pasted but was copied to the clipboardGraph as it was required to maintain its structural integrity.
Parameters
A map of options to pass to the method.
- item - IModelItem
- The item to add.
Returns
- ↪boolean
trueif the element is added;falseif the element is already present.