Report Section

From Lianjapedia
Jump to: navigation, search

Overview

Report Sections are used to display tabular reports.

Report section.png

You build Apps in Lianja App Builder visually using the Page Builder.

If you have not yet done so please read Understanding the Lianja Architecture and also Understanding ART to better understand this article.

An App consists of pages. Pages are made up of Sections. Form sections are made up of FormItems. We call these collectively "UI Elements" or "Visual Elements".

Setting Attributes Declaratively

You adjust the appearance and behavior of each UI Element in the Attributes Tab of the App Inspector.

Bm-attributes.png

The attributes available consist of some common ones as well as some specific to the UI Element being inspected.

Getting and Setting Attributes Programmatically

The setAttribute(name, value) method can be used to set the value of an Attribute:

Lianja.get("pageid.sectionid").setAttribute("title","Section1")

Note: on the desktop, the shortened form setAttr(name,value) is also available.

The getAttribute(name) method can be used to get the value of an Attribute:

cTitle = Lianja.get("pageid.sectionid").getAttribute("title")

Note: on the desktop, the shortened form getAttr(name) is also available.

See Also

Developing Quick Reports, Report Options

Demo Apps (included in the Lianja App Builder distribution):

  • Lianja Web UI Demo (example_webapp2)

Attributes

Details

Attribute Description Name Type
Name The name for this section (unique to the page) id Character
Full name The full name for this section including its parent page, e.g. page1.section1 fullid Character
Alias name The alias name for this section aliasid Character
App Doc The App Doc file for this section. This will be included in the App Doc when it is generated. appdoc Character
MetaData version The MetaData version number. You can set this in the setupUI hook to prevent MetaData being applied multiple times. metaDataVersion Int
Meta types A comma separated list of metatype names metatypes Character
Type The type of section: report (readonly) type Character
Caption The section caption displayed in the section header title Character
Database The database for this section database Character
Table The table for this section table Character
Height The section height height Int
Fixed height Fix the section height (True | False) fixedHeight Boolean
Auto layout percent Auto layout percentage of page size. If set to 0, then all sections on a page are resized to an equal height autoLayoutPercentage Int

Appearance

Attribute Description Name Type
Margin Margin size around the section margin Int
Add spacer at bottom Add spacer at bottom of section (True | False) spacerVisible Boolean

Header

Attribute Description Name Type
Hide header Hide section header at runtime(True | False) hideHeaderAtRuntime Boolean
Hide actionbar Hide actionbar buttons in the section header (True | False) hideActionBarAtRuntime Boolean
Header CSS style CSS style (separate attributes with ; or use app:/filename.css) headerCssStyle Character
Header icon The image for the Header (png | jpg | gif).
Use app:/imagename.ext for app specific images.
headerIcon Character
Gradient colors Render the Header background color as a gradient (True | False) headerGradient Boolean
Gradient type Specify the gradient type headerGradientType Int
Gradient start color Gradient start color headerFromColor Character
Gradient end color Gradient end color headerToColor Character
Show Print button Show Print button in the section header (True | False) showPrintButton Boolean
Show Edit button Show Edit button in the section header (True | False) showEditButton Boolean
Hide custom search icon Hide the custom search icon (True | False) hideCustomSearchIcon Boolean
Show custom search dialog Show the custom search dialog when the custom search icon is clicked (True | False) showCustomSearchDialog Boolean
Show custom search dialog panel Show the custom search dialog panel when the custom search icon is clicked (True | False) showCustomSearchDialogPanel Boolean
Show info tips icon Show the info tips icon in the section header (True | False) showInfoTipsIcon Boolean
Show help icon Show the help icon in the section header (True | False) showHelpIcon Boolean
Help topic Help topic to display when the help icon is clicked in the section header helpTopic Character

Custom Header Style

Attribute Description Name Type
Use custom header style Use a custom header style (True | False) headercustomstyle Boolean
Header background color Header background color headerbackcolor Character
Header foreground color Header foreground color headerforecolor Character
Header bottom border Display the header bottom border (True | False) headerbottomborder Boolean
Header bottom border height Height (in pixels) of the header bottom border (if displayed) headerbottomborderheight Int
Header bottom border color Header bottom border color headerbottombordercolor Character

