mlreportgen.report.Sparkline Class
Namespace: mlreportgen.report
Superclasses: mlreportgen.report.Reporter
Description
Use the mlreportgen.report.Sparkline to create a sparkline reporter.
The mlreportgen.report.Sparkline class is a handle class.
Creation
Description
reporter = mlreportgen.report.SparklineSparkline reporter object. Use the reporter properties
to specify the sparkline data, the appearance of the sparkline, the information to include
about the sparkline, and the report options. Adding an empty Sparkline
reporter to a report produces an error.
reporter = mlreportgen.report.Sparkline(PropertyName=Value)
Input Arguments
Properties
Methods
Examples
This example shows how to add sparklines to a report table.
Import the Report and DOM API namespaces so that you do not have to use long, fully qualified names.
import mlreportgen.report.* import mlreportgen.dom.*
Create a table that contains the sales data from January to June for four companies from the list of company names, the sales data, and the names of the months. The rows of the sales data matrix correspond to the companies and the columns correspond to the months.
companyNames = ["Apple", "Amazon", "Microsoft", "Google"]; salesData = [ 38, 56, 50, 2, 45, 65; % Data for Apple 43, 78, 53, 72, 48, 75; % Data for Amazon 50, 60, 55, 65, 52, 70; % Data for Microsoft 55, 70, 60, 75, 57, 80]; % Data for Google months = ["Jan", "Feb", "Mar", "Apr", "May", "Jun"];
The "companyNames" array is the first column, followed by columns for each month of sales data. The final column, "Trends", is empty. In this example, you will populate this column with the sparkline for each company.
tbl = table(companyNames', ... salesData(:, 1), salesData(:, 2), salesData(:, 3), ... salesData(:, 4), salesData(:, 5), salesData(:, 6), ... char.empty(4, 0), ... 'VariableNames', ['CompanyName', months, "Trends"]);
Create a new report titled "StockMarketReport" and specify the output format as PDF.
rpt = Report("StockMarketReport","pdf");
Create a MATLABTable reporter object from the table, tbl.
mlTable = MATLABTable(tbl);
Loop through each row in the table and perform the following operations to add sparklines from the sales data of each company.
Create a new table entry for the current row.
Create a sparkline for the sales data of the current company.
Get a snapshot image of the sparkline to include in the report.
Create a DOM image object using the captured snapshot image.
Append the DOM image to the table entry (this adds the sparkline to the cell).
Add the table entry to the corresponding row in the MATLAB table.
for iRow = 1:mlTable.Body.NRows tEntry = TableEntry(); sparkline = Sparkline(salesData(iRow, :)); image = getSnapshotImage(sparkline, rpt); domImage = Image(image); append(tEntry, domImage); append(mlTable.Body.row(iRow),tEntry); end
Append the table with sparklines to the report.
append(rpt,mlTable);
Close and view the report.
close(rpt); rptview(rpt);
This example shows how to add a customized sparkline with a caption to a report.
Import the Report and DOM API namespaces so that you do not have to use long, fully qualified names.
import mlreportgen.dom.* import mlreportgen.report.*
Create a report.
rpt = Report("MonthlyTrends", "pdf");
Create a table containing daily visitor data over four weeks and the total number of visitors for each week.
headerContent = {...
'Weeks', 'Day 1', 'Day 2', 'Day 3', 'Day 4', ...
'Day 5', 'Day 6', 'Day 7', 'Total Visitors'...
};
totalVisitors = [193, 213, 195, 152];
bodyContent = {...
'Week 1', 12, 18, 25, 30, 33, 35, 40, totalVisitors(1); ...
'Week 2', 19, 28, 30, 31, 31, 36, 38, totalVisitors(2); ...
'Week 3', 12, 26, 29, 26, 30, 31, 33, totalVisitors(3);
'Week 4', 21, 8, 19, 23, 21, 30, 30, totalVisitors(4)...
};Specify the table formatting.
tableStyle = {Width("80%"), ...
Border("solid"), ...
RowSep("solid"), ...
ColSep("solid")};Create the formal table with the specified content and formatting.
tbl = FormalTable(headerContent, bodyContent); tbl.Style = tableStyle;
Specify the header row formatting.
headerStyle = {BackgroundColor("Orange"), ...
Bold(true)};
firstRow = tbl.Children(1);
firstRow.Style = headerStyle;Set the table entries alignment to the center.
tbl.TableEntriesHAlign = "center";Append the table to the report.
append(rpt,tbl);
Add a paragraph explaining the sparkline.
append(rpt, LineBreak()); append(rpt,Paragraph(... "Sparkline illustrating the monthly trend of visitor attendance")); append(rpt, LineBreak());
Create, customize, and append the sparkline to the report.
sparkline = Sparkline(totalVisitors); sparkline.LineColor = "green"; sparkline.LineStyle = "dotted"; sparkline.LineWidth = "1.5pt"; sparkline.MarkerColor = "blue"; sparkline.MarkerStyle = "circle"; sparkline.MarkerPoints = "all"; sparkline.MarkerSize = "3pt"; sparkline.Snapshot.Height = "1in"; sparkline.Snapshot.Width = "5in"; sparkline.Snapshot.Caption = "Monthly trend of visitor attendance"; append(rpt,sparkline);
Close and view the report.
close(rpt); rptview(rpt);
Version History
Introduced in R2026a
