Stateflow Programmatic Interface

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

Programmatically create and edit Stateflow^® charts. Add new objects to your chart, access and edit properties, set positions, copy and paste objects, and change the magnification level of the Stateflow Editor.

Functions

expand all

Stateflow API Functions

`sfnew`	Create Simulink model that contains an empty Stateflow block
`sfroot`	Root of Stateflow hierarchy
`sfclipboard`	Clipboard object
`sfgco`	Selected objects in chart
`Stateflow.findMatchingPort`	Identify matching entry or exit port (Since R2021b)

Objects

expand all

Stateflow API Objects

Chart, Block, and Machine Objects

`Stateflow.Chart`	Graphical representation of a finite state machine
`Stateflow.StateTransitionTableChart`	Tabular representation of state machine for modal logic
`Stateflow.TruthTableChart`	Tabular representation of state machine for decision logic
`Stateflow.EMChart`	Stateflow interface to MATLAB Function block
`Stateflow.Machine`	Container for Stateflow blocks in a Simulink model

Graphical Objects

`Stateflow.Annotation`	Annotation in chart, state, box, or function
`Stateflow.AtomicBox`	Atomic box in chart, state, box, or function
`Stateflow.AtomicSubchart`	Atomic subchart in chart, state, or box
`Stateflow.Box`	Box in chart, state, box, or function
`Stateflow.EMFunction`	MATLAB function in chart, state, box, or function
`Stateflow.Function`	Graphical function in chart, state, box, or function
`Stateflow.Junction`	Connective or history junction in chart, state, box, or function
`Stateflow.Port`	Entry or exit port in state or atomic subchart (Since R2021b)
`Stateflow.SimulinkBasedState`	Simulink based state in chart, state, or box
`Stateflow.SLFunction`	Simulink function in chart, state, box, or function
`Stateflow.State`	State in chart, state, or box
`Stateflow.Transition`	Transition in chart, state, box, or function
`Stateflow.TruthTable`	Truth table function in chart, state, box, or function

Nongraphical Objects

`Stateflow.Data`	Data in chart, state, box, or function
`Stateflow.Event`	Event in chart, state, or box
`Stateflow.Message`	Message in chart, state, or box

Clipboard and Editor Objects

`Stateflow.Clipboard`	Clipboard to copy and paste Stateflow objects
`Stateflow.Editor`	Graphical aspects of a chart or state transition table

Object Functions

expand all

Stateflow API Object Functions

Navigate Hierarchy

`find`	Identify specified objects in hierarchy
`getChildren`	Identify children of object
`getParent`	Identify parent of object
`getReferences`	Identify references to symbol name
`commentedBy`	Identify objects that implicitly comment out a graphical object
`defaultTransitions`	Identify default transitions in specified object
`innerTransitions`	Identify inner transitions with specified source
`outerTransitions`	Identify outgoing transitions with specified source
`sinkedTransitions`	Identify transitions with specified destination
`sourcedTransitions`	Identify transitions with specified source

Access and Modify Properties

`dialog`	Open properties dialog box
`exportAsStruct`	Export contents of state transition table as structure array
`renameReferences`	Rename symbol and update references to symbol name
`setImage`	Insert image into annotation

Control Display

`view`	Display object in editing environment
`highlight`	Highlight graphical object
`fitToView`	Zoom in on graphical object
`zoomIn`	Zoom in on Stateflow chart
`zoomOut`	Zoom out on Stateflow chart

Map Symbols in Atomic Subcharts and Simulink Based States

`getMappingForSymbol`	Get mapping for symbol in atomic subchart, atomic box, or Simulink based state
`setMappingForSymbol`	Set mapping for symbol in atomic subchart, atomic box, or Simulink based state
`clearMappingForSymbol`	Clear mapping for symbol in atomic subchart, atomic box, or Simulink based state
`disableMappingForSymbol`	Disable input event in atomic subchart or box

Copy and Paste Objects

`copy`	Copy array of objects to clipboard
`pasteTo`	Paste objects in clipboard to specified container object

Convert Charts and State Transition Tables

`convertToChart`	Convert state transition table to Stateflow chart
`convertToSTT`	Convert Stateflow chart to state transition table

Topics

Overview of the Stateflow API

Create and edit Stateflow charts by using MATLAB commands.
- Summary of Stateflow API Objects and Properties
Create and Delete Stateflow Objects
Design your Stateflow chart by adding and deleting objects.
Access Objects in Your Stateflow Chart
Locate objects contained in your Stateflow chart.
Modify Properties and Call Functions of Stateflow Objects
Manipulate Stateflow objects by modifying properties and calling functions.
Specify Labels in States and Transitions Programmatically
Add labels with one or more lines of text to states and transitions.
Set Configuration Parameters Programmatically
Use the command-line API to set parameters in the Configuration Parameters dialog box.

Featured Examples

Create Charts by Using the Stateflow API

Create a Stateflow chart by using the Stateflow application programming interface (API).

Open Live Script

Create Charts by Using a MATLAB Script

Include Stateflow API commands in a MATLAB function or script.

Open Live Script

Refactor Charts Programmatically

Detect and resolve common stylistic patterns that hinder chart legibility.

Open Live Script