Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


 

Overview

Tables are a major part of Ignition Reporting.  They are composable and highly flexible, giving Reporting Tables are objects that display data in a structured, repetitious format giving users the ability to flexibly layout and organize tabular data Tables are objects that display data in a structured, repetitious formatin a variety of ways. Their complexity can range from trivially simple to complicated, but fundamentally they do the same thing - take the data given to them and repeat it in a structured way for each row of the data provided. The Reporting engine will automatically create new pages to fit all data within the Table's boundaries while applying your formatting preferences preferences each step along the way such as font, size, layout and alignment. Combine that feature with powerful data manipulation and expressive layout tools, and you get an object that often forms the basis of your reports. 

WeLet'll s start by looking at the various parts of the base Table component and move into more features including some examples.


On_this_page

 


 

The Table Component

The Table  component can be created by dragging it from the Report Design Palette, or by simply dragging a Data Source from the Key Browser to a page in your report.  A new Table with no bound Data Key is fairly simple looking, but hides a wealth of functionality. To best understand how to use a table, you'll want to have some familiarity with the Reporting Basics we cover in the Report Design introduction. Also, Selection and Superselection are particularly important when dealing with Tables. When you create a table, by default, you will see something a basic table like the image below on the report page. It says "Object Details" because it has not yet been set up to use a Data Source. 

Image Removed

 

Anatomy of a Table

It's important to understand that the table Image Added

Once you have your dataset, you're probably thinking about how to display that data in a report. To best understand how to use a table to illustrate your data in a report, you need to have a basic understanding of how the report table works.

Table Configuration

When you first drag a table into the Design panel of your report, the Configure Table tab will appear in the Property Inspector. You will see that it has a default Data Key of "Objects", which matches the Details row in the table. The first step when configuring your table is to drag your Datasource from the Key Browser to the Data Key field in the Configure Table tab. Changing the Data Key will also change the label on the Details row making it easier to determine what you are looking at when editing multiple tables or Groupings.  Depending on how you want to present your data, you may also want to add Header and Summary Rows.

Image Added

Once you add a Data Key to your table, you can start designing. There are many tools built into the Table interface that you can use to help you layout and organize the data in your table. Now all you need to do is decide how you want to organize and display the data in your report.

If you have a lot of tabular data, you probably want to use a Standard row. You might start by simply dragging your Data Keys from the Key Browser to columns in your Details row. Then, you might give each Header column a label. If you have a bunch of numbers that you want to add together, find out the 'min', 'max,' you can create a Summary row, enable the Show Calculations property, and choose from the list of calculation keys. Lastly, you might want to make some cosmetic changes to the font size, font color, or changing the Header row from structured to unstructured so you can add an image, chart, text shapes, etc.

Anatomy of a Table

 A table has multiple sections, each with its own properties. By default, the table a Table consists of three sections:

  • Table Body - Parent section of  - Grey area at the bottom of the table template. You can stretch and shrink the table boundaries to position and size a table.

    Image Added
  • Table Row - Containers for the Text Shapes. Rows - There are three types of table rowrows: Header, Details, and Summary. More details on Table Rows A table row can also be structured or unstructured.  More information on these row types can be found on the Table Header, Details and Summary Rows page page

    Image Added
  • Text Shapes - Similar to the standalone Text Shape component, these are embedded directly into the rows on the table. 
Each section has its own properties. These will appear in the
  • Shapes / Cells - are available only in a structured table row.  In Reporting, Text Shapes are commonly referred to as cells. Can select multiple cells with alt or shift.

    Image Added

Info
titleText Shapes or Cells

If you're looking in the Project Browser tree, you'll notice a node called 'Text Shape.' In Reporting, the Text Shape is also called a 'cell.' For the sake of clarity, Text Shapes will be referred to as 'cells,' unless we are referring to the Text Shape component.


The following example shows the basic anatomy of a table with data populated in the Header, Details, and Summary rows. Once you're finished designing your report, go to the Preview panel and check your results. You can continue to navigate between the Design and the Preview panels making changes until you get your report just right!

Image Added

Each section (i.e., Table, Rows, and Cells), when selected, has its own unique properties (shown below), along with some common basic properties that appear in the Properties tab of the Property Inspector when selected. 
. Refer to the Table page in the Appendix for a complete list of all Table properties.

Image Added

Note
titleTable Column Count vs Row Column Count

When modifying properties on a section of the Table, always pay attention to which section you selected. Some property names on one section may look similar to properties on a different section. For example, Table Rows have a Column Count property that adds a new column to the row, but the Table Body section also has a Column Count property that will cause the same table to spill out horizontally on the same page causing . This is great for landscape pages, but on portrait oriented pages it can cause some of the data to be rendered on an unprintable area of the report!

If you look at the Configure Table tab, you will see that it has a default data key of "Objects", which matches the Details row on the component as shown in the image above. Changing the Data Key will also change the name on the row making it easier to determine what you are looking at when editing multiple tables or Grouping.Image Removed

Once you have a table in your report and selected a Data Key for it, you can start designing. There are many tools built into the Table interface that you can use to control its behavior, or select rows and cells.

Image Removed

 

 

Sorting

