Main Content

Create Report Programs Using the Report API

Write MATLAB® programs that generate reports

To create programs that generate reports about Simulink® models and Stateflow® charts, use the Simulink Report Generator™ Report API together with the MATLAB Report Generator Report API and DOM API. The Simulink Report Generator Report API provides classes that you can use to find and format information about Simulink models and Stateflow charts. The MATLAB Report Generator API provides classes that you can use to create and format a title page, table of contents, chapters, and other report elements.


expand all container

Creation Finders

slreportgen.finder.BlockResult Create block finder result object
slreportgen.finder.ChartDiagramFinder Create Stateflow chart finder
slreportgen.finder.DiagramElementFinderCreate diagram element finder object
slreportgen.finder.DiagramElementResult Create diagram element finder result object
slreportgen.finder.DiagramFinder Create finder for diagrams
slreportgen.finder.DiagramResult Create diagram result finder object
slreportgen.finder.StateflowObjectResult Create Stateflow result object (Since R2023a)
slreportgen.finder.SystemDiagramFinder Create block diagram finder

Search Finders

slreportgen.finder.AnnotationFinder Find Simulink annotation objects
slreportgen.finder.BlockFinder Find Simulink blocks
slreportgen.finder.DataDictionaryFinderFind data dictionaries (Since R2020b)
slreportgen.finder.EnumerationTypeFinderFind enumerated data types used in Simulink model (Since R2023b)
slreportgen.finder.ModelVariableFinderFinds variables used by a Simulink model (Since R2019b)
slreportgen.finder.SignalFinderFind signals used by model or block (Since R2021a)
slreportgen.finder.StateFinder Find Stateflow states
slreportgen.finder.StateflowDiagramElementFinderFind Stateflow diagram elements
slreportgen.finder.StateflowObjectFinderFind Stateflow objects (Since R2023a)

Search Result Finders

slreportgen.finder.DataDictionaryResultData dictionary search result object (Since R2020b)
slreportgen.finder.EnumerationTypeResultSearch results for enumeration types found within Simulink model or subsystem (Since R2023b)
slreportgen.finder.FunctionReferenceResultSearch result object that represents a MATLAB function reference (Since R2022a)
slreportgen.finder.ModelVariableResultModel variable search result object (Since R2019b)
slreportgen.finder.SignalResultSignal search result object (Since R2021a)

Superclass for Reporters for Simulink reporters (Since R2021a)

Model Reporters data dictionary reporter (Since R2020b) enumerated data type reporter (Since R2023b) task and block execution order reporter (Since R2020b) for MATLAB function references (Since R2022a) configuration set reporter (Since R2020b) variable reporter (Since R2019b) or Stateflow diagram notes reporter (Since R2020a) Report Explorer-based reporter hierarchy reporter (Since R2019b)

Diagram Reporters on Simulink annotations (Since R2022b) Caller block reporter (Since R2022a) Function block reporter (Since R2021b) diagram reporter DocBlock reporter (Since R2019b) Element diagram snapshot and caption reporter table block reporter Function block or Stateflow MATLAB function reporter System block reporter (Since R2023a) object properties reporter object properties reporter Transition Table Reporter (Since R2022a) Sequence block reporter (Since R2020b) Truth table reporter

Signal Reporters for buses selected or created by Simulink blocks (Since R2021a) bus object reporter (Since R2019b) reporter (Since R2021a) system input and output signal reporter (Since R2020a)

Summary Table Reporter Summary table reporter for finder results (Since R2022a)


Related Information