Appboard/old/widgets/basic table: Difference between revisions

imported>Cmace
(created to remove appboard_builder)
 
imported>Jason.nicholls
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Configuring a Basic Table Widget ==
{{DISPLAYTITLE:Basic Table Widget}}
[[Category:AppBoard old]]
== Basic Table Widget ==
The Basic Table Widget will show data from a Data Collection in a tabular format.  The config for the basic table widget allows you to select the columns of data you want to see from the data collection, and lets you determine the order in which those columns appear.  A simple client side sort operation is available by clicking on the table header.


# Select the Data Collection containing the information you'd like to use for this widget from the drop-down list on the "Configure" part of the "Widget Wizard."
'''Example of a plain table'''
# Click the "Add" button in the "Columns" box to being adding your custom columns for the data table. Click "Remove" to get rid of any columns.  
 
# You can adjust the colors of the data table by clicking the "Add Color" button and choosing the fields you would like to change the background colors of.
[[Image:DataGrid_Plain.png|Sample of a table without renderers]]
# Complete the "Options" and "Actions" steps as described in [[Widgets|Add/Edit/Remove a Widget]].
 
  If you're using ''Sample.Data.ChartData'', then select columns you'd like to see by pressing the add button and selecting the appropriate column name from the "Data Field".
 
== Renderers ==
The Basic Table provides a number of customization options around how data inside the table is rendered and displayed.
 
=== Column Renderers ===
Column Renderers alter way data is rendered for a selected column.  All renders allow you Change the header text for the column, the column width, and set whether or not the column can be resized. Column Renderers include:
 
* '''Text'''
: Default renderer designed to render text strings.  Text will be left aligned.
* '''Status Shape'''
: The Status shape renderer allows you to convert textual data into a status shape via Status Rules.
* '''Date'''
: The Date renderer allows you to adjust how date information is displayed.  (MM/DD/YYYY, YYYY/MM/DD, etc.)
* '''Icon'''
: The Icon renderer allows you to represent textual data as an icon.
* '''Number'''
: The Number renderer allows you to adjust the format of numbers.
 
The example below shows a Status Shape applied to the "Totals" column, and a "Date" renderer applied to the "Date" column.
 
[[Image:DataGrid_Renderers.png|Sample of a table with renderers]]
 
  If you're using Sample.Data.ChartData, set the renderer for the "Totals" Data Field to be "Status Shape". Then set the following rules:
  Rule 1: Set the color to be "red" for "Totals" that are "Greater Than" the value "2100"
  Rule 2: Set the color to be "Yellow" for "Totals" that are "Greater Than" the value "2000"
  Rule 3: Set the color to be "Green" for "Totals" that are "Greater Than" the value "0"
 
== Row Status ==
The Basic Table can dynamically set the row color based on values contained within the data collection. 
 
The example below shows row status colors based on rules for the "Totals" column.  These are the same rules that were used for the Status Shape column renderer. 
 
 
[[Image:DataGrid_Status.png|Sample of a table with renderers]]
 
  If you're using Sample.Data.ChartData, set the renderer for the "Totals" Data Field to be "Status Shape". Then set the following rules:
  Rule 1: Set the color to be "#FFCCCC" for "Totals" that are "Greater Than" the value "2100"
  Rule 2: Set the color to be "#FFFFCC" for "Totals" that are "Greater Than" the value "2000"
  Rule 3: Set the color to be "#CCFFCC" for "Totals" that are "Greater Than" the value "0"
 
 
==  Filter Options==
The "Options" tab provides several filter options that are particularly useful when combined with the Basic Table.
 
=== Search ===
This option toggles a pill shaped text field in the header of the widget which allows you to quickly filter the data collection based on characters entered into this field.  When you type characters into the field, AppBoard will search all rows of data for strings that match the characters that have been entered. Any rows that do not contain strings with matching characters are hidden from the view, leaving only the rows that have matching values visible.  Combining this option with sort is a quick and easy way to find what your looking for.
 
=== Quick Filter ===
The "Quick Filter" option provides a set of toggle button controls in the bottom toolbar of the widget.  These toggle buttons quickly filters data on the client based on associated rules.  Only rows of data which match criteria defined by these rules will remain visible.  Rows of data that do not match the rule are hidden from the view.

Latest revision as of 12:00, 17 July 2014

Basic Table Widget

The Basic Table Widget will show data from a Data Collection in a tabular format. The config for the basic table widget allows you to select the columns of data you want to see from the data collection, and lets you determine the order in which those columns appear. A simple client side sort operation is available by clicking on the table header.

Example of a plain table

Sample of a table without renderers

 If you're using Sample.Data.ChartData, then select columns you'd like to see by pressing the add button and selecting the appropriate column name from the "Data Field".

Renderers

The Basic Table provides a number of customization options around how data inside the table is rendered and displayed.

Column Renderers

Column Renderers alter way data is rendered for a selected column. All renders allow you Change the header text for the column, the column width, and set whether or not the column can be resized. Column Renderers include:

  • Text
Default renderer designed to render text strings. Text will be left aligned.
  • Status Shape
The Status shape renderer allows you to convert textual data into a status shape via Status Rules.
  • Date
The Date renderer allows you to adjust how date information is displayed. (MM/DD/YYYY, YYYY/MM/DD, etc.)
  • Icon
The Icon renderer allows you to represent textual data as an icon.
  • Number
The Number renderer allows you to adjust the format of numbers.

The example below shows a Status Shape applied to the "Totals" column, and a "Date" renderer applied to the "Date" column.

Sample of a table with renderers

 If you're using Sample.Data.ChartData, set the renderer for the "Totals" Data Field to be "Status Shape".  Then set the following rules:
 Rule 1: Set the color to be "red" for "Totals" that are "Greater Than" the value "2100"
 Rule 2: Set the color to be "Yellow" for "Totals" that are "Greater Than" the value "2000"
 Rule 3: Set the color to be "Green" for "Totals" that are "Greater Than" the value "0"

Row Status

The Basic Table can dynamically set the row color based on values contained within the data collection.

The example below shows row status colors based on rules for the "Totals" column. These are the same rules that were used for the Status Shape column renderer.


Sample of a table with renderers

 If you're using Sample.Data.ChartData, set the renderer for the "Totals" Data Field to be "Status Shape".  Then set the following rules:
 Rule 1: Set the color to be "#FFCCCC" for "Totals" that are "Greater Than" the value "2100"
 Rule 2: Set the color to be "#FFFFCC" for "Totals" that are "Greater Than" the value "2000"
 Rule 3: Set the color to be "#CCFFCC" for "Totals" that are "Greater Than" the value "0"


Filter Options

The "Options" tab provides several filter options that are particularly useful when combined with the Basic Table.

Search

This option toggles a pill shaped text field in the header of the widget which allows you to quickly filter the data collection based on characters entered into this field. When you type characters into the field, AppBoard will search all rows of data for strings that match the characters that have been entered. Any rows that do not contain strings with matching characters are hidden from the view, leaving only the rows that have matching values visible. Combining this option with sort is a quick and easy way to find what your looking for.

Quick Filter

The "Quick Filter" option provides a set of toggle button controls in the bottom toolbar of the widget. These toggle buttons quickly filters data on the client based on associated rules. Only rows of data which match criteria defined by these rules will remain visible. Rows of data that do not match the rule are hidden from the view.