The default value for this property is Aggregate.None, which causes the grid to show no aggregate values for this column.

The default value for this property is null, which causes the grid to select the alignment automatically based on the column's dataType (numbers are right-aligned, Boolean values are centered, and other types are left-aligned).

If you want to override the default alignment, set this property to 'left', 'right', 'center', or 'justify'.

The default value for this property is true.

The default value for this property is false.

The default value for this property is true.

The default value for this property is true.

The default value for this property is null, which means the column is not bound to any data fields.

This property is set automatically for auto-generated columns (see FlexGrid.autoGenerateColumns).

Cell template strings use template literal syntax. The content string is generated using a scope of type ICellTemplateContext.

ICellTemplateFunction functions take an argument of type ICellTemplateContext and return the HTML content to be displayed in the cell.

For example:

// simple/default rendering with a cellTemplate string
col.cellTemplate = '${value}:${col.format}';

// simple/default rendering with a cellTemplate function
col.cellTemplate = (ctx: ICellTemplateContext) => glbz`${ctx.value}:${ctx.col.format}`;

// conditional formatting with cellTemplate string
col.cellTemplate = '<span class=${value > 40000 ? "big-val" : "small-val"}>${text}</span>';

// conditional formatting with a cellTemplate function
col.cellTemplate = (ctx: ICellTemplateContext) => `
    <span class="${ctx.value > 4000 ? 'big-val' : 'small-val'}">${ctx.text}</span>
`;

Notice that string-based cell templates are regular strings, not actual JavaScript template literals. Therefore, they are defined using regular quotes (single or double) as oppsed to the back-quotes used by JavaScript template strings.

Function-based cell templates are usually a better choice than string-based templates because:

1) They provide design-time error checking and command completion, 2) They run faster, and 3) They do not have any issues with content-security policy (CSP).

String-based cell templates also have advantages that may be important in some scenarios:

1) They are slightly more concise, and 2) They can be stored as data and easily changed at run-time.

The cellTemplate property provides a simpler alternative to the formatItem event or the cell templates available in the Wijmo interop modules.

When using cell templates, you should still set the column's binding and format properties. They will be used in edit mode and to support copy/paste/export operations.

Cell templates are used only to render cell data, and have no effect on editing. If you want to customize the cell editors, use the editor property.

Cell templates can also be used to render row header cells. The most common scenario for this would be to add numbers to the row header cells. The example below shows how you can do this:

// get row header column
let col = theGrid.rowHeaders.columns[0];

// assign template that adds the row index to the header
// (but preserves glyphs such as edit and new row template)
col.cellTemplate = ctx => ctx.text || (ctx.row.index + 1).toString();

The default value for this property is null, which means the column has no template.

The default value for this property is null.

The default value for this property is null.

By default, data-mapped cells have drop-down lists that can be used for quick editing. You can change the type of editor by setting the column's dataMapEditor property.

The default value for this property is null.

The default value for this property is DataMapEditor.DropDownList, which adds drop-down buttons to cells to columns that have a dataMap and are not read-only.

Clicking on the drop-down buttons causes the grid to show a list where users can select the value for the cell.