Report Options

Attribute Description Name Type
Report type Select from a known report type (Tabular). Deprecated v5.0. reportUrlType Character
Report Select from a list of reports. From v5.0. reportName Character
Connstr The report data source connection string. From v5.0. reportConnstr Character
SQL statement A SQL statement. This can join multiple tables together and optionally include GROUP BY, ORDER BY and aggregate functions to display Crosstab queries. Use {} macros in the WHERE condition to relate parent->child sections. From v5.0. sql Character
Heading The report heading reportHeading Character
Filter The filter expression that restricts which records will be included in the report reportFilter Character
Fields A comma separated list of field names or expressions. * selects all fields in the table. reportFields Character
Columns A comma separated list of column positions from the fields selected
e.g. 2,4,7,1
reportColumns Character
Subtotals A comma separated list of column positions from the fields selected to subtotal on reportSubtotals Character
Column headings A comma separated list of report column headings reportColumnHeadings Character
Column alignments A | separated list of column alignments from the fields selected
e.g. left|center|right. From v5.0.
reportAlignments Character
Column display masks A | separated list of column display masks from the fields selected
e.g. $|99.999|$. From v5.0.
reportDisplayMasks Character
Column data mapping A | separated list of custom data mapping for columns when displaying data. From v5.0. reportDataMapping Character
Column dynamic background A | separated list of expressions that provides dynamic cell color formatting
e.g. ||iif({}>10000,"lightgreen","")||iif({}<1000,"pink","").
Note the use of {}, which is substituted with the current cell value.
From v5.0.
reportDynamicBackColor Character
Column dynamic foreground A | separated list of expressions that provides dynamic cell color formatting
e.g. ||iif({}>10000,"white","")||.
Note the use of {}, which is substituted with the current cell value.
From v5.0.
reportDynamicForeColor Character
Group by The field name or expression that data will be grouped by for subtotalling reportGroupBy Character
Group by list A | separated choicelist of fields/expressions that an end user can group by. From v5.0. reportGroupByList Character
Sort by The field name or expression that data will be sorted by for subtotalling reportSortBy Character
Sort by list A | separated choicelist of fields/expressions that an end user can sort by. From v5.0. reportSortByList Character
Delegate argument An expressionto be evaluated and passed as an argument to the click and dblclick delegates. From v5.0. reportKeyField Character
Hyperlinks A comma separated list of field names to render as hyperlinks for searching reportHyperlinks Character
Show grid lines Show grid lines for each row of the report (True | False). reportGridLines Boolean
Summary only Display report summary lines only (True | False). From v5.0. reportSummaryOnly Boolean
Sortable Whether report is sortable by clicking on column headers. Shift+Click to sort by multiple columns (True | False). From v5.0. reportSortable Boolean
Editable Whether report is editable by end user (True | False). From v5.0. reportEditable Boolean
Enable custom SQL Whether custom SQL is enabled as a data source (True | False).
From v5.0.
reportEnableSQL Boolean
Include memos Whether memo columns should be included in the report (True | False). From v5.0. reportIncludeMemos Boolean
Include images Whether image columns should be included in the report (True | False). From v5.0. reportIncludeImages Boolean
Image width The width of the images in pixels. From v5.0. reportImageWidth Int
Image height The height of the images in pixels. From v5.0. reportImageHeight Int
Selectable Whether report is selectable by end user and operates as a report viewer (True | False). From v5.0. reportSelectable Boolean
Needs filter Whether report requires a filter (use Query Builder) (True | False).
From v5.0.
reportNeedsFilter Boolean
Max records The maximum number of records to be processed.
From v5.0.
reportMaxRecords Int
Paper size The paper size that the print will be printed on
(Letter | 8.5x13 | A4 | Custom). From v5.0.
reportPaperSize Character
Custom Paper size The paper size that the print will be printed on e.g. 8.5x13.
From v5.0.
reportCustomPaperSize Character
Rows per page The number of rows to print in each page. From v5.0. reportPageSize Int
Row height The height of the rows in pixels. From v5.0. reportRowHeight Int
Scale print size The percentage by which to scale the report when printing in the web client. From v5.0. reportZoomSize Int
Header height The height of the page header in pixels when printing. From v5.0. reportHeaderHeight Int
Header margin The height of the page header margin in pixels when printing. From v5.0. reportHeaderMargin Int
Header image The background image to display in the header. From v5.0. reportHeaderImage Character
Footer height The height of the page footer in pixels when printing. From v5.0. reportFooterHeight Int
Footer margin The height of the page footer margin in pixels when printing. From v5.0. reportFooterMargin Int
Footer image The background image to display in the footer. From v5.0. reportFooterImage Character
Footer page numbers Whether to show 'page n of count' in the footer (True | False).
From v5.0.
reportShowPageNumbers Boolean
Footer date/time Whether to show date/time in the footer (True | False). From v5.0. reportShowDateTime Boolean
CSS Stylesheet You can override the CSS style for the report and style it yourself by specifying your own stylesheet. From v5.0. reportStylesheet Character
Delegate library The name of a custom library containing the server-side report delegates. This should be a Lianja/VFP procedure library. From v5.0. reportCustomLibrary Character
Other options Other report options reportOtherOptions Character
Pagination Paginate the rows displayed (True | False). Deprecated v5.0. reportPagination Boolean
Pagination size The number of rows to paginate. Deprecated v5.0. reportPageSize Int

