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.

Classes

expand all

Report Container

slreportgen.report.Report Report container

Finders

Creation Finders

`slreportgen.finder.BlockResult`	Create block finder result object
`slreportgen.finder.ChartDiagramFinder`	Create Stateflow chart finder
`slreportgen.finder.DiagramElementFinder`	Create 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.DataDictionaryFinder`	Find data dictionaries (Since R2020b)
`slreportgen.finder.EnumerationTypeFinder`	Find enumerated data types used in Simulink model (Since R2023b)
`slreportgen.finder.ModelVariableFinder`	Find variables used by Simulink model
`slreportgen.finder.SignalFinder`	Find signals used by model or block (Since R2021a)
`slreportgen.finder.StateFinder`	Find Stateflow states
`slreportgen.finder.StateflowDiagramElementFinder`	Find Stateflow diagram elements
`slreportgen.finder.StateflowObjectFinder`	Find Stateflow objects (Since R2023a)

Search Result Finders

`slreportgen.finder.DataDictionaryResult`	Data dictionary search result object (Since R2020b)
`slreportgen.finder.EnumerationTypeResult`	Search results for enumeration types found within Simulink model or subsystem (Since R2023b)
`slreportgen.finder.FunctionReferenceResult`	Search result object that represents a MATLAB function reference (Since R2022a)
`slreportgen.finder.ModelVariableResult`	Model variable search result object
`slreportgen.finder.SignalResult`	Signal search result object (Since R2021a)

Reporters

Superclass for Reporters

slreportgen.report.Reporter Superclass for Simulink reporters (Since R2021a)

Model Reporters

`slreportgen.report.DataDictionary`	Simulink data dictionary reporter (Since R2020b)
`slreportgen.report.EnumerationType`	Simulink enumerated data type reporter (Since R2023b)
`slreportgen.report.ExecutionOrder`	System task and block execution order reporter (Since R2020b)
`slreportgen.report.FunctionReference`	Reporter for MATLAB function references (Since R2022a)
`slreportgen.report.ModelConfiguration`	Model configuration set reporter (Since R2020b)
`slreportgen.report.ModelVariable`	Model variable reporter
`slreportgen.report.Notes`	Simulink or Stateflow diagram notes reporter
`slreportgen.report.RptFile`	Create Report Explorer-based reporter
`slreportgen.report.ScopeSnapshot`	Create Simulink scope snapshot reporter (Since R2024b)
`slreportgen.report.SystemHierarchy`	System hierarchy reporter

Diagram Reporters

`slreportgen.report.Annotation`	Report on Simulink annotations (Since R2022b)
`slreportgen.report.CCaller`	C Caller block reporter (Since R2022a)
`slreportgen.report.CFunction`	C Function block reporter (Since R2021b)
`slreportgen.report.Diagram`	Create diagram reporter
`slreportgen.report.DocBlock`	`DocBlock` reporter
`slreportgen.report.ElementDiagram`	Element diagram snapshot and caption reporter
`slreportgen.report.LookupTable`	Lookup table block reporter
`slreportgen.report.MATLABFunction`	MATLAB Function block or Stateflow MATLAB function reporter
`slreportgen.report.MATLABSystem`	MATLAB System block reporter (Since R2023a)
`slreportgen.report.ScheduleDiagram`	Create schedule diagram reporter (Since R2024b)
`slreportgen.report.SimulinkObjectProperties`	Simulink object properties reporter
`slreportgen.report.StateflowObjectProperties`	Stateflow object properties reporter
`slreportgen.report.StateTransitionTable`	State transition table reporter (Since R2022a)
`slreportgen.report.TestSequence`	Test Sequence block reporter (Since R2020b)
`slreportgen.report.TruthTable`	Truth table reporter

Signal Reporters

`slreportgen.report.Bus`	Reporter for buses selected or created by Simulink blocks (Since R2021a)
`slreportgen.report.BusObject`	Simulink bus object reporter
`slreportgen.report.Signal`	Signal reporter (Since R2021a)
`slreportgen.report.SystemIO`	Simulink system input and output signal reporter

Snapshot Reporters

`slreportgen.report.Diagram`	Create diagram reporter
`slreportgen.report.ElementDiagram`	Element diagram snapshot and caption reporter
`slreportgen.report.ScheduleDiagram`	Create schedule diagram reporter (Since R2024b)
`slreportgen.report.ScopeSnapshot`	Create Simulink scope snapshot reporter (Since R2024b)

Summary Table Reporter

slreportgen.report.SummaryTable Summary table reporter for finder results (Since R2022a)

Topics

Create Simulink Report Generator Reports
Use the Report API to create System Design Description reports.
Generate System Design Reports with Report API
Create a report program to generate a description of the design of a dynamic system.
Report on MATLAB Functions
Report on Simulink MATLAB Function blocks or Stateflow MATLAB functions.
Reporting on DocBlock Blocks
Use slreportgen.report.DocBlock reporters to include contents of DocBlock blocks in a report.
Report Model Notes
Use an slreportgen.report.Notes reporter to report on model notes.
Create Simulink Bus Object Reports
Create report of bus objects used in a Simulink model.
Report System Inputs and Outputs
Use an slreportgen.report.SystemIO object to report on model and subsystem inputs and outputs.
Report Systems Hierarchically
Create report with model systems numbered hierarchically.
Report Execution Order of Tasks and Blocks in Simulink Systems
Use an slreportgen.report.ExecutionOrder reporter to report on the tasks executed by a model and the order in which the blocks execute during each task.
Tile Simulink Diagrams
Span a Simulink diagram across multiple pages of a report.
Customize Simulink Diagram Hyperlinks in HTML and PDF Reports
Customize hyperlink target for a block.
Use Simulink Report Explorer Components in Report API Reports
Use RptFile reporter to add Report Explorer component content to a Report API report.

Related Information

Report Generator Creation