Report

The Report class is the Moxy db.  This is a key-value store that makes report data available to the report. There are three types of data in the Report ReportBuilder populates the report data from the dataSources in the report.

Properties

FinancialYearEnd

Gets and sets the financial year end.  By default, 31 March.

ReportDate

The date that the report is being run for.  This can be referenced as RD in the report.

FirstDate

The date of the earliest SubjectData in the report.

LastDate

The date of the latest SubjectData in the report.

ReportDataAsXml

The SubjectData in the report, exported as XML and used by the ReportProfiler and also used to publish report data if required.

Methods

AddReportHeader

Report headers can store information like colours, logos and static information such as the organisationName which can then be used to customise the report.

AddSubjectData

Adds data to the report. See the definition of SubjectData below.

SetVariable

Sets the value of a variable in the report.  Variables don’t use a subjectCode and metric, they just have an name and are referenced in a formula using $variableName.

Reset

Clears all data from memory.

ClearFilters

Removes all filters of the specified type.

AddFilter

Adds a dimension filter.  This is used by Repeats to filter a page, section, rowGroup or chart by a specific dimension value.

LoadSubjectData

Allows subject data to be loaded from an Xml file or XmlNode.

RGB

A function that is used in PDF reports to convert an RGB colour code and an opacity to a new RGB code that represents the colour with the opacity applied.

GetSubjectValue

Executes a Subject Formula and a Metric Formula over the report data and returns a SubjectValue, which can contain a string, number, money, percentage, etc and be formatted using a format string.

GetTotalValue

Executes a Subject Formula and a Metric Formula over the report data and returns a decimal total.

GetStartOfFinancialYear

Takes a date and returns the start of the financial year for that date, plus or minus a specified number of years.

GetEndOfFinancialYear

Takes a date and returns the end of the financial year for that date, plus or minus a specified number of years.


Click to see Comments

Help comments powered by Disqus