Difference between revisions of "Report Options"

From Lianjapedia
Jump to: navigation, search
Line 15: Line 15:
 
Double-click the Section header or click the cog icon to access the Section Attributes.
 
Double-click the Section header or click the cog icon to access the Section Attributes.
  
The Details section at the top of the attributes dialog holds the specification of the '''database''' and '''table'''.
+
The Details section at the top of the attributes dialog holds the specification of the '''Database''' and '''Table'''.
  
 
The Report Section options are described here.
 
The Report Section options are described here.
Line 22: Line 22:
  
 
===Report type===
 
===Report type===
Select from a known report type (Tabular)
+
The '''Report type''' attribute specifies the report layout type.  Currently, ''Tabular'' is supported.
  
 
===Heading===
 
===Heading===
The report heading
+
The '''Heading''' attribute specifies text to use as the report heading.
  
The Heading attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportHeading]].
+
The '''Heading''' attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportHeading]].
  
 
[[#Notes on Client Support|Notes on Client Support]]
 
[[#Notes on Client Support|Notes on Client Support]]
  
 
===Filter===
 
===Filter===
The filter expression that restricts which records will be included in the report
+
The '''Filter''' attribute specifies a logical expression used to restrict which records will be included in the report.
  
The Filter attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportFilter]].
+
The '''Filter''' attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportFilter]].
  
 
[[#Notes on Client Support|Notes on Client Support]]
 
[[#Notes on Client Support|Notes on Client Support]]
  
 
===Fields===
 
===Fields===
A comma separated list of field names or expressions (* selects all fields in the table)
+
The '''Fields''' attribute specifies the fields to be included in the report.  This should be a comma separated list of field names or expressions. '''*''' selects all fields in the table.
  
The Fields attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportFields]].
+
The '''Fields''' attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportFields]].
  
 
[[#Notes on Client Support|Notes on Client Support]]
 
[[#Notes on Client Support|Notes on Client Support]]
 
===Columns===
 
===Columns===
A comma separated list of column positions from the fields selected, e.g. 2,4,7,1.
+
The '''Columns''' attribute specifies the column positions for the selected fields in the report.  This should be a comma separated list of numeric column positions.
  
The Columns attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportColumns]].
+
The '''Columns''' attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportColumns]].
  
 
[[#Notes on Client Support|Notes on Client Support]]
 
[[#Notes on Client Support|Notes on Client Support]]
  
 
===Column headings===
 
===Column headings===
A comma separated list of report column headings
+
The '''Column headings''' attribute specifies the text to be used as the report column headings.  This should be a comma separated list of text strings.
  
The Column headings attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportColumnHeadings]] or [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportHeadings]].
+
The '''Column headings''' attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportColumnHeadings]] or [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportHeadings]].
  
 
[[#Notes on Client Support|Notes on Client Support]]
 
[[#Notes on Client Support|Notes on Client Support]]
  
 
===Subtotals===
 
===Subtotals===
A comma separated list of column positions from the fields selected to subtotal on
+
The '''Subtotals''' attribute specifies the columns in the report to be sub-totalled.  This should be a comma separated list of numeric column positions.
  
The Subtotals attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportSubTotals]].
+
The '''Subtotals''' attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportSubTotals]].
  
 
[[#Notes on Client Support|Notes on Client Support]]
 
[[#Notes on Client Support|Notes on Client Support]]
 +
 
===Group by===
 
===Group by===
The field name or expression that data will be grouped by for sub totalling
+
The '''Group by''' attribute specifies the name of the field or the expression that the report data will be grouped by for sub-totalling.
  
The Group by attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportGroupBy]].
+
The '''Group by''' attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportGroupBy]].
  
 
[[#Notes on Client Support|Notes on Client Support]]
 
[[#Notes on Client Support|Notes on Client Support]]
Line 74: Line 75:
 
A comma separated list of field names to render as hyperlinks for searching
 
A comma separated list of field names to render as hyperlinks for searching
  
The Hyperlinks attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportHyperlink]].
+
The '''Hyperlinks''' attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportHyperlink]].
  
 
[[#Notes on Client Support|Notes on Client Support]]
 
[[#Notes on Client Support|Notes on Client Support]]
Line 81: Line 82:
 
Show grid lines for each row of the report (True | False).
 
Show grid lines for each row of the report (True | False).
  
The Show grid lines attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportGridLines]].
+
The '''Show grid lines''' attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportGridLines]].
  
 
[[#Notes on Client Support|Notes on Client Support]]
 
[[#Notes on Client Support|Notes on Client Support]]
Line 94: Line 95:
 
Other report options
 
Other report options
  
The Other options attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportOtherOptions]].
+
The '''Other options''' attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page.section").reportOtherOptions]].
  
 
[[#Notes on Client Support|Notes on Client Support]]
 
[[#Notes on Client Support|Notes on Client Support]]

Revision as of 08:01, 20 January 2016

Under Construction

See Also

Report Section Attributes

Overview

Report options

Report Section options



Double-click the Section header or click the cog icon to access the Section Attributes.

The Details section at the top of the attributes dialog holds the specification of the Database and Table.

The Report Section options are described here.


Report type

The Report type attribute specifies the report layout type. Currently, Tabular is supported.

Heading

The Heading attribute specifies text to use as the report heading.

The Heading attribute can be queried or changed programmatically using Lianja.getElementByID("page.section").reportHeading.

Notes on Client Support

Filter

The Filter attribute specifies a logical expression used to restrict which records will be included in the report.

The Filter attribute can be queried or changed programmatically using Lianja.getElementByID("page.section").reportFilter.

Notes on Client Support

Fields

The Fields attribute specifies the fields to be included in the report. This should be a comma separated list of field names or expressions. * selects all fields in the table.

The Fields attribute can be queried or changed programmatically using Lianja.getElementByID("page.section").reportFields.

Notes on Client Support

Columns

The Columns attribute specifies the column positions for the selected fields in the report. This should be a comma separated list of numeric column positions.

The Columns attribute can be queried or changed programmatically using Lianja.getElementByID("page.section").reportColumns.

Notes on Client Support

Column headings

The Column headings attribute specifies the text to be used as the report column headings. This should be a comma separated list of text strings.

The Column headings attribute can be queried or changed programmatically using Lianja.getElementByID("page.section").reportColumnHeadings or Lianja.getElementByID("page.section").reportHeadings.

Notes on Client Support

Subtotals

The Subtotals attribute specifies the columns in the report to be sub-totalled. This should be a comma separated list of numeric column positions.

The Subtotals attribute can be queried or changed programmatically using Lianja.getElementByID("page.section").reportSubTotals.

Notes on Client Support

Group by

The Group by attribute specifies the name of the field or the expression that the report data will be grouped by for sub-totalling.

The Group by attribute can be queried or changed programmatically using Lianja.getElementByID("page.section").reportGroupBy.

Notes on Client Support

Hyperlinks

A comma separated list of field names to render as hyperlinks for searching

The Hyperlinks attribute can be queried or changed programmatically using Lianja.getElementByID("page.section").reportHyperlink.

Notes on Client Support

Show grid lines

Show grid lines for each row of the report (True | False).

The Show grid lines attribute can be queried or changed programmatically using Lianja.getElementByID("page.section").reportGridLines.

Notes on Client Support

Pagination

Paginate the rows displayed (True | False).

Pagination size

The number of rows to paginate

Other options

Other report options

The Other options attribute can be queried or changed programmatically using Lianja.getElementByID("page.section").reportOtherOptions.

Notes on Client Support

Notes on Client Support

Attribute Notes
Report type -
Heading Lianja.getElementByID("page.section").reportHeading is exposed on the Desktop client only (Lianja/VFP).
Filter Lianja.getElementByID("page.section").reportFilter is exposed on the Desktop client only (Lianja/VFP).
Fields Lianja.getElementByID("page.section").reportFields is exposed on the Desktop client only (Lianja/VFP).
Columns Lianja.getElementByID("page.section").reportColumns is exposed on the Desktop client only (Lianja/VFP).
Column headings Lianja.getElementByID("page.section").reportColumnHeadings and Lianja.getElementByID("page.section").reportHeadings are exposed on the Desktop client only (Lianja/VFP).
Subtotals Lianja.getElementByID("page.section").reportSubTotals is exposed on the Desktop client only (Lianja/VFP).
Group by Lianja.getElementByID("page.section").reportGroupBy is exposed on the Desktop client only (Lianja/VFP).
Hyperlinks Lianja.getElementByID("page.section").reportHyperlink is exposed on the Desktop client only (Lianja/VFP).
Show grid lines Lianja.getElementByID("page.section").reportGridLines is exposed on the Desktop client only (Lianja/VFP).
Pagination -
Pagination size -
Other options Lianja.getElementByID("page.section").reportOtherOptions is exposed on the Desktop client only (Lianja/VFP).