| Property |
Type |
Description |
|
| $contentOptions |
|
the HTML attributes for the data cell tag. This can either be an array of attributes or an
anonymous function ([[Closure]]) that returns such an array. The signature of the function should be the
following: function ($model, $key, $index, $column). A function may be used to assign different attributes
to different rows based on the data in that row. |
|
| $deleteOptions |
|
HTML attributes for the delete action button. The following additional options are recognized:
- label: _string_, the label for the delete action button. This is not html encoded. Defaults to Delete.
- message: _string_, the delete confirmation message to display when the delete button is clicked.
Defaults to Are you sure to delete this item?. |
|
| $dropdown |
|
whether the action buttons are to be displayed as a dropdown |
|
| $dropdownButton |
|
the dropdown button options. This configuration will be applicable only if [[dropdown]] is true.
The following special options are recognized:
- label: _string_', the button label to be displayed. Defaults to Actions.
- caret: _string_', the caret symbol to be appended to the dropdown button.
Defaults to . |
|
| $dropdownMenu |
|
the HTML attributes for the Dropdown menu. Applicable if dropdown is true. |
|
| $dropdownOptions |
|
the HTML attributes for the Dropdown container. The class dropdown will be added. To align a
dropdown at the right edge of the page container, you set the class to pull-right. |
|
| $hAlign |
|
the horizontal alignment of each column. Should be one of [[GridView::ALIGN_LEFT]],
[[GridView::ALIGN_RIGHT]], or [[GridView::ALIGN_CENTER]]. |
|
| $headerOptions |
|
the HTML attributes for the header cell tag. |
|
| $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 |
|
| $updateOptions |
|
HTML attributes for the update action button. The following additional option is recognized:
- label: _string_, the label for the update action button. This is not html encoded. Defaults to Update. |
|
| $vAlign |
|
the vertical alignment of each column. Should be one of [[GridView::ALIGN_TOP]],
[[GridView::ALIGN_BOTTOM]], or [[GridView::ALIGN_MIDDLE]]. |
|
| $viewOptions |
|
HTML attributes for the view action button. The following additional option is recognized:
label: _string_, the label for the view action button. This is not html encoded. Defaults to View. |
|
| $width |
|
the width of each column (matches the CSS width property). |
|