\Kendo\UI\SpreadsheetSheetFilterColumn

A PHP class representing the column setting of SpreadsheetSheetFilterColumns.

Methods

addCriteriaItem

Adds one or more SpreadsheetSheetFilterColumnCriteriaItem to the SpreadsheetSheetFilterColumn.

Returns

\Kendo\UI\SpreadsheetSheetFilterColumn

Parameters

$value[, $value2, ...] \Kendo\UI\SpreadsheetSheetFilterColumnCriteriaItem |array

Example - using \Kendo\UI\SpreadsheetSheetFilterColumnCriteriaItem

<?php
$column = new \Kendo\UI\SpreadsheetSheetFilterColumn();
$criteriaItem = new \Kendo\UI\SpreadsheetSheetFilterColumnCriteriaItem();
$operator = 'value';
$criteriaItem->operator($operator);
$column->addCriteriaItem($criteriaItem);
?>

Example - using array

<?php
$column = new \Kendo\UI\SpreadsheetSheetFilterColumn();
$operator = 'value';
$column->addCriteriaItem(array('operator' => $operator));
?>

Example - adding more than one SpreadsheetSheetFilterColumnCriteriaItem

<?php
$column = new \Kendo\UI\SpreadsheetSheetFilterColumn();
$first  = new \Kendo\UI\SpreadsheetSheetFilterColumnCriteriaItem();
$second = new \Kendo\UI\SpreadsheetSheetFilterColumnCriteriaItem();
$column->addCriteriaItem($first, $second);
?>

filter

The filter to apply to this column.The supported filters are:

  • value - filters based on unique values
  • custom - applies custom filtering criteria
  • top - filters the top or bottom records
  • dynamic - filters based on dynamic criteria

Returns

\Kendo\UI\SpreadsheetSheetFilterColumn

Parameters

$value string

Example

<?php
$column = new \Kendo\UI\SpreadsheetSheetFilterColumn();
$column->filter('value');
?>

index

The index of the column relative to the filter range.

Returns

\Kendo\UI\SpreadsheetSheetFilterColumn

Parameters

$value float

Example

<?php
$column = new \Kendo\UI\SpreadsheetSheetFilterColumn();
$column->index(1);
?>

logic

The logical operator to apply to filter criteria.Possible values are and, or.

Returns

\Kendo\UI\SpreadsheetSheetFilterColumn

Parameters

$value string

Example

<?php
$column = new \Kendo\UI\SpreadsheetSheetFilterColumn();
$column->logic('value');
?>

type

The filter sub-type, if any.Applicable types according to the main filter.

  • top
    • topNumber
    • topPercent
    • bottomNumber
    • bottomPercent
  • dynamic
    • aboveAverage
    • belowAverage
    • tomorrow
    • today
    • yesterday
    • nextWeek
    • thisWeek
    • lastWeek
    • nextMonth
    • thisMonth
    • lastMonth
    • nextQuarter
    • thisQuarter
    • lastQuarter
    • nextYear
    • thisYear
    • lastYear
    • yearToDate

Returns

\Kendo\UI\SpreadsheetSheetFilterColumn

Parameters

$value string

Example

<?php
$column = new \Kendo\UI\SpreadsheetSheetFilterColumn();
$column->type('value');
?>

value

The filter value for filters that require a single value, e.g. "top".

Returns

\Kendo\UI\SpreadsheetSheetFilterColumn

Parameters

$value float |string |date

Example - using float

<?php
$column = new \Kendo\UI\SpreadsheetSheetFilterColumn();
$column->value(1);
?>

Example - using string

<?php
$column = new \Kendo\UI\SpreadsheetSheetFilterColumn();
$column->value('value');
?>

Example - using date

<?php
$column = new \Kendo\UI\SpreadsheetSheetFilterColumn();
$column->value(new date());
?>

values

The filter values for filters that support multiple values.

Returns

\Kendo\UI\SpreadsheetSheetFilterColumn

Parameters

$value array

Example

<?php
$column = new \Kendo\UI\SpreadsheetSheetFilterColumn();
$column->values(array());
?>
Is this article helpful? Yes / No
Thank you for your feedback!

Give article feedback

Tell us how we can improve the information

close
Dummy