mxCell

Cells are the elements of the graph model. They represent the state of the groups, vertices and edges in a graph.

Summary

mxCell	Cells are the elements of the graph model.
Variables
id	Holds the Id.
value	Holds the user object.
geometry	Holds the mxGeometry.
style	Holds the style as a string of the form [(stylename\|key=value);].
vertex	Specifies whether the cell is a vertex.
edge	Specifies whether the cell is an edge.
connectable	Specifies whether the cell is connectable.
visible	Specifies whether the cell is visible.
collapsed	Specifies whether the cell is collapsed.
parent	Reference to the parent cell.
source	Reference to the source terminal.
target	Reference to the target terminal.
children	Holds the child cells.
edges	Holds the edges.
Functions
mxCell	Constructs a new cell to be used in a graph model.
getId	Returns the Id of the cell as a string.
setId	Sets the Id of the cell to the given string.
getValue	Returns the user object of the cell.
setValue	Sets the user object of the cell.
getGeometry	Returns the mxGeometry that describes the geometry.
setGeometry	Sets the mxGeometry to be used as the geometry.
getStyle	Returns a string that describes the style.
setStyle	Sets the string to be used as the style.
isVertex	Returns true if the cell is a vertex.
setVertex	Specifies if the cell is a vertex.
isEdge	Returns true if the cell is an edge.
setEdge	Specifies if the cell is an edge.
isConnectable	Returns true if the cell is connectable.
setConnectable	Sets the connectable state.
isVisible	Returns true if the cell is visibile.
setVisible	Specifies if the cell is visible.
isCollapsed	Returns true if the cell is collapsed.
setCollapsed	Sets the collapsed state.
getParent	Returns the cell’s parent.
setParent	Sets the parent cell.
getTerminal	Returns the source or target terminal.
setTerminal	Sets the source or target terminal and returns the new terminal.
getChildCount	Returns the number of child cells.
getIndex	Returns the index of the specified child in the child array.
getChildAt	Returns the child at the specified index.
insert	Inserts the specified child into the child array at the specified index and updates the parent reference of the child.
remove	Removes the child at the specified index from the child array and returns the child that was removed.
removeFromParent	Removes the cell from its parent.
getEdgeCount	Returns the number of edges in the edge array.
getEdgeIndex	Returns the index of the specified edge in edges.
getEdgeAt	Returns the edge at the specified index in edges.
insertEdge	Inserts the specified edge into the edge array and returns the edge.
removeEdge	Removes the specified edge from the edge array and returns the edge.
removeFromTerminal	Removes the edge from its source or target terminal.
getAttribute	Returns the specified attribute from the user object if it is an XML node.
setAttribute	Sets the specified attribute on the user object if it is an XML node.
copy	Returns a clone of the cell.
copyValue	Returns a clone of the cell’s user object.

Variables

id

var $id

Holds the Id. Default is null.

value

var $value

Holds the user object. Default is null.

geometry

var $geometry

Holds the mxGeometry. Default is null.

style

var $style

Holds the style as a string of the form [(stylename|key=value);]. Default is null.

vertex

var $vertex

Specifies whether the cell is a vertex. Default is false.

edge

var $edge

Specifies whether the cell is an edge. Default is false.

connectable

var $connectable

Specifies whether the cell is connectable. Default is true.

visible

var $visible

Specifies whether the cell is visible. Default is true.

collapsed

var $collapsed

Specifies whether the cell is collapsed. Default is false.

parent

var $parent

Reference to the parent cell.

source

var $source

Reference to the source terminal.

target

var $target

Reference to the target terminal.

children

var $children

Holds the child cells.

edges

var $edges

Holds the edges.

Functions

mxCell

function mxCell( $value = null,
$geometry = null,
$style = null )

Constructs a new cell to be used in a graph model. This method invokes <onInit> upon completion.

Parameters

value	Optional object that represents the cell value.
geometry	Optional mxGeometry that specifies the geometry.
style	Optional formatted string that defines the style.

getId

function getId()

Returns the Id of the cell as a string.

setId

function setId( $id )

Sets the Id of the cell to the given string.

getValue

function getValue()

Returns the user object of the cell. The user object is stored in value.

setValue

function setValue( $value )

Sets the user object of the cell. The user object is stored in value.

getGeometry

function getGeometry()

Returns the mxGeometry that describes the geometry.

