\Kendo\UI\GridColumnFilterable

A PHP class representing the filterable setting of GridColumn.

Methods

cell

Specifies options for the filter header cell when filter mode is set to 'row'.Can be set to a JavaScript object which represents the filter cell configuration.

Returns

\Kendo\UI\GridColumnFilterable

Parameters

$value \Kendo\UI\GridColumnFilterableCell|array

Example - using \Kendo\UI\GridColumnFilterableCell

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

Example - using array

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

checkAll

Controls whether to show or not the checkAll checkbox before the other checkboxes when using checkbox filtering.

Returns

\Kendo\UI\GridColumnFilterable

Parameters

$value boolean

Example

<?php
$filterable = new \Kendo\UI\GridColumnFilterable();
$filterable->checkAll(true);
?>

dataSource

Sets the data source of the widget.

Returns

\Kendo\UI\GridColumnFilterable

Parameters

$value \Kendo\Data\DataSource|array

Example - using \Kendo\Data\DataSource

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

Example - using array

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

extra

If set to true the filter menu of the column allows the user to input a second criterion.

Returns

\Kendo\UI\GridColumnFilterable

Parameters

$value boolean

Example

<?php
$filterable = new \Kendo\UI\GridColumnFilterable();
$filterable->extra(true);
?>

ignoreCase

Toggles between case-insensitive (default) and case-sensitive searching.

Returns

\Kendo\UI\GridColumnFilterable

Parameters

$value boolean

Example

<?php
$filterable = new \Kendo\UI\GridColumnFilterable();
$filterable->ignoreCase(true);
?>

itemTemplate

Allows customization on the logic that renders the checkboxes when using checkbox filtering.

Returns

\Kendo\UI\GridColumnFilterable

Parameters

$value \Kendo\JavaScriptFunction

Example

<?php
$filterable = new \Kendo\UI\GridColumnFilterable();
$filterable->itemTemplate(new \Kendo\JavaScriptFunction('function() { }'));
?>

multi

Use this option to enable the MultiCheck filtering support for that column.

Returns

\Kendo\UI\GridColumnFilterable

Parameters

$value boolean

Example

<?php
$filterable = new \Kendo\UI\GridColumnFilterable();
$filterable->multi(true);
?>

operators

The property is identical to filterable.operators, but is used for a specific column.

Returns

\Kendo\UI\GridColumnFilterable

Parameters

$value ``

Controls whether to show a search box when checkbox filtering is enabled.

Returns

\Kendo\UI\GridColumnFilterable

Parameters

$value boolean

Example

<?php
$filterable = new \Kendo\UI\GridColumnFilterable();
$filterable->search(true);
?>

ui

The role data attribute of the widget used in the filter menu or a JavaScript function which initializes that widget.

Returns

\Kendo\UI\GridColumnFilterable

Parameters

$value string|\Kendo\JavaScriptFunction

Example - using string

<?php
$filterable = new \Kendo\UI\GridColumnFilterable();
$filterable->ui('value');
?>

Example - using \Kendo\JavaScriptFunction

<?php
$filterable = new \Kendo\UI\GridColumnFilterable();
$filterable->ui(new \Kendo\JavaScriptFunction('function() { }'));
?>
In this article
Not finding the help you need?