\Kendo\UI\TreeListColumn
A PHP class representing the column setting of TreeListColumns.
Methods
attributes
The HTML attributes of the table cell (
Returns
\Kendo\UI\TreeListColumn
Parameters
$value ``
addCommandItem
Adds one or more TreeListColumnCommandItem to the TreeListColumn.
Returns
\Kendo\UI\TreeListColumn
Parameters
$value[, $value2, ...] \Kendo\UI\TreeListColumnCommandItem|array
Example - using \Kendo\UI\TreeListColumnCommandItem
<?php
$column = new \Kendo\UI\TreeListColumn();
$commandItem = new \Kendo\UI\TreeListColumnCommandItem();
$className = 'value';
$commandItem->className($className);
$column->addCommandItem($commandItem);
?>
Example - using array
<?php
$column = new \Kendo\UI\TreeListColumn();
$className = 'value';
$column->addCommandItem(array('className' => $className));
?>
Example - adding more than one TreeListColumnCommandItem
<?php
$column = new \Kendo\UI\TreeListColumn();
$first = new \Kendo\UI\TreeListColumnCommandItem();
$second = new \Kendo\UI\TreeListColumnCommandItem();
$column->addCommandItem($first, $second);
?>
draggable
If set to true a draghandle will be rendered and the user could reorder the rows by dragging the row via the drag handle.
Returns
\Kendo\UI\TreeListColumn
Parameters
$value boolean
Example
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->draggable(true);
?>
editable
The JavaScript function that is executed when the cell or row is about to be opened for editing. The returned result will determine whether an editor for the column will be created.
Returns
\Kendo\UI\TreeListColumn
Parameters
$value \Kendo\JavaScriptFunction
Example
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->editable(new \Kendo\JavaScriptFunction('function() { }'));
?>
editor
Provides a way to specify a custom editing UI for the column. To create the editing UI, use the container parameter.When used as String, defines the editor widget type. For further info check the Form API: field
Returns
\Kendo\UI\TreeListColumn
Parameters
$value string|\Kendo\JavaScriptFunction
Example - using string
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->editor('value');
?>
Example - using \Kendo\JavaScriptFunction
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->editor(new \Kendo\JavaScriptFunction('function() { }'));
?>
editorOptions
Defines the widget configuration when one is initialized as editor for the column (or the widget defined in items.editor). For further info check the Form API: field.
Returns
\Kendo\UI\TreeListColumn
Parameters
$value ``
encoded
If set to true, the column value will be HTML-encoded before it is displayed. If set to false, the column value will be displayed as is. By default, the column value is HTML-encoded.
Returns
\Kendo\UI\TreeListColumn
Parameters
$value boolean
Example
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->encoded(true);
?>
expandable
If set to true, the column will show the icons that are used for expanding and collapsing child rows. By default, the first column of the TreeList is expandable.
Returns
\Kendo\UI\TreeListColumn
Parameters
$value boolean
Example
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->expandable(true);
?>
field
The field to which the column is bound. The value of this field is displayed by the column during data binding.
Returns
\Kendo\UI\TreeListColumn
Parameters
$value string
Example
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->field('value');
?>
filterable
If set to true and if filtering is enabled, a filter menu will be displayed for this column. If set to false, the filter menu will not be displayed. By default, a filter menu is displayed for all columns when filtering is enabled through the filterable option. Can be set to a JavaScript object which represents the filter menu configuration.
Returns
\Kendo\UI\TreeListColumn
Parameters
$value boolean|\Kendo\UI\TreeListColumnFilterable|array
Example - using boolean
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->filterable(true);
?>
Example - using \Kendo\UI\TreeListColumnFilterable
<?php
$column = new \Kendo\UI\TreeListColumn();
$filterable = new \Kendo\UI\TreeListColumnFilterable();
$ui = 'value';
$filterable->ui($ui);
$column->filterable($filterable);
?>
Example - using array
<?php
$column = new \Kendo\UI\TreeListColumn();
$ui = 'value';
$column->filterable(array('ui' => $ui));
?>
footerTemplate
The template which renders the footer table cell for the column.The following fields can be used in the template: average - The value of the average aggregate (if specified).; count - The value of the count aggregate (if specified).; max - The value of the max aggregate (if specified).; min - The value of the min aggregate (if specified). or sum - The value of the sum aggregate (if specified)..
Returns
\Kendo\UI\TreeListColumn
Parameters
$value string|\Kendo\JavaScriptFunction
Example - using string
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->footerTemplate('value');
?>
Example - using \Kendo\JavaScriptFunction
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->footerTemplate(new \Kendo\JavaScriptFunction('function() { }'));
?>
format
The format that is applied to the value before it is displayed. Takes the {0:format} form where format is a standard number format, custom number format, standard date format or a custom date format.
Returns
\Kendo\UI\TreeListColumn
Parameters
$value string
Example
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->format('value');
?>
headerAttributes
The HTML attributes of the table header cell (
Returns
\Kendo\UI\TreeListColumn
Parameters
$value ``
headerTemplate
The template which renders the column header content. By default, the value of the title column option is displayed in the column header cell.
Returns
\Kendo\UI\TreeListColumn
Parameters
$value string|\Kendo\JavaScriptFunction
Example - using string
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->headerTemplate('value');
?>
Example - using \Kendo\JavaScriptFunction
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->headerTemplate(new \Kendo\JavaScriptFunction('function() { }'));
?>
hidden
If set to true, the TreeList will not display the column. By default, all columns are displayed.
Returns
\Kendo\UI\TreeListColumn
Parameters
$value boolean
Example
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->hidden(true);
?>
includeChildren
If set to true, the TreeList will select all child rows upon parent row selection when checkbox selection is used.
Returns
\Kendo\UI\TreeListColumn
Parameters
$value boolean
Example
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->includeChildren(true);
?>
lockable
If set to false, the column will remain in that side of the TreeList where its own locked configuration placed it.
Returns
\Kendo\UI\TreeListColumn
Parameters
$value boolean
Example
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->lockable(true);
?>
locked
If set to true, the TreeList will display the column as locked (frozen).
Returns
\Kendo\UI\TreeListColumn
Parameters
$value boolean
Example
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->locked(true);
?>
menu
If set to true, the TreeList will display the column in the column menu. By default, the column menu includes all data-bound columns, that is, the ones with a set field option.
Returns
\Kendo\UI\TreeListColumn
Parameters
$value boolean
Example
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->menu(true);
?>
minScreenWidth
The pixel screen width below which the column will be hidden. The setting takes precedence over the hidden setting and the two cannot not be used at the same time.
Returns
\Kendo\UI\TreeListColumn
Parameters
$value float
Example
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->minScreenWidth(1);
?>
selectable
If set to true the treelist will render a select column with checkboxes in each cell, thus enabling multi-row selection. The header checkbox allows users to select/deselect all the rows on the current page.
Returns
\Kendo\UI\TreeListColumn
Parameters
$value boolean
Example
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->selectable(true);
?>
sortable
If set to true and sorting is enabled, the user can click the column header and sort the TreeList by the column field. If set to false, sorting will be disabled for this column. By default, all columns are sortable if sorting is enabled though the sortable option.
Returns
\Kendo\UI\TreeListColumn
Parameters
$value boolean|\Kendo\UI\TreeListColumnSortable|array
Example - using boolean
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->sortable(true);
?>
Example - using \Kendo\UI\TreeListColumnSortable
<?php
$column = new \Kendo\UI\TreeListColumn();
$sortable = new \Kendo\UI\TreeListColumnSortable();
$compare = new \Kendo\JavaScriptFunction('function() { }');
$sortable->compare($compare);
$column->sortable($sortable);
?>
Example - using array
<?php
$column = new \Kendo\UI\TreeListColumn();
$compare = new \Kendo\JavaScriptFunction('function() { }');
$column->sortable(array('compare' => $compare));
?>
template
The template which renders the column content. The TreeList renders table rows (
Returns
\Kendo\UI\TreeListColumn
Parameters
$value string|\Kendo\JavaScriptFunction
Example - using string
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->template('value');
?>
Example - using \Kendo\JavaScriptFunction
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->template(new \Kendo\JavaScriptFunction('function() { }'));
?>
title
The text that is displayed in the column header cell. If not set, the TreeList uses field.
Returns
\Kendo\UI\TreeListColumn
Parameters
$value string
Example
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->title('value');
?>
width
The width of the column. Numeric values are treated as pixels.
Returns
\Kendo\UI\TreeListColumn
Parameters
$value string|float
Example - using string
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->width('value');
?>
Example - using float
<?php
$column = new \Kendo\UI\TreeListColumn();
$column->width(1);
?>