Retrieve information about biograph object
get(BGobj)
BGStruct = get(BGobj)
PropertyValue = get(BGobj,
'PropertyName')
[Property1Value, Property2Value,
...] = get(BGobj, 'Property1Name',
'Property2Name', ...)
BGobj | Biograph object created with the function biograph. |
PropertyName | Property name for a biograph object. |
BGStruct | Scalar structure, in which each field name is a property of a biograph object, and each field contains the value of that property. |
PropertyValue | Value of the property specified by PropertyName. |
get( displays
all properties and their current values of BGobj)BGobj,
a biograph object.
BGStruct = get(BGobj)BGobj, a biograph object,
to BGStruct, a scalar structure, in which
each field name is a property of a biograph object, and each field
contains the value of that property.
PropertyValue = get(BGobj,
'PropertyName')BGobj,
a biograph object.
[ returns
the values of the specified properties of Property1Value, Property2Value,
...] = get(BGobj, 'Property1Name',
'Property2Name', ...)BGobj,
a biograph object.
Properties of a Biograph Object
| Property | Description |
|---|---|
ID
| Character vector to identify the biograph
object. Default is ''. |
Label | Character vector to label the biograph
object. Default is ''. |
Description | Character vector that describes the biograph
object. Default is ''. |
LayoutType
| Character vector that specifies the algorithm for the layout engine. Choices are:
|
EdgeType | Character vector that specifies how edges display. Choices are:
Note Curved or segmented edges occur only when necessary to avoid
obstruction by nodes. Biograph objects with |
Scale | Positive number that post-scales the
node coordinates. Default is 1. |
LayoutScale | Positive number that scales the size
of the nodes before calling the layout engine. Default is 1. |
EdgeTextColor | Three-element numeric vector of RGB values.
Default is [0, 0, 0], which defines black. |
EdgeFontSize | Positive number that sets the size of
the edge font in points. Default is 8. |
ShowArrows | Controls the display of arrows with the
edges. Choices are 'on' (default) or 'off'. |
ArrowSize | Positive number that sets the size of
the arrows in points. Default is 8. |
ShowWeights | Controls the display of text indicating
the weight of the edges. Choices are 'on' or 'off' (default). |
ShowTextInNodes | Character vector that specifies
the node property used to label nodes when you display a biograph
object using the
|
NodeAutoSize | Controls precalculating the node size before calling the layout
engine. Choices are Note Set it to
|
NodeCallback | User-defined callback for all nodes.
Enter the name of a function, a function handle, or a cell array with
multiple function handles. After using the view function
to display the biograph object in the Biograph Viewer, you can double-click
a node to activate the first callback, or right-click and select a
callback to activate. Default is the anonymous function, @(node)
inspect(node), which displays the Property Inspector dialog
box. |
EdgeCallback | User-defined callback for all edges.
Enter the name of a function, a function handle, or a cell array with
multiple function handles. After using the view function
to display the biograph object in the Biograph Viewer, you can right-click
and select a callback to activate. Default is the anonymous function, @(edge)
inspect(edge), which displays the Property Inspector dialog
box. |
CustomNodeDrawFcn | Function handle to a customized function
to draw nodes. Default is []. |
Nodes | Read-only column vector with handles to node objects of a biograph object. The size of the vector is the number of nodes. For properties of node objects, see Properties of a Node Object. |
Edges | Read-only column vector with handles to edge objects of a biograph object. The size of the vector is the number of edges. For properties of edge objects, see Properties of an Edge Object. |
Create a biograph object and assign the node IDs.
cm = [0 1 1 0 0;1 0 0 1 1;1 0 0 0 0;0 0 0 0 1;1 0 1 0 0];
ids = {'M30931','L07625','K03454','M27323','M15390'};
bg = biograph(cm,ids);
Use the get function to display
the node IDs.
get(bg.nodes,'ID')
ans =
'M30931'
'L07625'
'K03454'
'M27323'
'M15390'