Paragraphs, Text Strings, and Numbers
Generate and format paragraphs, text, and numbers
Classes
mlreportgen.dom.Paragraph | Formatted block of text |
mlreportgen.dom.Preformatted | Preformatted block of text (Since R2020a) |
mlreportgen.report.Section | Section reporter |
mlreportgen.dom.Text | Text object |
mlreportgen.dom.Number | Number to include as formatted text in a document (Since R2021a) |
mlreportgen.dom.Leader | Leader character for PDF output |
mlreportgen.dom.FirstLineIndent | Indent first line of paragraph |
mlreportgen.dom.LineSpacing | Spacing between lines of paragraph |
mlreportgen.dom.OutlineLevel | Level of paragraph in outline |
mlreportgen.dom.HAlign | Specify horizontal alignment of document object |
mlreportgen.dom.VAlign | Vertical alignment of document object |
mlreportgen.dom.PageRef | Create placeholder for reference to page number of link target |
mlreportgen.dom.XRef | Cross-reference element for DOCX or PDF report (Since R2022a) |
mlreportgen.dom.StyleRef | Placeholder for reference to content with specified style name or outline level |
mlreportgen.dom.Display | Display option for DOM objects |
mlreportgen.dom.DOCXPageLayout | Page format and layout for section of Microsoft Word document |
mlreportgen.dom.DOCXPageFooter | Page footer definition for Microsoft Word document |
mlreportgen.dom.Heading | Heading paragraph using variable level |
mlreportgen.dom.Heading1 | Create Heading1 paragraph |
mlreportgen.dom.Heading2 | Create Heading2 paragraph |
mlreportgen.dom.Heading3 | Create Heading3 paragraph |
mlreportgen.dom.Heading4 | Create Heading4 paragraph |
mlreportgen.dom.Heading5 | Create Heading5 paragraph |
mlreportgen.dom.Heading6 | Create Heading6 paragraph |
mlreportgen.dom.FontFamily | Font family |
mlreportgen.dom.FontSize | Font size |
mlreportgen.dom.Bold | Bold for text object |
mlreportgen.dom.Italic | Italic for mlreportgen.dom.Text object |
mlreportgen.dom.Color | Color of document element |
mlreportgen.dom.Strike | Strike through text |
mlreportgen.dom.Underline | Draw line under text |
mlreportgen.dom.NumberFormat | Number formatting (Since R2021a) |
Functions
mlreportgen.dom.setDefaultNumberFormat | Set default formatting of numeric data generated by DOM API (Since R2021a) |
mlreportgen.dom.getDefaultNumberFormat | Get default formatting for numeric data generated by DOM API (Since R2021a) |
Topics
- Create and Format Text
Add and format text for a report.
- Create and Format Paragraphs
Add and format paragraphs for a report.
- Specify Space Between Paragraphs
Change the spacing between paragraphs in a report.
- Format Numbers
Specify the format to use when representing a number as text in a document.
- Format Numbers in Tables
Format numbers in a table using an
mlreportgen.dom.NumberFormat
object. - What Are Reporters?
Get an overview of reporters and how to use them, and an overview of Report and DOM APIs.
- Define New Reporters
Create a custom reporter based on
mlreportgen.report.Reporter
. - Subclass Reporter Definitions
Copy and edit a reporter based on a built-in reporter.