| Property |
Type |
Description |
|
| $filterType |
|
the filter input type for each filter input. You can use one of the GridView::FILTER_ constants or
pass any widget classname (extending the Yii Input Widget). |
|
| $filterWidgetOptions |
|
the options/settings for the filter widget. Will be used only if you set filterType to a widget
classname that exists. |
|
| $group |
|
whether to group grid data by this column. Defaults to false. Note that your query must sort the
data by this column for it to be effective. |
|
| $groupEvenCssClass |
|
|
|
| $groupFooter |
|
configuration of the group footer which will be displayed as a separate row. If this is
empty, no group footer will be rendered. If setup as a Closure, the signature of the function should be:
function ($model, $key, $index, $column), where $model, $key, and $index refer to the model, key and
index of the row currently being rendered, and $column is a reference to the DataColumn object.
$column is a reference to the DataColumn object. The following array keys are recognized:
- mergeColumns: array, of columns that will be merged as from, to pairs. For example if you need to merge
column numbers 0 to 2 and column numbers 3 to 6, you can set this as:
php
[
[0, 2], [3, 6]
]
- content: array, footer content for each column. You must set this as $key => $value, where $key is the 0
based index for the column, and $value is the content to display for the column. The $value can take in
special function names to summarize values for the column. If set to one of GridView::F_COUNT,
GridView::F_SUM, GridView::F_AVG, GridView::F_MAX, GridView::F_MIN, the values will be auto
summarized. For example:
php
[
0 => 'Total',
8 => GridView::F_SUM
]
- contentFormats: array, footer content formats for each column. This is only applicable currently only for
number type or a custom type using a javascript callback. You must set this as $key => $value, where
$key is the 0 based index for the column, and $value is the format settings for the column. The
$value is a format specification setup as an array containing one or more of the following options:
- format: string, whether number or callback
- decimals: number, number of decimals (for number format only)
- decPoint: string, decimals point character (for number format only). Defaults to ..
- thousandSep: string, thousands separator character (for number format only). Defaults to ,.
- func: string, the javascript callback function name (for callback format only). This should be set to a
globally accessible javascript function name. For example if you set this to customCallback, the function
should be of the signature: function customCallback(source, data) { return custom_convert(source, data); }.
The parameters for the callback function that will be passed are:
- source: string, the summary column source as set in content section if available
- data: array, the text values of each of the child columns in this group.
An example of setting the content:
php
[
7 => ['format'=>'callback', 'func'=>'customCallback']
8 => ['format'=>'number', 'decimals'=>2, 'decPoint'=>'.', 'thousandSep'=>',']
]
- contentOptions: array, footer HTML attributes for each column. You must set this as $key => $value, where
$key is the 0 based index for the column, and $value is the HTML attributes to apply for the column. The
$value must be an array of HTML attributes for the table column. An example of setting the contentOptions:
php
[
0 => ['style'=>'font-weight:bold'],
8 => ['style'=>'text-align:right']
]
- options: array, HTML attributes for the group footer row. |
|
| $groupHeader |
|
configuration of the group header which will be displayed as a separate row above the group.
If this is empty, no group header will be rendered. If setup as a Closure, the signature of the function
should be: function ($model, $key, $index, $column), where $model, $key, and $index refer to the
model, key and index of the row currently being rendered, and $column is a reference to the DataColumn
object. The following array keys are recognized:
- mergeColumns: array, of columns that will be merged as from, to pairs. For example if you need to merge
column numbers 0 to 2 and column numbers 3 to 6, you can set this as:
php
[
[0, 2], [3, 6]
]
- content: array, header content for each column. You must set this as $key => $value, where $key is the
zero based index for the column, and $value is the content to display for the column. The $value can take in
special function names to summarize values for the column. If set to one of [[GridView::F_COUNT]],
[[GridView::F_SUM]], [[GridView::F_AVG]], [[GridView::F_MAX]], [[GridView::F_MIN]], the values will be auto summarized.
- contentFormats: array, header content formats for each column. This is only applicable currently only for
number type or a custom type using a javascript callback. You must set this as $key => $value, where
$key is the 0 based index for the column, and $value is the format settings for the column. The
$value is a format specification setup as an array containing one or more of the following options:
- format: string, whether number or callback
- decimals: number, number of decimals (for number format only)
- decPoint: string, decimals point character (for number format only). Defaults to ..
- thousandSep: string, thousands separator character (for number format only). Defaults to ,.
- func: string, the javascript callback function name (for callback format only). This should be set to a
globally accessible javascript function name. For example if you set this to customCallback, the function
should be of the signature: function customCallback(source, data) { return custom_convert(source, data);}.
The parameters for the callback function that will be passed are:
- source: string, the summary column source as set in content section if available
- data: array, the text values of each of the child columns in this group.
An example of setting the content:
php
[
7 => ['format'=>'callback', 'func'=>'customCallback']
8 => ['format'=>'number', 'decimals'=>2, 'decPoint'=>'.', 'thousandSep'=>',']
]
- contentOptions: array, header HTML attributes for each column. You must set this as $key => $value, where
$key is the 0 based index for the column, and $value is the HTML attributes to apply for the column. The
$value must be an array of HTML attributes for the table column. An example of setting the contentOptions:
php
[
0 => ['style'=>'font-weight:bold'],
8 => ['style'=>'text-align:right']
]
- options: array, HTML attributes for the group header row. |
|
| $groupOddCssClass |
|
|
|
| $groupedRow |
|
|
|
| $hAlign |
|
the horizontal alignment of each column. Should be one of [[GridView::ALIGN_LEFT]],
[[GridView::ALIGN_RIGHT]], or [[GridView::ALIGN_CENTER]]. |
|
| $hidden |
|
whether the column is hidden from display. This is different than the visible property, in the
sense, that the column is rendered, but hidden from display. This will allow you to still export the column
using the export function. |
|
| $hiddenFromExport |
|
whether the column is hidden in export output. If set to boolean true, it will hide the
column for all export formats. If set as an array, it will accept the list of GridView export formats and
hide output only for them. |
|
| $hidePageSummary |
|
whether to just hide the page summary display but still calculate the summary based on
[[pageSummary]] settings |
|
| $mergeHeader |
|
whether to merge the header title row and the filter row. This will not render the filter for the
column and can be used when filter is set to false. Defaults to false. This is only applicable when
[[GridView::filterPosition]] for the grid is set to [[GridView::FILTER_POS_BODY]]. |
|
| $noWrap |
|
whether to force no wrapping on all table cells in the column |
|
| $pageSummary |
|
the page summary that is displayed above the footer. You can set it to one of the
following:
- false: the summary will not be displayed.
- true: the page summary for the column will be calculated and displayed using the
[[pageSummaryFunc]] setting.
- string: will be displayed as is.
- Closure: you can set it to an anonymous function with the following signature:
php
example 1
function ($summary, $data, $widget) { return 'Count is ' . $summary; }
example 2
function ($summary, $data, $widget) { return 'Range ' . min($data) . ' to ' . max($data); }
where:
- the $summary variable will be replaced with the calculated summary using the [[pageSummaryFunc]] setting.
- the $data variable will contain array of the selected page rows for the column. |
|
| $pageSummaryFunc |
|
the summary function that will be used to calculate the page summary for the column. |
|
| $pageSummaryOptions |
|
HTML attributes for the page summary cell. The following special attributes are available:
- prepend: _string_, a prefix string that will be prepended before the pageSummary content
- append: _string_, a suffix string that will be appended after the pageSummary content |
|
| $subGroupOf |
|
the column index of which this group is a sub group of. This is validated only if group
is set to true. If setup as a Closure, the signature of the function should be: function ($model, $key,
$index, $column), where $model, $key, and $index refer to the model, key and index of the row
currently being rendered, and $column is a reference to the DataColumn object. |
|
| $vAlign |
|
the vertical alignment of each column. Should be one of [[GridView::ALIGN_TOP]],
[[GridView::ALIGN_BOTTOM]], or [[GridView::ALIGN_MIDDLE]]. |
|
| $width |
|
the width of each column (matches the CSS width property). |
|
| $xlFormat |
|
the cell format for EXCEL exported content. |
|