\Kendo\UI\GridColumnFilterableCell

A PHP class representing the cell setting of GridColumnFilterable.

Methods

dataSource

Sets the data source of the widget.

Returns

\Kendo\UI\GridColumnFilterableCell

Parameters

$value \Kendo\Data\DataSource |array

Example - using \Kendo\Data\DataSource

<?php
$cell = new \Kendo\UI\GridColumnFilterableCell();
$dataSource = new \Kendo\Data\DataSource();
$cell->dataSource($dataSource);
?>

Example - using array

<?php
$cell = new \Kendo\UI\GridColumnFilterableCell();
$schema = new \Kendo\Data\DataSourceSchema();
$cell->dataSource(array('schema' => $schema));
?>

dataTextField

Specifies the name of the field which will provide the text representation for the AutoComplete suggestion (when using String type column) when CustomDataSource is provided. By default the name of the field bound to the column will be used.

Returns

\Kendo\UI\GridColumnFilterableCell

Parameters

$value string

Example

<?php
$cell = new \Kendo\UI\GridColumnFilterableCell();
$cell->dataTextField('value');
?>

delay

Specifies the delay of the AutoComplete widget which will provide the suggest functionality (when using String type column).

Returns

\Kendo\UI\GridColumnFilterableCell

Parameters

$value float

Example

<?php
$cell = new \Kendo\UI\GridColumnFilterableCell();
$cell->delay(1);
?>

enabled

When set to false the Grid will not render the cell filtering widget for that specific column.

Returns

\Kendo\UI\GridColumnFilterableCell

Parameters

$value boolean

Example

<?php
$cell = new \Kendo\UI\GridColumnFilterableCell();
$cell->enabled(true);
?>

inputWidth

Specifies the width of the input before it is initialized or turned into a widget. Provides convenient way to set the width according to the column width.

Returns

\Kendo\UI\GridColumnFilterableCell

Parameters

$value float

Example

<?php
$cell = new \Kendo\UI\GridColumnFilterableCell();
$cell->inputWidth(1);
?>

minLength

Specifies the minLength option of the AutoComplete widget when column is of type string.

Returns

\Kendo\UI\GridColumnFilterableCell

Parameters

$value float

Example

<?php
$cell = new \Kendo\UI\GridColumnFilterableCell();
$cell->minLength(1);
?>

operator

Specifies the default operator that will be used for the cell filtering.

Returns

\Kendo\UI\GridColumnFilterableCell

Parameters

$value string

Example

<?php
$cell = new \Kendo\UI\GridColumnFilterableCell();
$cell->operator('value');
?>

showOperators

Specifies whether to show or hide the DropDownList with the operators.

Returns

\Kendo\UI\GridColumnFilterableCell

Parameters

$value boolean

Example

<?php
$cell = new \Kendo\UI\GridColumnFilterableCell();
$cell->showOperators(true);
?>

suggestionOperator

Specifies the AutoComplete filter option. The possible values are the same as the ones for the AutoComplete filter option - "startswith", "endswith", "contains". The "contains" operator performs a case-insensitive search. To perform a case-sensitive filtering, set a custom filtering function through the dataSource.filter.operator option.

Returns

\Kendo\UI\GridColumnFilterableCell

Parameters

$value string

Example

<?php
$cell = new \Kendo\UI\GridColumnFilterableCell();
$cell->suggestionOperator('value');
?>

template

JavaScript function which will customize how the input for the filter value is rendered. The function receives an object argument with two fields: element - the default input inside the filter cell; or dataSource - a Kendo UI DataSource instance, which has the same settings as the Grid dataSource, but will only contain data items with unique values for the current column. This instance is also used by the default AutoComplete widget, which is used inside the filter cell if no template is set. Keep in mind that the passed dataSource instance may still not be populated at the time the template function is called, if the Grid uses remote binding..

Returns

\Kendo\UI\GridColumnFilterableCell

Parameters

$value \Kendo\JavaScriptFunction

Example

<?php
$cell = new \Kendo\UI\GridColumnFilterableCell();
$cell->template(new \Kendo\JavaScriptFunction('function() { }'));
?>
Is this article helpful? Yes / No
Thank you for your feedback!

Give article feedback

Tell us how we can improve this article

close
Dummy