The DataMapEditor.RadioButtons setting causes the grid to show radio buttons for each option. The buttons can be clicked with the mouse or keyboard (by pressing each option's initial letter or the space key to cycle through the options.)

Note that drop-down lists are available only if the wijmo.input.ListBox class is loaded/imported by the application.

Values are coerced into the proper type when editing the grid.

The default value for this property is null, which causes the grid not to perform any data type coercion.

This property is set automatically for auto-generated columns (see FlexGrid.autoGenerateColumns).

The ID is used as the value of the aria-describedby attribute for the column header element.

THe default value for this property is null.

The drop-down buttons are shown only if the column has a dataMap set and is editable. Clicking on the drop-down buttons causes the grid to show a list where users can select the value for the cell.

Note that drop-down lists are available only if the wijmo.input.ListBox class is loaded/imported by the application.

The default value for this property is null.

The input control is typically one of the Wijmo input controls. It should be compatible with the column's data type.

For example, this code replaces the built-in editor for all date columns on a grid with a single InputDate control:

import { InputDate } from '@grapecity/wijmo.input';
let inputDate = new InputDate(document.createElement('div'));
theGrid.columns.forEach(col => {
    if (col.DataType == DateType.Date) {
        col.editor = inputDate;
    }
})

And this code replaces the built-in editor for all data-mapped columns on a grid with AutoComplete controls:

import { AutoComplete } from '@grapecity/wijmo.input';
theGrid.columns.forEach(col => {
    let map = col.dataMap;
    if (map) {
        col.editor = new AutoComplete(document.createElement('div'), {
            itemsSource: map.collectionView,
            displayMemberPath: map.displayMemberPath,
            selectedValuePath: map.selectedValuePath
        });
    }
});

Notice how the example above uses the column's dataMap property to initialize the AutoComplete.

In many cases you may also want to use column properties such as format and isRequired to initialize the custom editors. This is important since the custom editors do not inherit any properties from the column being edited.

The example below shows how you can use the editor property to edit grid items with various Wijmo input controls:

Example

The default value for this property is null, which causes the grid to use the grid's own built-in editors.

The default value for this property is null, which causes the grid to use default formats that depend on the data type.

The default value for this property is null, which causes the grid to use the binding string as a header.

The default value for this property is null, which causes the grid to use the type "tel" for numeric columns, and "text" for all other non-boolean column types.

The "tel" input type causes mobile devices to show a numeric keyboard that includes a negative sign and a decimal separator.

Use this property to change the default setting if the default does not work well for the current culture, device, or application. In these cases, try setting the property to "number" or simply "text."

This property only applies to regular cells. Row and column header cells contain plain text by default. If you want to display HTML in column or row headers, you must use the FlexGrid.formatItem event and set the cell's innerHTML content in code.

Unless the column's isReadOnly property is set to true, cells that show HTML can be edited. By default, the editor will show HTML markup and users will be able to change it. If the column has a dataMap, however, the drop-down list will show formatted items and the editor will show plain text instead of HTML markup.

The default value for this property is false.

The default value for this property is false.

The default value for this property is to null, which means dates, booleans, and numeric values are required, but non-masked string columns may contain empty strings.

When set to true, values are required and empty strings are not allowed.

When set to false, null values and empty strings are allowed.

The default value for this property is false.

This property is read-only. To change the visibility of a column or row, use the visible property instead.

Top level groups have level zero. Their children have level 1, and so on.

The format used to define the mask is the same used by the wijmo.input.InputMask control.

If specified, the mask must be compatible with the value of the format property. For example, the mask '99/99/9999' can be used for entering dates formatted as 'MM/dd/yyyy'.

The default value for this property is null, which means any character is accepted at any position.

The default value for this property is null, which allows entries with any number of characters.

The default value for this property is null, which means there is no upper limit to the column width.

The default value for this property is null, which means there is no lower limit to the column width.

The default value for this property is false.

The column name can be used to retrieve the column using the FlexGrid.getColumn method.

This property is especially useful when dealing with unbound columns or multiple columns with the same binding value.

The default value for this property is null.

You can use this property to restrict column dragging so users can only drag within groups. For example:

let theDragColumn: ColumnGroup;
new FlexGrid(host, {
    columnGroups: [
        { binding: 'id', allowDragging: true },
        { binding: 'name', allowDragging: true },
        ...
    ],
    allowDragging: AllowDragging.Columns,
    draggingColumn: (s, e) => { // keep track of group being dragged
        theDragColumn = e.getColumn(true) as ColumnGroup;
    },
    draggingColumnOver: (s, e) => { // allow dropping only within groups
        let col = e.getColumn(true) as ColumnGroup;
        e.cancel = col.parentGroup != theDragColumn.parentGroup;
    },
    itemsSource: getData(),
});

Setting this property to false disables quick auto-sizing for this column.

Setting it to true enables the feature, subject to the value of the grid's wijmo.grid.FlexGrid.quickAutoSize property.

The default value for this property is null, which enables the feature for columns that display plain text and don't have templates.

This property accounts for visibility, default size, and min and max sizes.

The value returned takes into account the column's visibility, default size, and min and max sizes.

Setting this property to null or negative values causes the element to use the parent collection's default size.

Use this property in cases where you want the sorting to be performed based on values other than the ones specified by the binding property.

The default value for this property is null, which causes the grid to use the value of the binding property to sort the column.

The default value for this property is true.

Column widths may be positive numbers (sets the column width in pixels), null or negative numbers (uses the collection's default column width), or strings in the format '{number}*' (star sizing).

The star-sizing option performs a XAML-style dynamic sizing where column widths are proportional to the number before the star. For example, if a grid has three columns with widths "100", "*", and "3*", the first column will be 100 pixels wide, the second will take up 1/4th of the remaining space, and the last will take up the remaining 3/4ths of the remaining space.

Star-sizing allows you to define columns that automatically stretch to fill the width available. For example, set the width of the last column to "*" and it will automatically extend to fill the entire grid width so there's no empty space. You may also want to set the column's minWidth property to prevent the column from getting too narrow.

You can use the renderWidth property to retrieve the actual width of the column, taking into account visibility, star sizing, min/max limits, and default width settings.

The default value for this property is null, which causes the grid to use the default column width defined by the grid's FlexGrid.columns collection.

The default value for this property is false.