User:Piggz/KexiHandbook: Difference between revisions
m (Added report property types) |
m (Added property descriptions and more structure) |
||
| Line 22: | Line 22: | ||
;Extensibility | ;Extensibility | ||
:Although the report system in Kexi is a plugin to the main Kexi application, it itself has a plugin system that allows for the addition of new Item types. Some of the default items are built-in, and some are plugins, such as the Barcode and Chart items. | :Although the report system in Kexi is a plugin to the main Kexi application, it itself has a plugin system that allows for the addition of new Item types. Some of the default items are built-in, and some are plugins, such as the Barcode and Chart items. | ||
=====Report===== | =====Report Design===== | ||
======Report====== | |||
The top-level report object contains properties that relate to the entire report. These properties are accessible by clicking on the rectangular region at the top-left of the report between the horizontal and vertical rulers. | The top-level report object contains properties that relate to the entire report. These properties are accessible by clicking on the rectangular region at the top-left of the report between the horizontal and vertical rulers. | ||
;Properties | ;Properties | ||
| Line 32: | Line 33: | ||
|Title | |Title | ||
|String | |String | ||
| | |The title that is displayed in the | ||
|- | |- | ||
|Page Size | |Page Size | ||
| Line 79: | Line 80: | ||
|} | |} | ||
=====Sections===== | ======Sections====== | ||
The following is the list of all possible section types: | The following is the list of all possible section types: | ||
*detail | *detail | ||
| Line 98: | Line 99: | ||
*page-footer-first | *page-footer-first | ||
*page-footer-last | *page-footer-last | ||
=====Items===== | ======Items====== | ||
The following is the list of all built-in item types | The following is the list of all built-in item types | ||
*Label | *Label | ||
| Line 111: | Line 112: | ||
*Web | *Web | ||
*Map | *Map | ||
======Scripting====== | |||
======Extensibility====== | |||
=====Report View===== | |||
======Overview====== | |||
======Output Formats====== | |||
;Screen | |||
:Screen View Description | |||
;Printer | |||
:Description | |||
;Spreadsheet (ODS) | |||
:Description | |||
;Document | |||
:Description | |||
;HTML (Table) | |||
:Description | |||
;HTML (CSS) | |||
:Description | |||
Revision as of 12:15, 6 April 2012
Kexi
Overview
Window Types
Tables
Queries
Forms
Reports
Introduction
The Kexi Report plugin allows for the creation of dynamic page-based business reports from data held within the database.
Data can be ordered independently to how it is stored, and the reports can be structured with groups, headers and footers.
Concepts
Many of the concepts are similar to those in similar applications such as Microsoft Access, Oracle Reports and the LibreOffice Report Builder.
- Report
- A report is an object made from one or more sections. This top level object contains properties that are applicable to the entire report, such as Name and Paper Size.
- Sections
- A report contains at least one section, the detail section. This section is repeated for every row in the data set that makes the report. Additional sections can be added to increase the structure of the report, such as group-header, group-footer, report-header, report-footer, and many types of page-header/footer.
- Items
- Fields in the data set can be represented by Items in the report. An item is added to one of the report sections. Some items do not need to be associated with a data field, such as the Label item, which shows static text.
- Scripting
- Although many report formats can be created using just the report gui designer, fully dynamic and advanced layouts can be created using code snippets that run on an event based system when the report is rendered.
- Extensibility
- Although the report system in Kexi is a plugin to the main Kexi application, it itself has a plugin system that allows for the addition of new Item types. Some of the default items are built-in, and some are plugins, such as the Barcode and Chart items.
Report Design
Report
The top-level report object contains properties that relate to the entire report. These properties are accessible by clicking on the rectangular region at the top-left of the report between the horizontal and vertical rulers.
- Properties
Name Type Description Title String The title that is displayed in the Page Size Fixed List of Values Page Orientation Fixed List of Values Grid Snap Boolean Show Grid Boolean Grid Divisions Numeric Left Margin Numeric Right Margin Numeric Top Margin Numeric Bottom Margin Numeric Script Interpreter Fixed List of Values Object Script Fixed List of Values
Sections
The following is the list of all possible section types:
- detail
- group-header
- group-footer
- report-header
- report-footer
- page-header-any
- page-header-even
- page-header-odd
- page-header-even
- page-header-first
- page-header-last
- page-footer-any
- page-footer-even
- page-footer-odd
- page-footer-even
- page-footer-first
- page-footer-last
Items
The following is the list of all built-in item types
- Label
- Field
- Text
- Image
- Check
- Line
The following is the list of all shipped item plugins
- Chart
- Barcode
- Web
- Map
Scripting
Extensibility
Report View
Overview
Output Formats
- Screen
- Screen View Description
- Printer
- Description
- Spreadsheet (ODS)
- Description
- Document
- Description
- HTML (Table)
- Description
- HTML (CSS)
- Description