\Kendo\UI\SpreadsheetSheet

A PHP class representing the sheet setting of SpreadsheetSheets.

Methods

activeCell

The active cell in the sheet, e.g. "A1".

Returns

\Kendo\UI\SpreadsheetSheet

Parameters

$value string

Example

<?php
$sheet = new \Kendo\UI\SpreadsheetSheet();
$sheet->activeCell('value');
?>

addColumn

Adds one or more SpreadsheetSheetColumn to the SpreadsheetSheet.

Returns

\Kendo\UI\SpreadsheetSheet

Parameters

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

Example - using \Kendo\UI\SpreadsheetSheetColumn

<?php
$sheet = new \Kendo\UI\SpreadsheetSheet();
$column = new \Kendo\UI\SpreadsheetSheetColumn();
$index = 1;
$column->index($index);
$sheet->addColumn($column);
?>

Example - using array

<?php
$sheet = new \Kendo\UI\SpreadsheetSheet();
$index = 1;
$sheet->addColumn(array('index' => $index));
?>

Example - adding more than one SpreadsheetSheetColumn

<?php
$sheet = new \Kendo\UI\SpreadsheetSheet();
$first  = new \Kendo\UI\SpreadsheetSheetColumn();
$second = new \Kendo\UI\SpreadsheetSheetColumn();
$sheet->addColumn($first, $second);
?>

dataSource

Sets the data source of the widget.

Returns

\Kendo\UI\SpreadsheetSheet

Parameters

$value \Kendo\Data\DataSource |array

Example - using \Kendo\Data\DataSource

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

Example - using array

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

filter

Defines the filtering criteria for this sheet, if any.

Returns

\Kendo\UI\SpreadsheetSheet

Parameters

$value \Kendo\UI\SpreadsheetSheetFilter |array

Example - using \Kendo\UI\SpreadsheetSheetFilter

<?php
$sheet = new \Kendo\UI\SpreadsheetSheet();
$filter = new \Kendo\UI\SpreadsheetSheetFilter();
$ref = 'value';
$filter->ref($ref);
$sheet->filter($filter);
?>

Example - using array

<?php
$sheet = new \Kendo\UI\SpreadsheetSheet();
$ref = 'value';
$sheet->filter(array('ref' => $ref));
?>

frozenColumns

The number of frozen columns in this sheet.

Returns

\Kendo\UI\SpreadsheetSheet

Parameters

$value float

Example

<?php
$sheet = new \Kendo\UI\SpreadsheetSheet();
$sheet->frozenColumns(1);
?>

frozenRows

The number of frozen rows in this sheet.

Returns

\Kendo\UI\SpreadsheetSheet

Parameters

$value float

Example

<?php
$sheet = new \Kendo\UI\SpreadsheetSheet();
$sheet->frozenRows(1);
?>

mergedCells

An array of merged cell ranges, e.g. "B1:D2".

Returns

\Kendo\UI\SpreadsheetSheet

Parameters

$value array

Example

<?php
$sheet = new \Kendo\UI\SpreadsheetSheet();
$sheet->mergedCells(array());
?>

name

The name of the sheet.

Returns

\Kendo\UI\SpreadsheetSheet

Parameters

$value string

Example

<?php
$sheet = new \Kendo\UI\SpreadsheetSheet();
$sheet->name('value');
?>

addRow

Adds one or more SpreadsheetSheetRow to the SpreadsheetSheet.

Returns

\Kendo\UI\SpreadsheetSheet

Parameters

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

Example - using \Kendo\UI\SpreadsheetSheetRow

<?php
$sheet = new \Kendo\UI\SpreadsheetSheet();
$row = new \Kendo\UI\SpreadsheetSheetRow();
$height = 1;
$row->height($height);
$sheet->addRow($row);
?>

Example - using array

<?php
$sheet = new \Kendo\UI\SpreadsheetSheet();
$height = 1;
$sheet->addRow(array('height' => $height));
?>

Example - adding more than one SpreadsheetSheetRow

<?php
$sheet = new \Kendo\UI\SpreadsheetSheet();
$first  = new \Kendo\UI\SpreadsheetSheetRow();
$second = new \Kendo\UI\SpreadsheetSheetRow();
$sheet->addRow($first, $second);
?>

selection

The selected range in the sheet, e.g. "A1:B10".

Returns

\Kendo\UI\SpreadsheetSheet

Parameters

$value string

Example

<?php
$sheet = new \Kendo\UI\SpreadsheetSheet();
$sheet->selection('value');
?>

showGridLines

A boolean value indicating if the sheet grid lines should be displayed.

Returns

\Kendo\UI\SpreadsheetSheet

Parameters

$value boolean

Example

<?php
$sheet = new \Kendo\UI\SpreadsheetSheet();
$sheet->showGridLines(true);
?>

sort

Defines the sort criteria for the sheet.

Returns

\Kendo\UI\SpreadsheetSheet

Parameters

$value \Kendo\UI\SpreadsheetSheetSort |array

Example - using \Kendo\UI\SpreadsheetSheetSort

<?php
$sheet = new \Kendo\UI\SpreadsheetSheet();
$sort = new \Kendo\UI\SpreadsheetSheetSort();
$ref = 'value';
$sort->ref($ref);
$sheet->sort($sort);
?>

Example - using array

<?php
$sheet = new \Kendo\UI\SpreadsheetSheet();
$ref = 'value';
$sheet->sort(array('ref' => $ref));
?>
Is this article helpful? Yes / No
Thank you for your feedback!

Give article feedback

Tell us how we can improve this article

close
Dummy