setGeometry

function setGeometry( $geometry )

Sets the mxGeometry to be used as the geometry.

getStyle

function getStyle()

Returns a string that describes the style.

setStyle

function setStyle( $style )

Sets the string to be used as the style.

isVertex

function isVertex()

Returns true if the cell is a vertex.

setVertex

function setVertex( $vertex )

Specifies if the cell is a vertex. This should only be assigned at construction of the cell and not be changed during its lifecycle.

Parameters

vertex

Boolean that specifies if the cell is a vertex.

isEdge

function isEdge()

Returns true if the cell is an edge.

setEdge

function setEdge( $edge )

Specifies if the cell is an edge. This should only be assigned at construction of the cell and not be changed during its lifecycle.

Parameters

edge	Boolean that specifies if the cell is an edge.

isConnectable

function isConnectable()

Returns true if the cell is connectable.

setConnectable

function setConnectable( $connectable )

Sets the connectable state.

Parameters

connectable

Boolean that specifies the new connectable state.

isVisible

function isVisible()

Returns true if the cell is visibile.

setVisible

function setVisible( $visible )

Specifies if the cell is visible.

Parameters

visible

Boolean that specifies the new visible state.

isCollapsed

function isCollapsed()

Returns true if the cell is collapsed.

setCollapsed

function setCollapsed( $collapsed )

Sets the collapsed state.

Parameters

collapsed

Boolean that specifies the new collapsed state.

getParent

function getParent()

Returns the cell’s parent.

setParent

function setParent( $parent )

Sets the parent cell.

Parameters

parent

mxCell that represents the new parent.

getTerminal

function getTerminal( $source )

Returns the source or target terminal.

Parameters

source

Boolean that specifies if the source terminal should be returned.

setTerminal

function setTerminal( $terminal,
$source )

Sets the source or target terminal and returns the new terminal.

Parameters

terminal	mxCell that represents the new source or target terminal.
source	Boolean that specifies if the source or target terminal should be set.

getChildCount

function getChildCount()

Returns the number of child cells.

getIndex

function getIndex( $child )

Returns the index of the specified child in the child array.

Parameters

child

Child whose index should be returned.

getChildAt

function getChildAt( $index )

Returns the child at the specified index.

Parameters

index

Integer that specifies the child to be returned.

insert

function insert( $child,
$index = null )

Inserts the specified child into the child array at the specified index and updates the parent reference of the child. If not childIndex is specified then the child is appended to the child array. Returns the inserted child.

Parameters

child	mxCell to be inserted or appended to the child array.
index	Optional integer that specifies the index at which the child should be inserted into the child array.

remove

function remove( $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.

Parameters

index

Integer that specifies the index of the child to be removed.

removeFromParent

function removeFromParent()

Removes the cell from its parent.

getEdgeCount

function getEdgeCount()

Returns the number of edges in the edge array.

getEdgeIndex

function getEdgeIndex( $edge )

Returns the index of the specified edge in edges.

Parameters

edge	mxCell whose index in edges should be returned.

getEdgeAt

function getEdgeAt( $index )

Returns the edge at the specified index in edges.

Parameters

index

Integer that specifies the index of the edge to be returned.

insertEdge

function insertEdge( $edge,
$outgoing )

Inserts the specified edge into the edge array and returns the edge. Will update the respective terminal reference of the edge.

Parameters

edge	mxCell to be inserted into the edge array.
outgoing	Boolean that specifies if the edge is outgoing.

removeEdge

function removeEdge( $edge,
$outgoing )

Removes the specified edge from the edge array and returns the edge. Will remove the respective terminal reference from the edge.

Parameters

edge	mxCell to be removed from the edge array.
outgoing	Boolean that specifies if the edge is outgoing.

removeFromTerminal

function removeFromTerminal( $source )

Removes the edge from its source or target terminal.

Parameters

source

Boolean that specifies if the edge should be removed from its source or target terminal.

getAttribute

function getAttribute( $key,
$defaultValue = null )

Returns the specified attribute from the user object if it is an XML node.

setAttribute

function setAttribute( $key,
$value )

Sets the specified attribute on the user object if it is an XML node.

copy

function copy()

Returns a clone of the cell. Uses <cloneValue> to clone the user object.

copyValue

function copyValue()

Returns a clone of the cell’s user object.