Package: mlreportgen.report
Superclasses: mlreportgen.report.Reporter
List of tables reporter
Use an object of the mlreportgen.report.ListOfTables
class to create a
reporter that adds a list of tables section to a report. The generated list of tables contains
the titles of the tables that are represented as mlreportgen.report.BaseTable
objects in your report generation program. The list
items link to the titles in the report. In PDF and Word reports, the list also includes the
page numbers of the titles in the report. A leader fills the space between a title and the
page number.
The way the list of tables is generated depends on the report type:
PDF — The Report API generates the list during report generation.
Word — The Report API generates a placeholder for the list. To generate the list items, you must update the Word document in your report generation program or in Word. See Update a Table of Contents or Generated List in a Word Document.
HTML — The Report API generates a placeholder for the list. When the report opens in an HTML browser, the browser generates the list in a sidebar.
The mlreportgen.report.ListOfTables
class is a handle
class.
creates a lot
= mlreportgen.report.ListOfTables()ListOfTables
reporter with default property values.
creates a lot
= mlreportgen.report.ListOfTables(title
)ListOfTables
reporter with the Title
property set to the specified title.
sets properties using name-value pairs. You can specify multiple name-value pair arguments
in any order. Enclose each property name in single or double quotes.lot
= mlreportgen.report.ListOfTables(Name,Value
)
mlreportgen.report.BaseTable
| mlreportgen.report.ListOfCaptions
| mlreportgen.report.ListOfFigures
| mlreportgen.report.ReporterLayout
| mlreportgen.report.TableOfContents