mxClipboard

Singleton that implements a clipboard for graph cells.

Example

mxClipboard.copy(graph);
mxClipboard.paste(graph2);

This copies the selection cells from the graph to the clipboard and pastes them into graph2.

For fine-grained control of the clipboard data the mxGraph.canExportCell and mxGraph.canImportCell functions can be overridden.

Summary
mxClipboardSingleton that implements a clipboard for graph cells.
Variables
STEPSIZEDefines the step size to offset the cells after each paste operation.
insertCountCounts the number of times the clipboard data has been inserted.
cellsHolds the array of mxCells currently in the clipboard.
Functions
isEmptyReturns true if the clipboard currently has not data stored.
cutCuts the given array of mxCells from the specified graph.
removeCellsHook to remove the given cells from the given graph after a cut operation.
copyCopies the given array of mxCells from the specified graph to cells.Returns the original array of cells that has been cloned.
pastePastes the cells into the specified graph restoring the relation to <parents>, if possible.

Variables

STEPSIZE

Defines the step size to offset the cells after each paste operation.  Default is 10.

insertCount

Counts the number of times the clipboard data has been inserted.

cells

Holds the array of mxCells currently in the clipboard.

Functions

isEmpty

isEmpty: function()

Returns true if the clipboard currently has not data stored.

cut

cut: function(graph,
cells)

Cuts the given array of mxCells from the specified graph.  If cells is null then the selection cells of the graph will be used.  Returns the cells that have been cut from the graph.

Parameters

graphmxGraph that contains the cells to be cut.
cellsOptional array of mxCells to be cut.

removeCells

removeCells: function(graph,
cells)

Hook to remove the given cells from the given graph after a cut operation.

Parameters

graphmxGraph that contains the cells to be cut.
cellsArray of mxCells to be cut.

copy

copy: function(graph,
cells)

Copies the given array of mxCells from the specified graph to cells.Returns the original array of cells that has been cloned.

Parameters

graphmxGraph that contains the cells to be copied.
cellsOptional array of mxCells to be copied.

paste

paste: function(graph)

Pastes the cells into the specified graph restoring the relation to <parents>, if possible.  If the parents are no longer in the graph or invisible then the cells are added to the graph’s default or into the swimlane under the cell’s new location if one exists.  The cells are added to the graph using mxGraph.importCells.

Parameters

graphmxGraph to paste the cells into.
Cells are the elements of the graph model.
isEmpty: function()
Returns true if the clipboard currently has not data stored.
cut: function(graph,
cells)
Cuts the given array of mxCells from the specified graph.
removeCells: function(graph,
cells)
Hook to remove the given cells from the given graph after a cut operation.
copy: function(graph,
cells)
Copies the given array of mxCells from the specified graph to cells.Returns the original array of cells that has been cloned.
Holds the array of mxCells currently in the clipboard.
paste: function(graph)
Pastes the cells into the specified graph restoring the relation to parents, if possible.
mxGraph.prototype.canExportCell = function(cell)
Returns true if the given cell may be exported to the clipboard.
mxGraph.prototype.canImportCell = function(cell)
Returns true if the given cell may be imported from the clipboard.
Extends mxEventSource to implement a graph component for the browser.
mxGraph.prototype.importCells = function(cells,
dx,
dy,
target,
evt)
Clones and inserts the given cells into the graph using the move method and returns the inserted cells.
Close