Common

`smartreport.v3.reports.common.sections.executive_summary.ExecutiveSummarySection`

Bases: ReportSection

Adds the Executive Summary section to the report.

In interactive reports it is a dynamic section that provided a text-area input. In static reports it is only a Header with a placeholder.

`Settings`

Bases: Settings

Attributes:

Name	Type	Description
`TEXTAREA_HEIGHT`	`int`	Initial height of the textarea component used for entering executive summary. Default: 300

`smartreport.v3.reports.common.sections.glossary_table.GlossaryTableSection`

Bases: ReportSection

Creates a Glossary Table section.

It is made of a table with two columns: Abbreviation and Explanation. The table is filled with data from common.definitions.GLOSSARY_DATA, filtered by ELEMENTS attribute.

That means if we want to add a new element to the glossary, we have to add it to GLOSSARY_DATA and then add it to ELEMENTS attribute.

`Settings`

Bases: Settings

Attributes:

Name	Type	Description
`ELEMENTS`	`List[str]`	List of elements to be explained in glossary. They have to come from `common.definitions.GLOSSARY_DATA`.

`smartreport.v3.reports.common.sections.basic.NewLineSection`

Bases: ReportSection

Adds a new line to the document.

`smartreport.v3.reports.common.sections.basic.PageBreakSection`

Bases: ReportSection

Adds a Page Break to the document.

`smartreport.v3.reports.common.sections.toc.TOCSection`

Bases: ReportSection

Adds automatic Table of Content to the report.

`Settings`

Bases: Settings

Attributes:

Name	Type	Description
`TOC_DEPTH`	`int`	Depth of Table of content. It means, how many levels of headings should be used to create table of content.

`smartreport.v3.reports.common.sections.title.TitleSection`

Bases: ReportSection

Adds first page title and picture to the report.

`Settings`

Bases: Settings

Attributes:

Name	Type	Description
`REPORT_PROVIDER`	`str`	Name of the report provider. Default: `ABB Motion Services`
`MAIN_TITLE`	`str`	Main title of the report. Default: `ABB Ability™ Digital Powertrain`
`SUB_TITLE`	`str`	Subtitle of the report. Default `Default Report`
`IMAGE_PATH`	`Path`	Path to the first page image. Default: `STATIC_FOLDER_PATH / first_page_picture.jpg`