Sorting orders your data by a key or list of keys. There are three types of Sorting in Tables.  

  • Default - data is sorted based on the order in which it is retrieved.
  • Basic -  takes a list of keys and sorts by the first one.  If the sort results in a tie, the tie will be resolved by the next key in the list, and so on.  
  • TopN - uses a single key path, with a Count value that allows a limit to the number of rows that are processed.

  
Basic and TopN sorts can be configured for either ascending (Image Removed) or descending (Image Removed) sorts.  They can also utilize aggregate (calculation) keys.

The TopN option Include OthersImage Removed will include all values outside of the specified Count range by compressing them into a single row.

 

Expand
titleBasic Sort Example

This example uses the same table and performed different sorts. The first uses the Default sort, the second uses a Basic Sort as configured in the image below.

Image Removed

To alternate to descending, you can click the Image Removed icon to toggle to a descending sort.

The results of the each sort is shown below.The left table is sorted by its primary key (OrderID), and the right table is sorted by Ascending Subtotal.

Image Removed


 

Filtering

Filtering gives the option of processing data based on an expression. The Filtering property can be found in the Property Inspector under the Properties tab.

Image Removed
If the expression resolves false, the row will be skipped. Note: you do not need @ symbols to reference keys.

 

Expand
titleFiltered TopN Sort Example

This example is sorted descending by downtime and filtered by downtime greater than 20 minutes.

Image Removed

 

Image Removed

 

Row Versioning

In the Table component, you can add different versions for your rows. This allows you to do things like alternate background colors, or make the first row different, or show negative valued rows differently. To use Row Versioning, click on the word "Standard" on the far right of a row. You will see a list of your existing row versions (only one named "Standard" appears initially) followed by options to add new row versions. Once you have added a few row versions, you can swap between them by selecting one from this list.

When creating new row versions, the currently selected row will be duplicated as the new row version. From here you can modify your row in any way, you can make it similar to the Standard row or completely different.

Row Version NameDescriptionStandardThis is the standard row. Every other option will use this to fill in remaining rows.RemoveAdd First OnlyA row version that is used for the first piece of data, but not for any others. This is not the same as using a header row, the header will not have access to the first row of data.Add ReprintAdd AlternateEvery other row starting with the second row will use this version.Add TopN OthersAdd Split HeaderAdd CustomThis version allows you to enter a function for whether to select it. When this option is selected, you must enter a name for the new row version. For esample, you could select "Version1" and use a function like this: "col2>5?Version1:Version2"
Expand
titleAlternating Rows Example

In this example, we will give alternating rows a simple background change to make your report easier to read.

-stuff-

 

Report Table Features

Tables have a lot of built-in features that give reporting users the ability to create simple tables and increasingly more complicated tables. The table features are quite powerful, not only do they allow you to organize your tabular data, they also provide sophisticated data manipulation and layout tools.  There are three types of table rows: Header, Details, and Summary rows that make up the body of a table. You can break tables down by data keys that share a common value using Dataset Grouping. The different types of rows can be independently enabled for each level of grouping, each group having its own Header, Details, and Summary rows. Additionally, the keys from 'Show Calculations' and other keychain functions are supported for any level of grouping.  

By default, when you initially create a table all the row types are structured.  A structured row has a variable number of columns and allows you to organize your text based table data, whereby, an unstructured row is highly customizable allowing you to place images, text shapes, and charts within the table row. Unstructured rows are perfect for placing charts anywhere within the row of the table. An unstructured Details row typically works best when used in conjunction with Grouping Data Inside of Tables or Nested Queries so that each row has a chart with data from that group or query.  

Image Added

Another feature is Table Row Versioning which gives you the option of displaying rows with a different format to make them stand out, such as creating an alternate background row color, making the first row different, or even creating your own custom row version. You have have a choice of using any of the Built-in row versioning options or creating a custom version. 
Image Added

Report Tables also support Table Grouping which is an easy way to add multiple Data Sources to an existing table in a report using Peer Tables and Child Tables. Peer Table groups allow the second table to begin exactly where the first table ends. Child Table groups allow you to nest one table inside another. What's really nice about Table Groups and Nested Data Sources is that you can create Summary Tables for categories of items or drill-down charts all in one report

Once you get familiar with all the report table features, you can easily design professional tables for your reports. 


Other Table Components

There are a few other tables table components in the Report Module, Simple Table and CrossTab Table, and they all both behave a little differently than . Selecting the main table.

  • Simple Table - a basic table that has a set number of rows and columns that you can put static or dynamic values. You cannot use keys from a dataset in this table.
  • Labels - primarily used for printing sticker labels for inventory tracking or other systems. These reports are usually sent to a printer.
  • CrossTab -  a table used for displaying data with two groupings (i.e., machine_name and downtime_entry) to correlate data. This

    right table depends on the type of data you have and how you want to display it. 

    The Simple Table is similar to a basic table that dynamically crates new rows and columns for rows returned by the Data Keys on the component.  With a Simple Table, you can very quickly add a table inside a report. 

    The CrossTab Table is commonly used to summarize the relationship between two groupings of data by showing summaries of cross sections of the datasource. The CrossTab Table has lots of repetitious data, a datasource that provides at least two columns of data which are repetitious compared to the number of rows, and one or more columns that represent a value that requires a calculation. This table will stretch both its height and width to accommodate the underlying dataset.