Search results

ColumnModel

Interface for a TreeGrid class Column

Properties

allowEditing

boolean

If allowEditing set to false, then it disables editing of a particular column. By default all columns are editable.

allowFiltering

boolean

If allowFiltering set to false, then it disables filtering option and filter bar element of a particular column. By default all columns are filterable.

allowReordering

boolean

If allowReordering set to false, then it disables reorder of a particular column. By default all columns can be reorder.

allowResizing

boolean

If allowResizing set to false, it disables resize option of a particular column.

allowSorting

boolean

If allowSorting set to false, then it disables sorting option of a particular column. By default all columns are sortable.

clipMode

ClipMode

Defines the cell content’s overflow mode. The available modes are

  • Clip - Truncates the cell content when it overflows its area.
  • Ellipsis - Displays ellipsis when the cell content overflows its area.
  • EllipsisWithTooltip - Displays ellipsis when the cell content overflows its area also it will display tooltip while hover on ellipsis applied cell.

columns

Column[] | string[] | ColumnModel[]

Used to render multiple header rows(stacked headers) on TreeGrid header.

commands

CommandModel[]

commands provides an option to display command buttons in every cell. The available built-in command buttons are

  • Edit - Edit the record.
  • Delete - Delete the record.
  • Save - Save the record.
  • Cancel - Cancel the edit state. The following code example implements the custom command column.

    <style type="text/css" class="cssStyles">
    .details-icon:before
    {
    content:"\e74d";
    }
    </style>
    <div id="TreeGrid"></div>
    var gridObj = new TreeGrid({
    datasource: window.gridData,
    columns : [
    { field: 'CustomerID', headerText: 'Customer ID' },
    { field: 'CustomerName', headerText: 'Customer Name' },
    {commands: [{buttonOption:{content: 'Details', click: onClick, cssClass: details-icon}}], headerText: 'Customer Details'}
    ]
    gridObj.appendTo("#TreeGrid");

customAttributes

Object

The CSS styles and attributes of the content cells of a particular column can be customized.

defaultValue

string

Defines default values for the component when adding a new record to the TreeGrid.

disableHtmlEncode

boolean

If disableHtmlEncode is set to true, it encodes the HTML of the header and content cells.

displayAsCheckBox

boolean

If displayAsCheckBox is set to true, it displays the column value as a check box instead of Boolean value.

edit

IEditCell

Defines the IEditCell object to customize default edit cell.

editTemplate

string

Defines the cell edit template that used as editor for a particular column. It accepts either template string or HTML element ID.

editType

string

Defines the type of component for editing.

field

string

Defines the field name of column which is mapped with mapping name of DataSource. The bounded columns can be sort, filter etc., The field name must be a valid JavaScript identifier, the first character must be an alphabet and should not contain spaces and special characters.

filter

IFilter

Defines the filter options to customize filtering for the particular column. @default null

filterBarTemplate

IFilterUI

The filterBarTemplate is used to add a custom component instead of default input component for filter bar. It have create and read functions.

  • create: It is used for creating custom components.
  • read: It is used to perform custom filter action.

    <div id="TreeGrid"></div>
    let gridObj: TreeGrid = new TreeGrid({
    dataSource: filterData,
    columns: [
    { field: 'OrderID', headerText: 'Order ID' },
    {
     field: 'EmployeeID', filterBarTemplate: {
        create: (args: { element: Element, column: Column }) => {
             let input: HTMLInputElement = document.createElement('input');
             input.id = 'EmployeeID';
             input.type = 'text';
             return input;
        },
        write: (args: { element: Element, column: Column }) => {
            args.element.addEventListener('input', args.column.filterBarTemplate.read as EventListener);
        },
        read: (args: { element: HTMLInputElement, columnIndex: number, column: Column }) => {
            gridObj.filterByColumn(args.element.id, 'equal', args.element.value);
       }
    }
    }],
    allowFiltering: true
    });
    gridObj.appendTo('#TreeGrid');

format

string | NumberFormatOptions | DateFormatOptions

It is used to change display value with the given format and does not affect the original data. Gets the format from the user which can be standard or custom number and date formats.

formatter

Object | ITreeGridCellFormatter | Function

Defines the method which is used to achieve custom formatting from an external function. This function triggers before rendering of each cell.

headerTemplate

string

Defines the header template as string or HTML element ID which is used to add customized element in the column header.

headerText

string

Defines the header text of column which is used to display in column header. If headerText is not defined, then field name value will be assigned to header text.

headerTextAlign

TextAlign

Define the alignment of column header which is used to align the text of column header.

hideAtMedia

string

Column visibility can change based on Media Queries. hideAtMedia accepts only valid Media Queries.

isIdentity

boolean

If isIdentity is set to true, then this column is considered as identity column.

isPrimaryKey

boolean

If isPrimaryKey is set to true, considers this column as the primary key constraint.

lockColumn

boolean

If lockColumn set to true, then it disables Reordering of a particular column. The locked column will be moved to first position.

maxWidth

string | number

Defines the maximum width of the column in pixels or percentage, which will restrict resizing beyond this pixels or percentage.

minWidth

string | number

Defines the minimum width of the column in pixels or percentage.

showCheckbox

boolean

If showCheckbox set to true, then the checkboxes will be displayed in particular column.

showColumnMenu

boolean

If showColumnMenu set to false, then it disable the column menu of a particular column. By default column menu will show for all columns

sortComparer

SortComparer | string

Defines the sort comparer property.

template

string

Defines the column template that renders customized element in each cell of the column. It accepts either template string or HTML element ID.

textAlign

TextAlign

Defines the alignment of the column in both header and content cells.

type

string

Defines the data type of the column.

uid

string

Gets the unique identifier value of the column. It is used to get the object.

validationRules

Object

Defines rules to validate data before creating and updating.

valueAccessor

ValueAccessor | string

Defines the method used to apply custom cell values from external function and display this on each cell rendered.

visible

boolean

If visible is set to false, hides the particular column. By default, columns are displayed.

width

string | number

Defines the width of the column in pixels or percentage.