set (biograph)

(To be removed) Set property of biograph object

The biograph object and its methods will be removed in a future release. Use graph or digraph instead.

Syntax

set(BGobj)
set(BGobj, 'PropertyName')
set(BGobj, 'PropertyName', PropertyValue)
set(BGobj, 'Property1Name', Property1Value, 'Property2Name', Property2Value, ...)


Arguments

BGobj	Biograph object created with the function biograph.
PropertyName	Property name for a biograph object.
PropertyValue	Value of the property specified by PropertyName.

Description

set(BGobj) displays possible values for all properties that have a fixed set of property values in BGobj, a biograph object.

set(BGobj, 'PropertyName') displays possible values for a specific property that has a fixed set of property values in BGobj, a biograph object.

set(BGobj, 'PropertyName', PropertyValue) sets the specified property of BGobj, a biograph object.

set(BGobj, 'Property1Name', Property1Value, 'Property2Name', Property2Value, ...) sets the specified properties of 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: 'hierarchical' (default) — Uses a topological order of the graph to assign levels, and then arranges the nodes from top to bottom, while minimizing crossing edges. 'radial' — Uses a topological order of the graph to assign levels, and then arranges the nodes from inside to outside of the circle, while minimizing crossing edges. 'equilibrium' — Calculates layout by minimizing the energy in a dynamic spring system.
EdgeType	Character vector that specifies how edges display. Choices are: 'straight' 'curved' (default) 'segmented' Note Curved or segmented edges occur only when necessary to avoid obstruction by nodes. Biograph objects with LayoutType equal to 'equilibrium' or 'radial' cannot produce curved or segmented edges.
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 view method. Choices are: 'Label' — Uses the Label property of the node object (default). 'ID' — Uses the ID property of the node object. 'None'
NodeAutoSize	Controls precalculating the node size before calling the layout engine. Choices are 'on' (default) or 'off'. Note Set it to off if you want to apply different node sizes by changing the Size property.
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.

Version History

Introduced in R2008b

R2021b: biograph and its methods will be removed

The biograph object and its methods will be removed in a future release. Use graph or digraph instead.