mplreport
The mplreport class is used to easily create reports.
Many of the settings of your report are pre-loaded into the object by the reporting engine.
Member Functions
AIChannel - Writes an array of information out for AI processing, used by the report engine to detect if reports are showing 'normal' or 'unexpected' values.
CreatePage - Starts a new report page.
Clear - Deletes the PDF being produced to begin the report again.
DateFormat - Formats a date using a format that suits the range of the report.
Failed - Used to create a simple error message on the report when the report has failed. Automatically called if an uncaught exception happens.
FailedAxis - Used to mark a particular set of axes as invalid - often used in try-catch handlers to catch unexpected problems in code.
FetchHistory - Gets history from an AQL statement, returning both a Pandas dataframe and metadata about the properties.
GetAnalogueColourMap - Gets a MatPlotLib colour map for analogue/continuous data. Defaults to viridis if there aren't custom colours defined.
GetDiscreteLegend - Gets the components of a custom legend for discrete, coloured data
GetDiscreteColourMap - Gets a colour map suitable for discrete data
Grid - Used to set up a simple, consistent grid on a set of axes
HeatMapTimeAxis - Used to create a date/time axis when you are plotting without a date index
LocalTime - Converts a UTC time to a local time.
Save - Saves the report
SimplifyTicks - Removes common text from an array of values. Usually used when one of your axes is a list of assets that might share part of their name in common.
Title - Creates a simple title at the top of the page, including the logo, report name and range.
TimeAxis - Formats an axis to use a suitable time format.
UTCTime - Convert a local datetime to a UTC datetime.
See Also
You might want to check out the KPICapture class as well, which is used to capture simple KPIs from daily reporting so you can use them in long-term reporting (such as weekly or monthly summaries).