ReportPageStatus
One workspace page as the report sees it.
Constructor
Signature
ReportPageStatus(page: 'Page', status: ReportPageStatusValue, plot_count: int) -> NoneParameters
| Name | Type | Requirement | Default | Description |
|---|---|---|---|---|
page | 'Page' | Required | — | Workspace page. |
status | ReportPageStatusValue | Required | — | included, hidden when the page is hidden from reports, or no_series when none of its plots has a series. |
plot_count | int | Required | — | Number of plots with at least one series on the page. |
Example
[status.status for status in workspace.report.pages]
Properties
page
The workspace page this status describes.
Type: 'Page'
Access: read
Example
print(status.page)
plot_count
Plots with at least one series, which become report figures when included.
Type: int
Access: read
Example
print(status.plot_count)
status
included, hidden or no_series.
Type: ReportPageStatusValue
Access: read
Example
print(status.status)
Related guides
- Create PDF and Word Reports: Fill the report, choose its pages, and export the document.