Rockwell Automation 9307 FactoryTalk EnergyMetrix - Manual (Page 258)

FactoryTalk EnergyMetrix Software
258
Methods
Value type or tag related methods (for example, Average, Peak) of the Report object return
aggregated results based on all selected meters in the report. For more information on
usage of the methods, refer to the applicable rate schedule functions.
ShowPageHeader As Boolean R/W Controls the visibility of the standard page
header. Default value is true
ShowPageFooter As Boolean R/W Controls the visibility of the standard page
footer. Default value is true
StartDateTime As DateTime R/W The starting date/time of the report date range
Weeks As Weeks R Collection of Week objects that represent the
report date range in periods of week length
Property R/W Description
Method Description
Add(Grid As Grid, Left As Double, Top
As Double) Add a grid object to the report at the specified coordinates. Any
subsequent changes to the grid object will not appear on the report
Add(PieChart As PieChart, Left As
Double, Top As Double, Width As
Double, Height As Double) Add a pie chart object to the report with the specified coordinates and
size. Any subsequent changes to the pie chart object will not appear
on the report
Add(TrendChart As TrendChart, Left As
Double, Top As Double, Width As
Double, Height As Double) Add a trend chart object to the report with the specified coordinates
and size. Any subsequent changes to the trend chart object will not
appear on the report
Add(RichTextBox As RichTextBox, Left
As Double, Top As Double, Width As
Double, Height As Double) Add a rich text box object to the report with the specified coordinates
and size. Any subsequent changes to the rich text box object will not
appear on the report
AddGroup() Add a new logical group to the report in addition to the groups
selected in the report setup page. Typical usage:
Dim groupName As Group
groupName = report.AddGroup()
The new group can be accessed by using its group name or index
number (Report.Groups(n)). It can be populated with meters by using
the AddMeters method of the Group object.
AddLine(float X1, float Y2, float Y1,
float Y2[, float LineWeight]) Add a line to the report at the specified coordinates. The line weight
will be one (or defined by the optional LineWeight argument if
present)