Stateflow Programmatic Interface

Create and modify chart elements at the MATLAB^® command prompt

Programmatically create, edit, and simulate your Stateflow^® charts by using MATLAB commands. Access and edit the properties and methods, set positions, or copy and paste objects in your chart. Edit graphical properties by accessing the editor object.

Functions

expand all

Stateflow Functions

`sfgco`	Selected objects in chart
`sfclipboard`	Stateflow clipboard object
`sfclose`	Close chart
`sfnew`	Create Simulink model that contains an empty Stateflow block
`sfopen`	Open existing model
`sfprint`	Print graphical view of charts
`sfroot`	Root object
`sfsave`	Save chart in current folder
`sfhelp`	Open Stateflow online help
`sflib`	Open Stateflow library window
`stateflow`	Open Stateflow library window and create Simulink model that contains an empty chart
`sfdebugger`	Open Stateflow Debugger
`sfexplr`	Open Model Explorer

Methods

expand all

Access

`classhandle`	Provide handle to schema class of object type
`defaultTransitions`	Return default transitions in object at top level of containment
`disp`	Display properties and settings for object
`find`	Specified objects in hierarchy
`get`	Return MATLAB structure containing property settings of object or array of objects
`help`	Display list of properties for object with accompanying descriptions
`innerTransitions`	Return inner transitions that originate with chart or state and terminate on contained object
`methods`	List methods belonging to object
`outerTransitions`	Return array of outer transitions for object
`set`	Set properties with specified values
`sinkedTransitions`	Return transitions that have object as destination
`sourcedTransitions`	Return transitions that have object as source
`struct`	Return MATLAB structure containing property settings of object
`up`	Return parent of object

Creation and Deletion

`copy`	Copy specified array of objects to clipboard
`delete`	Delete object
`pasteTo`	Paste objects in clipboard to specified container object
`setImage`	Insert image from clipboard or image file into an annotation
`Stateflow.Annotation`	Create annotation
`Stateflow.AtomicBox`	Create atomic box
`Stateflow.AtomicSubchart`	Create atomic subchart
`Stateflow.Box`	Create box
`Stateflow.Data`	Create data
`Stateflow.EMFunction`	Create MATLAB function
`Stateflow.Event`	Create event
`Stateflow.Function`	Create graphical function
`Stateflow.Junction`	Create junction
`Stateflow.Message`	Create message
`Stateflow.SimulinkBasedState`	Create Simulink based state
`Stateflow.SLFunction`	Create Simulink function
`Stateflow.State`	Create state
`Stateflow.Transition`	Create transition
`Stateflow.TruthTable`	Create truth table function

Debugging

`isCommented`	Determine if object is commented out
`parse`	Parse single chart or all charts in model

Display Control

`dialog`	Open properties dialog box of object
`fitToView`	Zoom in on graphical Stateflow object
`highlight`	Highlight graphical object in chart
`view`	Make object visible for editing
`zoomIn, zoomOut`	Zoom in or out on Stateflow chart

Topics

Overview of the Stateflow API

Create and edit Stateflow charts by using MATLAB commands.

Create and Destroy Stateflow Objects

Add and delete Stateflow objects to your chart.

Access Objects in Your Stateflow Chart

Create handles to manipulate Stateflow objects in your chart.

Copy and Paste Stateflow Objects

Access the clipboard object to duplicate Stateflow objects.

View Stateflow Graphical Objects

Use the fitToView method to zoom in on an object in your chart.

Move Stateflow Graphical Objects

Programmatically reposition states and subcharts.

Modify the Graphical Properties of Your Chart

Access the Editor object to perform graphical operations on a chart.

Create Default Transition Objects

Indicate which substate becomes active during state initialization.

Create Supertransition Objects

Connect transitions between different levels in a chart.

Specify Labels in States and Transitions Programmatically

Specify more than one line of text in your state and transition labels.

Featured Examples

Create Charts by Using the Stateflow API

Create a Stateflow® chart by using the Stateflow application programming interface (API). The Stateflow API is a tool to create or change Stateflow charts through MATLAB® commands. For more information, see Overview of the Stateflow API.

Open Live Script

Create Charts by Using a MATLAB Script

Include Stateflow® API commands in a MATLAB® function or script. Creating a script of API commands allows you to avoid repetitive chart creation steps and recreate the same model with a single command. For more information, see Overview of the Stateflow API.

Open Live Script

Stateflow Documentation

Support

Try MATLAB, Simulink, and Other Products

Get trial now