|
mxGraph
|
Cells are the elements of the graph model. They represent the state of the groups, vertices and edges in a graph. More...
Public Member Functions | |
| mxCell () | |
| Constructs a new empty cell. More... | |
| mxCell (Object value) | |
| Constructs a new cell for the given value. More... | |
| mxCell (Object value, mxGeometry geometry, string style) | |
| Constructs a new cell for the given value, geometry and style. More... | |
| mxICell | GetTerminal (bool source) |
| Returns the source or target terminal of the cell. More... | |
| mxICell | SetTerminal (mxICell terminal, bool isSource) |
| Sets the source or target terminal. More... | |
| int | ChildCount () |
| Returns the number of child cells. More... | |
| int | GetIndex (mxICell child) |
| Returns the index of the specified child in the child array. More... | |
| mxICell | GetChildAt (int index) |
| Returns the child at the specified index. More... | |
| mxICell | Insert (mxICell child) |
| Appends the specified child into the child array and updates the parent reference of the child. More... | |
| mxICell | Insert (mxICell child, int index) |
| Inserts the specified child into the child array at the specified index and updates the parent reference of the child. More... | |
| mxICell | Remove (int index) |
| Removes the child at the specified index from the child array and returns the child that was removed. Will remove the parent reference of the child. More... | |
| mxICell | Remove (mxICell child) |
| Removes the given child from the child array. Will remove the parent reference of the child. More... | |
| void | RemoveFromParent () |
| Removes the cell from its parent. More... | |
| int | EdgeCount () |
| Returns the number of edges in the edge array. More... | |
| int | GetEdgeIndex (mxICell edge) |
| Returns the index of the specified edge in the edge array. More... | |
| mxICell | GetEdgeAt (int index) |
| Returns the edge at the specified index in the edge array. More... | |
| mxICell | InsertEdge (mxICell edge, bool isOutgoing) |
| Inserts the specified edge into the edge array and returns the edge. Will update the respective terminal reference of the edge. More... | |
| mxICell | RemoveEdge (mxICell edge, bool isOutgoing) |
| Removes the specified edge from the edge array and returns the edge. Will remove the respective terminal reference from the edge. More... | |
| void | RemoveFromTerminal (bool isSource) |
| Removes the edge from its source or target terminal. More... | |
| String | GetAttribute (String name) |
| Returns the specified attribute from the user object if it is an XML More... | |
| String | GetAttribute (String name, String defaultValue) |
| Returns the specified attribute from the user object if it is an XML More... | |
| void | SetAttribute (String name, String value) |
| Object | Clone () |
| Returns a clone of this cell. More... | |
Protected Attributes | |
| string | id |
| Holds the Id. Default is null. More... | |
| Object | value |
| Holds the user object. Default is null. More... | |
| mxGeometry | geometry |
| Holds the geometry. Default is null. More... | |
| string | style |
| Holds the geometry. Default is null. More... | |
| bool | vertex = false |
| Specifies whether the cell is a vertex. Default value is false. More... | |
| bool | edge = false |
| Specifies whether the cell is an edge. Default value is false. More... | |
| bool | connectable = true |
| Specifies whether the cell connectable. Default value is true. More... | |
| bool | visible = true |
| Specifies whether the cell is visible. Default value is true. More... | |
| bool | collapsed = false |
| Specifies whether the cell is collapsed. Default value is false. More... | |
| mxICell | parent |
| Reference to the parent cell. More... | |
| mxICell | source |
| Reference to the source terminal of an edge. More... | |
| mxICell | target |
| Reference to the target terminal of an edge. More... | |
| List< mxICell > | children |
| Holds the child cells. More... | |
| List< mxICell > | edges |
| Holds the connected edges. More... | |
Properties | |
| string | Id [get, set] |
| Object | Value [get, set] |
| mxGeometry | Geometry [get, set] |
| string | Style [get, set] |
| bool | Vertex [get, set] |
| bool | Edge [get, set] |
| bool | Connectable [get, set] |
| bool | Visible [get, set] |
| bool | Collapsed [get, set] |
| mxICell | Parent [get, set] |
| mxICell | Source [get, set] |
| Sets or returns the source terminal of the cell. More... | |
| mxICell | Target [get, set] |
| Sets or returns the target terminal of the cell. More... | |
Properties inherited from com.mxgraph.mxICell | |
| string | Id [get, set] |
| Sets or returns the Id of the cell. More... | |
| Object | Value [get, set] |
| Sets or returns the user object of the cell. More... | |
| mxGeometry | Geometry [get, set] |
| Sets or returns the geometry of the cell. More... | |
| string | Style [get, set] |
| Sets or returns the string that describes the style. More... | |
| bool | Vertex [get] |
| Returns true if the cell is a vertex. More... | |
| bool | Edge [get] |
| Returns true if the cell is an edge. More... | |
| bool | Connectable [get] |
| Returns true if the cell is connectable. More... | |
| bool | Visible [get, set] |
| Sets or returns the visible state of the cell. More... | |
| bool | Collapsed [get, set] |
| Sets or returns the collapsed state of the cell. More... | |
| mxICell | Parent [get, set] |
| Sets or returns the parent of the cell. More... | |
Cells are the elements of the graph model. They represent the state of the groups, vertices and edges in a graph.
|
inline |
Constructs a new empty cell.
|
inline |
Constructs a new cell for the given value.
| value | Value that represents the user object. |
|
inline |
Constructs a new cell for the given value, geometry and style.
| value | Value that represents the user object. |
| geometry | Geometry of the cell to be created. |
| style | Style of the cell to be created. |
|
inline |
Returns the number of child cells.
Implements com.mxgraph.mxICell.
|
inline |
Returns a clone of this cell.
Implements com.mxgraph.mxICell.
References com.mxgraph.mxGeometry.Clone().
|
inline |
Returns the number of edges in the edge array.
Implements com.mxgraph.mxICell.
|
inline |
Returns the specified attribute from the user object if it is an XML
node.
| name | Name of the attribute whose value should be returned. |
|
inline |
Returns the specified attribute from the user object if it is an XML
node.
| name | Name of the attribute whose value should be returned. |
| defaultValue | Default value to use if the attribute has no value. |
|
inline |
Returns the child at the specified index.
| index | Integer that specifies the child to be returned. |
Implements com.mxgraph.mxICell.
|
inline |
Returns the edge at the specified index in the edge array.
| index | Integer that specifies the index of the edge to be returned. |
Implements com.mxgraph.mxICell.
|
inline |
Returns the index of the specified edge in the edge array.
| edge | Cell whose index should be returned. |
Implements com.mxgraph.mxICell.
|
inline |
Returns the index of the specified child in the child array.
| child | Child whose index should be returned. |
Implements com.mxgraph.mxICell.
|
inline |
Returns the source or target terminal of the cell.
| source | Boolean that specifies if the source terminal should be returned. |
Implements com.mxgraph.mxICell.
Appends the specified child into the child array and updates the parent reference of the child.
| child | Cell to be appended to the child array. |
Implements com.mxgraph.mxICell.
References com.mxgraph.mxICell.Parent.
Referenced by com.mxgraph.mxGraphModel.CreateRoot().
Inserts the specified child into the child array at the specified index and updates the parent reference of the child.
| child | Cell to be inserted into the child array. |
| index | Integer that specifies the index at which the child should be inserted into the child array. |
Implements com.mxgraph.mxICell.
References com.mxgraph.mxICell.Insert(), com.mxgraph.mxICell.Parent, and com.mxgraph.mxICell.RemoveFromParent().
Inserts the specified edge into the edge array and returns the edge. Will update the respective terminal reference of the edge.
| edge | Cell to be inserted into the edge array. |
| isOutgoing | Boolean that specifies if the edge is outgoing. |
Implements com.mxgraph.mxICell.
References com.mxgraph.mxICell.GetTerminal(), com.mxgraph.mxICell.RemoveFromTerminal(), and com.mxgraph.mxICell.SetTerminal().
|
inline |
Removes the child at the specified index from the child array and returns the child that was removed. Will remove the parent reference of the child.
| index | Integer that specifies the index of the child to be removed. |
Implements com.mxgraph.mxICell.
Removes the given child from the child array. Will remove the parent reference of the child.
| child |
Implements com.mxgraph.mxICell.
References com.mxgraph.mxICell.Parent, and com.mxgraph.mxICell.Remove().
Removes the specified edge from the edge array and returns the edge. Will remove the respective terminal reference from the edge.
| edge | Cell to be removed from the edge array. |
| isOutgoing | Boolean that specifies if the edge is outgoing. |
Implements com.mxgraph.mxICell.
References com.mxgraph.mxICell.GetTerminal(), com.mxgraph.mxICell.Remove(), and com.mxgraph.mxICell.SetTerminal().
|
inline |
Removes the cell from its parent.
Implements com.mxgraph.mxICell.
References com.mxgraph.mxICell.Remove().
|
inline |
Removes the edge from its source or target terminal.
| isSource | Boolean that specifies if the edge should be removed from its source or target terminal. |
Implements com.mxgraph.mxICell.
References com.mxgraph.mxICell.RemoveEdge().
|
inline |
Sets the specified attribute on the user object if it is an XML node.
| name | Name of the attribute whose value should be set. |
| value | New value of the attribute. |
Sets the source or target terminal.
| terminal | Cell that represents the new source or target terminal. |
| source | Boolean that specifies if the source or target terminal should be set. |
Implements com.mxgraph.mxICell.
|
protected |
Holds the child cells.
|
protected |
Specifies whether the cell is collapsed. Default value is false.
|
protected |
Specifies whether the cell connectable. Default value is true.
|
protected |
Specifies whether the cell is an edge. Default value is false.
|
protected |
Holds the connected edges.
|
protected |
Holds the geometry. Default is null.
|
protected |
Holds the Id. Default is null.
|
protected |
Reference to the parent cell.
|
protected |
Reference to the source terminal of an edge.
|
protected |
Holds the geometry. Default is null.
|
protected |
Reference to the target terminal of an edge.
|
protected |
Holds the user object. Default is null.
|
protected |
Specifies whether the cell is a vertex. Default value is false.
|
protected |
Specifies whether the cell is visible. Default value is true.
|
getset |
Sets or returns the source terminal of the cell.
|
getset |
Sets or returns the target terminal of the cell.
1.8.13