Related Data

Attribute Description Name Type
Parent section name Name of related parent section
Automatically relate Automatically relate the child section (True | False). If this is unchecked then you need to manually relate it in the parentdatachanged delegate. autoRelateChildSection Boolean

Menu

Attribute Description Name Type
Visible Section menu visible (True | False) sectionMenuVisible Boolean
Height Section menu height sectionMenuHeight Int
Background color Section menu background color sectionMenuBackColor Character
Foreground color Section menu foreground color sectionMenuForeColor Character
Custom menu panel The .rsp or .jssp page used to create the custom menu panel. This page should generate dynamic HTML5/JavaScript. customSectionMenuPanel Character
Custom menu Section menu contents customSectionMenu Character
Custom action Action to perform when a menu item is selected sectionMenuAction Character

Search Panel

Attribute Description Name Type
Visible Section search panel visible (True | False) searchPanelVisible Boolean
Height Section search panel height searchPanelHeight Int
Background color Section search panel background color searchPanelBackColor Character
Foreground color Section search panel foreground color searchPanelForeColor Character
Auto create Automatically create search panel for all Section search fields searchPanelAutoCreate Boolean
Custom search panel The delegate used to create the custom search panel searchPanelAction Character

Subtitle

Attribute Description Name Type
Visible Section subtitle visible (True | False) subtitleVisible Boolean
Caption Section subtitle caption subtitleCaption Character
Height Section subtitle height subtitleHeight Int
Background color Section subtitle background color subtitleBackColor Character
Foreground color Section subtitle foreground color subtitleForeColor Character
Font Section subtitle font subtitleFont Int
CSS style CSS style subtitleCssStyle Character

Footer

Attribute Description Name Type
Visible Section footer visible (True | False) footerVisible Boolean
Caption Section footer caption footerText Character
Height Section footer height footerHeight Int
Background color Section footer background color footerBackColor Character
Foreground color Section footer foreground color footerForeColor Character
Custom menu Section footer menu contents customOptionsMenu Character
Custom action Action to perform when a footer menu item is selected customOptionsMenuAction Character
Footer button CSS Footer button CSS style footerButtonCss Character
Footer button width Footer button width footerButtonWidth Int

Behavior

Attribute Description Name Type
Delegate hyperlinks Delegate hyperlinks in page to page and/or section (True | False) delegateHyperlinks Boolean
Delegate page Delegate page name to search (leave blank if current page) delegateHyperlinksPage Character
Delegate section Delegate section name (leave blank if default searchkey section on page) delegateHyperlinksSection Character
Delegate script Delegate script name (URL is passed as character string) delegateHyperlinksScript Character

Other Options

Attribute Description Name Type
Hide form NavBar Hide form Navigation Bar at runtime if this section is in an Accordion Stack (True | False) hideFormNavBar Boolean
Collapsable The section is collapsible at runtime (True | False) collapsableAtRuntime Boolean
Exclude from accordion The section is excluded from accordion behavior at runtime (True | False) excludeAccordionAtRuntime Boolean

