Data Grid Properties

The following properties affect the data grid component. For data grids, you can customize properties for the header, rows, and columns.

For a guide to using the data grid component, see Data Grid.

Data grid components are also affected by Common Properties.

General Data Grid properties

Data Grid Header properties

Data Grid Row properties

Data Grid Column properties

These properties affect the entire data grid. To see these properties in the Property Inspector, click on your data grid on the Stage or in the Outline.

Table

Table
Defines the table that the data grid uses as a data source.

The Table property

Column Filter

Column Filter
Specifies the columns for a filter, as a comma-separated list of table column names. Use the Filter Type property to specify whether these columns are shown in this data grid or hidden from it. The order of columns in a whitelist filter overrides the column order in the Outline and the source table.

The Column Filter property

Filter Type

Filter Type
Specifies how this filter handles the listed columns. The default is Blacklist.

Whitelist
Only the listed columns are shown in this data grid. Columns appear in the order specified in the filter.

Blacklist
The listed columns are hidden from this data grid.

The Filter Type property

Sort Order

Sort Order
Specifies whether the data is sorted in ascending or descending order. The options are Ascending (default) and Descending.

To change whether the data is treated as strings or numbers when sorted, open the dataflow for this data grid and edit the Sort block.

The Sort Order property

Sort Column

Sort Column
Specifies the name of the column by which to sort the data. Only works if the column has the Sortable property enabled.

The Sort Column property

Add Column

Add Column
Click this button to add a column editor to the Outline. Each column editor lets you edit the properties of a group of one or more data grid columns.

The Add Column property

These properties affect the data grid header. There are four groups of Data Grid Header properties. To see these properties in the Property Inspector, click on Header in the Outline.

Header Text and Font

The Text and Font properties for headers are similar to those for text components: font, font color, size, style, weight, horizontal alignment (default center), vertical alignment (default middle), and left, right, top and bottom padding, with an option to keep all four paddings equal.

These properties control the style of the vertical lines between column headings and the horizontal lines between column headings and category headings. In the Property Inspector they appear as Horiz Line and Vert Line, each with a color, a Stroke style and a weight. The stroke style options are None (default), Dotted, Dashed, Solid, Double, Groove, Ridge, Inset and Outset. The default weight is 0.

Header Horizontal Stroke Color

Header Horizontal Stroke Color
Defines the stroke color for the horizontal lines that divide the column headings and category headings.

The Header Horizontal Stroke Color property

Header Horizontal Stroke Style

Header Horizontal Stroke Style
Defines the stroke style for the horizontal lines that divide the column headings and category headings.

The Header Horizontal Stroke Style property

Header Horizontal Stroke Weight

Header Horizontal Stroke Weight
Defines the stroke weight for the horizontal lines that divide the column headings and category headings.

The Header Horizontal Stroke Weight property

Header Vertical Stroke Color

Header Vertical Stroke Color
Defines the stroke color for the vertical lines that divide the column headings.

The Header Vertical Stroke Color property

Header Vertical Stroke Style

Header Vertical Stroke Style
Defines the stroke style for the vertical lines that divide the column headings.

The Header Vertical Stroke Style property

Header Vertical Stroke Weight

Header Vertical Stroke Weight
Defines the stroke weight for the vertical lines that divide the column headings.

The Header Vertical Stroke Weight property

The Fill and Stroke properties for headers are similar to those for most components.

This property controls the height of the header.

Header Height

Header Height
Defines the height of the header in pixels. A value of Auto makes the header height follow the size of its content.

The Header Height property

These properties affect data grid rows. There are four groups of Data Grid Rows properties. To open these properties in the Property Inspector, click on Rows in the Outline.

Row Text and Font

The Text and Font properties for data grid rows are similar to those for text components: font, font color, size, style, weight, horizontal alignment (default center), vertical alignment (default middle), and cell padding, with an option to keep all four paddings equal.

Clip Content

Clip Content\ Specifies whether cell content that does not fit in the cell is clipped. Enabled by default.

These properties control the lines that divide the columns and rows.

Gridlines

Gridlines
Specifies which gridlines are used: None (default), Horizontal, Vertical, or Both. The Property Inspector displays the editing options for the selected gridlines. Changing this property does not reset any gridline properties.

The Gridlines property

Horizontal Line

Horizontal Line
These properties define the horizontal lines between rows. They are similar to the Stroke properties for most components

The Horizontal Line properties

Vertical Line

Vertical Line
These properties define the vertical lines between columns.They are similar to the Stroke properties for most components.

The Vertical Line properties

The Fill and Stroke properties for rows are similar to those for most components. You can define fill and stroke for the types of rows listed in the table. In each case, the properties define the fill for the row, the stroke that outlines the row, and the font color of the row text.

Property	Description
Main	The first group of alternating rows.
Alt	The second group of alternating rows.
Hov	The row that the user mouses over.
Foc	The row that is in focus.
Sel	The selected rows. Only works if selection is enabled for this data grid.

This property controls the row height:

Row Height

Row Height
Defines the height in pixels of each data grid row. The default is 24.

The Row Height property

These properties affect data grid columns. There are three groups of column properties. To open these properties in the Property Inspector, expand Column in the Outline, and select a column editor.

A column editor lets you edit the properties of a group of one or more data grid columns. To add a column editor, go to the General Data Grid Properties and click Add Column.

These properties specify which columns this editor controls, as well as sorting and visibility for those columns.

Label

Label
Defines the label to be used as heading text for columns controlled by this column editor.

The Column Label property

Type

Type
Defines the kind of column group this column editor controls. See About Column Editors and Column Order

all 
An All column editor dictates that all of the columns from the source table are included in the grid, except for those that you filter out of the entire grid. Grid columns appear in source table order, unless you specify another order using a whitelist filter. Properties edited for this column editor apply to all columns.

name 
Each Name column editor dictates that one column from the source table is included in the grid. Grid columns appear in the order in which they appear in the Outline, unless you specify another order using a whitelist filter. Properties edited for this column editor apply to this column.

repeater
A Repeater column editor lets you use a configuration table to determine which source table columns appear in the grid, which symbols represent those columns (if any), and properties of the symbols.

The default type for a new column editor added with Add Column is All.

The Column Editor Type property

Selector

Column Editor Selector
Specifies which column or columns this column editor controls. If the column editor type is All, this property does nothing. If the column editor type is Name, this property specifies the name of one column in the source table. If the column editor type is Repeater, this property specifies which column of the configuration table contains the data table column names.

The Selector property

Configuration Table

Configuration Table\ Only shown when the column editor type is Repeater. Defines the configuration table. Each row of the configuration table defines one grid column; the column named by the Selector property contains the data table column names.