Trait kartik\grid\ColumnTrait

The internally generated client script to initialize

Collection of row data for the column for the current page

The view instance

An unique identifier for the Column. If not set, it will be automatically generated.

The horizontal alignment of each column. Should be one of GridView::ALIGN_LEFT, GridView::ALIGN_RIGHT, or GridView::ALIGN_CENTER.

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.

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.

Whether to just hide the page summary display but still calculate the summary based on $pageSummary settings

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 kartik\grid\GridView::$filterPosition for the grid is set to kartik\grid\GridView::FILTER_POS_BODY.

Whether to force no wrapping on all table cells in the column

See also http://www.w3schools.com/cssref/pr_text_white-space.asp.

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:

  // 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.

In which format should the value of each data model be displayed as (e.g. "raw", "text", "html", ['date', 'php:Y-m-d']). Supported formats are determined by the formatter used by the kartik\grid\GridView. Default format is "text" which will format the value as an HTML-encoded plain text when yii\i18n\Formatter is used as the formatter of the GridView.

If this is not set - it will default to the format setting for the Column.

See also yii\i18n\Formatter::format().

The summary function that will be used to calculate the page summary for the column. If setting as Closure, you can set it to an anonymous function with the following signature:

function ($data)

• the $data variable will contain array of the selected page rows for the column.

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
• colspan: int, the column count that will be merged.
• data-colspan-dir: string, whether ltr or rtl. Defaults to ltr. If this is set to ltr the columns will be merged starting from this column to the right (i.e. left to right). If this is set to rtl, the columns will be merged starting from this column to the left (i.e. right to left).

Whether to strip HTML tags from the column during export. This can be useful for column data that is mainly a hyperlink or contains HTML markup that are not needed for display at export. Defaults to false.

The vertical alignment of each column. Should be one of GridView::ALIGN_TOP, GridView::ALIGN_BOTTOM, or GridView::ALIGN_MIDDLE.

The width of each column (matches the CSS width property).

See also http://www.w3schools.com/cssref/pr_dim_width.asp.