Custom Delegates

Attribute Description Name Type
Scripting language The default scripting language for custom code in this section (Inherit | Recital | Visual FoxPro | Python | JavaScript | PHP) scriptingLanguage Character
Custom library The filename of the library containing code for event handlers and custom procedures/functions customLibrary Character
Print The delegate for the Print event. This is called when you click the 'Print' icon. From v4.2. printAction Character
Expanded The delegate for the Expanded event expandedAction Character
Collapsed The delegate for the Collapsed event collapsedAction Character
Hotkey The delegate for the Hotkey event. hotkeyAction Character
Click The delegate for the clicked event. From v5.0. clickAction Character
Double Click The delegate for the double clicked event. From v5.0. dblclickAction Character
Before Generate The delegate for the Before Generate event. This should be a server-side script written in Lianja/VFP. From v5.0. beforeGenerateAction Character
After Generate The delegate for the After Generate event. This should be a server-side script written in Lianja/VFP. From v5.0. afterGenerateAction Character
Cell Renderer The delegate for the Cell Renderer event. This should be a server-side script written in Lianja/VFP. It is passed the name of the column as the first argument and the value as the second. It should output HTML using the ? or echo commands. From v5.0. cellRendererAction Character
Header Renderer The delegate for the Header Renderer event. This should be a server-side script written in Lianja/VFP. It is passed the name of the column as the first argument and the value as the second. It should output HTML using the ? or echo commands. From v5.0. headerAction Character
Footer Renderer The delegate for the Footer Renderer event. This should be a server-side script written in Lianja/VFP. It is passed the name of the column as the first argument and the value as the second. It should output HTML using the ? or echo commands. From v5.0. footerAction Character
After Data Changed The delegate for the DataChanged event (after data is read). From v5.0. dataChangedAction Character
Before Group The delegate for the Before Group event. This should be a server-side script written in Lianja/VFP. From v5.0. beforeGroupAction Character
After Group The delegate for the After Group event. This should be a server-side script written in Lianja/VFP. From v5.0. afterGroupAction Character
Parent data changed The delegate for the ParentDataChanged event parentDataChangedAction Character
Timer The delegate for the Timer event timerAction Character
Timer interval The timer interval in seconds that the Timer event will be called at runtime timerInterval Int
State Changed The delegate for the Statechanged event. stateChangedAction Character
Custom footer menu The delegate for the footer menu event customMenuAction Character
Custom search command The delegate for the search event customSearch Character
Custom section menu The delegate for the section menu event customSectionMenuAction Character

Permissions and Roles

Attribute Description Name Type
Create roles A comma separated list of roles that can perform create operations on data in the section. permcreate Character
Read roles A comma separated list of roles that can read (and view) the section. permRead Character
Update roles A comma separated list of roles that can perform update operations on data in the section. permUpdate Character
Delete roles A comma separated list of roles that can perform delete operations on data in the section. permDelete Character

UI Presentation Rules

Attribute Description Name Type
Desktop Include this section in a Desktop client (True | False). desktopUI Boolean
Web Include this section in a Web client (True | False). webUI Boolean
Tablet Include this section in a Tablet client (True | False). tabletUI Boolean
Phone Include this section in a Phone client (True | False). mobileUI Boolean
UI States UI states that affect this section. Specify multiple states as a comma separated list. state Character
Initial UI state The initial UI state for this section. This will be applied to the section and all its fields and gadgets. uiStateInit Character
Readonly when Section is readonly at runtime if specified expression evaluates to true. readonlyWhen Character
Visible when Section is visible at runtime if specified expression evaluates to true. visibleWhen Character
Display orientation Display depending on mobile device orientation for Tablets and Phones. (Always | Portrait | Landscape) displayOrientation Character
Apply rules on change Apply UI presentation rules (Visible when and Readonly when) when data is changed interactively or when navigating records (True | False). applyRulesOnChange Boolean
Apply rules on parent change Apply section UI presentation rules (Visible when and Readonly when) when parent data is changed by navigating records (True | False) applyRulesOnParentChange Boolean