# GridView

> Renders a debugger grid whose footer sentence comes from the shared PHPForge\Debug\View\Grid\GridCount renderer.

[API reference](/docs/api/index.md) › [Debug](/docs/extensions/debug/reference/index.md) › [widgets](/docs/extensions/debug/reference/widgets/index.md) › GridView

| final class | `yii\debug\widgets\GridView` |
| --- | --- |
| Extends | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) » [`yii\widgets\BaseListView`](/docs/api/yii/widgets/baselistview/index.md) » [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) » [`yii\base\Component`](/docs/api/yii/base/component/index.md) » [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| Implements | [`yii\base\ViewContextInterface`](/docs/api/yii/base/viewcontextinterface/index.md), [`yii\base\Configurable`](/docs/api/yii/base/configurable/index.md) |
| Source | [`src/widgets/GridView.php`](https://github.com/yii2-extensions/debug/blob/main/src/widgets/GridView.php#L13) |

Renders a debugger grid whose footer sentence comes from the shared [`GridCount`](https://github.com/php-forge/debug-core/blob/b70459f033a1d7a1c5edf7951029aad2061986dd/src/View/Grid/GridCount.php) renderer.

## Properties

| Property | Type | Description | Defined by |
| --- | --- | --- | --- |
| <span id="property-afterRow"></span>[`$afterRow`](/docs/api/yii/grid/gridview/index.md#property-afterRow) | [`Closure`](https://www.php.net/manual/en/class.closure.php) | An anonymous function that is called once AFTER rendering each data model. Default: `null`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-autoIdPrefix"></span>[`$autoIdPrefix`](/docs/api/yii/base/widget/index.md#property-autoIdPrefix) static | `string` | The prefix to the automatically generated widget IDs. Default: `'w'`. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="property-beforeRow"></span>[`$beforeRow`](/docs/api/yii/grid/gridview/index.md#property-beforeRow) | [`Closure`](https://www.php.net/manual/en/class.closure.php) | An anonymous function that is called once BEFORE rendering each data model. Default: `null`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-behaviors"></span>[`$behaviors`](/docs/api/yii/base/component/index.md#property-behaviors) read-only | `array<`[`yii\base\Behavior`](/docs/api/yii/base/behavior/index.md)`<static>>` | List of behaviors attached to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="property-caption"></span>[`$caption`](/docs/api/yii/grid/gridview/index.md#property-caption) | `string` | The caption of the grid table Default: `null`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-captionOptions"></span>[`$captionOptions`](/docs/api/yii/grid/gridview/index.md#property-captionOptions) | `array` | The HTML attributes for the caption element. Default: `[]`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-clientScript"></span>[`$clientScript`](/docs/api/yii/grid/gridview/index.md#property-clientScript) | `array\|`[`yii\web\client\ClientScriptInterface`](/docs/api/yii/web/client/clientscriptinterface/index.md)`\|null` | Client script class to use for client-side validation. Default: `null`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-columns"></span>[`$columns`](/docs/api/yii/grid/gridview/index.md#property-columns) | `array` | Grid column configuration. Default: `[]`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-dataColumnClass"></span>[`$dataColumnClass`](/docs/api/yii/grid/gridview/index.md#property-dataColumnClass) | `string` | The default data column class if the class name is not explicitly specified when configuring a data column. Default: `null`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-dataProvider"></span>[`$dataProvider`](/docs/api/yii/widgets/baselistview/index.md#property-dataProvider) | [`yii\data\DataProviderInterface`](/docs/api/yii/data/dataproviderinterface/index.md) | The data provider for the view. Default: `null`. | [`yii\widgets\BaseListView`](/docs/api/yii/widgets/baselistview/index.md) |
| <span id="property-emptyCell"></span>[`$emptyCell`](/docs/api/yii/grid/gridview/index.md#property-emptyCell) | `string` | The HTML display when the content of a cell is empty. Default: `'&nbsp;'`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-emptyText"></span>[`$emptyText`](/docs/api/yii/widgets/baselistview/index.md#property-emptyText) | `string\|false\|null` | The HTML content to be displayed when [`$dataProvider`](/docs/api/yii/widgets/baselistview/index.md#property-dataProvider) does not have any data. Default: `null`. | [`yii\widgets\BaseListView`](/docs/api/yii/widgets/baselistview/index.md) |
| <span id="property-emptyTextOptions"></span>[`$emptyTextOptions`](/docs/api/yii/widgets/baselistview/index.md#property-emptyTextOptions) | `array` | The HTML attributes for the emptyText of the list view. Default: `['class' => 'empty']`. | [`yii\widgets\BaseListView`](/docs/api/yii/widgets/baselistview/index.md) |
| <span id="property-filterErrorOptions"></span>[`$filterErrorOptions`](/docs/api/yii/grid/gridview/index.md#property-filterErrorOptions) | `array` | The options for rendering every filter error message. Default: `['class' => 'field-error']`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-filterErrorSummaryOptions"></span>[`$filterErrorSummaryOptions`](/docs/api/yii/grid/gridview/index.md#property-filterErrorSummaryOptions) | `array` | The options for rendering the filter error summary. Default: `['class' => 'error-summary']`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-filterModel"></span>[`$filterModel`](/docs/api/yii/grid/gridview/index.md#property-filterModel) | [`yii\base\Model`](/docs/api/yii/base/model/index.md)`\|null` | The model that keeps the user-entered filter data. Default: `null`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-filterOnFocusOut"></span>[`$filterOnFocusOut`](/docs/api/yii/grid/gridview/index.md#property-filterOnFocusOut) | `bool` | Whatever to apply filters on losing focus. Default: `true`. Available since 2.0.16. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-filterPosition"></span>[`$filterPosition`](/docs/api/yii/grid/gridview/index.md#property-filterPosition) | `string` | Whether the filters should be displayed in the grid view. Default: `self::FILTER_POS_BODY`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-filterRowOptions"></span>[`$filterRowOptions`](/docs/api/yii/grid/gridview/index.md#property-filterRowOptions) | `array` | The HTML attributes for the filter row element. Default: `['class' => 'filters']`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-filterSelector"></span>[`$filterSelector`](/docs/api/yii/grid/gridview/index.md#property-filterSelector) | `string\|`[`Closure`](https://www.php.net/manual/en/class.closure.php)`(string, string): string` | JQuery selector for selecting filter input fields. Default: `null`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-filterUrl"></span>[`$filterUrl`](/docs/api/yii/grid/gridview/index.md#property-filterUrl) | `string\|array\|null` | The URL for returning the filtering result. `Url::to()` will be called to normalize the URL. Default: `null`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-footerRowOptions"></span>[`$footerRowOptions`](/docs/api/yii/grid/gridview/index.md#property-footerRowOptions) | `array` | The HTML attributes for the table footer row. Default: `[]`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-formatter"></span>[`$formatter`](/docs/api/yii/grid/gridview/index.md#property-formatter) | `array\|`[`yii\i18n\Formatter`](/docs/api/yii/i18n/formatter/index.md)`\|null` | The formatter used to format model attribute values into displayable texts. Default: `null`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-headerRowOptions"></span>[`$headerRowOptions`](/docs/api/yii/grid/gridview/index.md#property-headerRowOptions) | `array` | The HTML attributes for the table header row. Default: `[]`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-id"></span>[`$id`](/docs/api/yii/base/widget/index.md#property-id) | `string` | Id of the widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="property-layout"></span>[`$layout`](/docs/api/yii/grid/gridview/index.md#property-layout) | `string` | The layout that determines how different sections of the grid view should be organized. Default: `"{summary}\n{items}\n{pager}"`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-options"></span>[`$options`](/docs/api/yii/grid/gridview/index.md#property-options) | `array` | The HTML attributes for the container tag of the grid view. Default: `['class' => 'grid-view']`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-overrideFilterSelector"></span>[`$overrideFilterSelector`](/docs/api/yii/grid/gridview/index.md#property-overrideFilterSelector) | `bool` | If set, [`$filterSelector`](/docs/api/yii/grid/gridview/index.md#property-filterSelector) overrides the default selector of '#$id input, #$id select' (where $id is the filter row ID) rather than being added to it. Default: `false`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-pager"></span>[`$pager`](/docs/api/yii/widgets/baselistview/index.md#property-pager) | `array` | The configuration for the pager widget. Default: `[]`. | [`yii\widgets\BaseListView`](/docs/api/yii/widgets/baselistview/index.md) |
| <span id="property-placeFooterAfterBody"></span>[`$placeFooterAfterBody`](/docs/api/yii/grid/gridview/index.md#property-placeFooterAfterBody) | `bool` | Whether to place footer after body in DOM if $showFooter is true Default: `false`. Available since 2.0.14. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-rowOptions"></span>[`$rowOptions`](/docs/api/yii/grid/gridview/index.md#property-rowOptions) | `array\|`[`Closure`](https://www.php.net/manual/en/class.closure.php) | The HTML attributes for the table body rows. Default: `[]`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-showFooter"></span>[`$showFooter`](/docs/api/yii/grid/gridview/index.md#property-showFooter) | `bool` | Whether to show the footer section of the grid table. Default: `false`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-showHeader"></span>[`$showHeader`](/docs/api/yii/grid/gridview/index.md#property-showHeader) | `bool` | Whether to show the header section of the grid table. Default: `true`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-showOnEmpty"></span>[`$showOnEmpty`](/docs/api/yii/grid/gridview/index.md#property-showOnEmpty) | `bool` | Whether to show the grid view if [`$dataProvider`](/docs/api/yii/widgets/baselistview/index.md#property-dataProvider) returns no data. Default: `true`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-sorter"></span>[`$sorter`](/docs/api/yii/widgets/baselistview/index.md#property-sorter) | `array` | The configuration for the sorter widget. Default: `[]`. | [`yii\widgets\BaseListView`](/docs/api/yii/widgets/baselistview/index.md) |
| <span id="property-summary"></span>[`$summary`](/docs/api/yii/widgets/baselistview/index.md#property-summary) | `string\|null` | The HTML content to be displayed as the summary of the list view. Default: `null`. | [`yii\widgets\BaseListView`](/docs/api/yii/widgets/baselistview/index.md) |
| <span id="property-summaryOptions"></span>[`$summaryOptions`](/docs/api/yii/widgets/baselistview/index.md#property-summaryOptions) | `array` | The HTML attributes for the summary of the list view. Default: `['class' => 'summary']`. | [`yii\widgets\BaseListView`](/docs/api/yii/widgets/baselistview/index.md) |
| <span id="property-tableOptions"></span>[`$tableOptions`](/docs/api/yii/grid/gridview/index.md#property-tableOptions) | `array` | The HTML attributes for the grid table element. Default: `[]`. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="property-view"></span>[`$view`](/docs/api/yii/base/widget/index.md#property-view) | [`yii\web\View`](/docs/api/yii/web/view/index.md) | The view object that can be used to render views or view files. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="property-viewPath"></span>[`$viewPath`](/docs/api/yii/base/widget/index.md#property-viewPath) read-only | `string` | The directory containing the view files for this widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |

## Methods

| Method | Description | Defined by |
| --- | --- | --- |
| <span id="method-__construct"></span>[`__construct()`](/docs/api/yii/base/baseobject/index.md#method-__construct) | Constructor. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-__call"></span>[`__call()`](/docs/api/yii/base/component/index.md#method-__call) | Calls the named method which is not a class method. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__clone"></span>[`__clone()`](/docs/api/yii/base/component/index.md#method-__clone) | This method is called after the object is created by cloning an existing one. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__get"></span>[`__get()`](/docs/api/yii/base/component/index.md#method-__get) | Returns the value of a component property. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__isset"></span>[`__isset()`](/docs/api/yii/base/component/index.md#method-__isset) | Checks if a property is set, i.e. defined and not null. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__set"></span>[`__set()`](/docs/api/yii/base/component/index.md#method-__set) | Sets the value of a component property. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__unset"></span>[`__unset()`](/docs/api/yii/base/component/index.md#method-__unset) | Sets a component property to be null. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-afterRun"></span>[`afterRun()`](/docs/api/yii/base/widget/index.md#method-afterRun) | This method is invoked right after a widget is executed. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-attachBehavior"></span>[`attachBehavior()`](/docs/api/yii/base/component/index.md#method-attachBehavior) | Attaches a behavior to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-attachBehaviors"></span>[`attachBehaviors()`](/docs/api/yii/base/component/index.md#method-attachBehaviors) | Attaches a list of behaviors to the component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-beforeRun"></span>[`beforeRun()`](/docs/api/yii/base/widget/index.md#method-beforeRun) | This method is invoked right before the widget is executed. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-begin"></span>[`begin()`](/docs/api/yii/base/widget/index.md#method-begin) static | Begins a widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-behaviors"></span>[`behaviors()`](/docs/api/yii/base/component/index.md#method-behaviors) | Returns a list of behaviors that this component should behave as. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-canGetProperty"></span>[`canGetProperty()`](/docs/api/yii/base/component/index.md#method-canGetProperty) | Returns a value indicating whether a property can be read. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-canSetProperty"></span>[`canSetProperty()`](/docs/api/yii/base/component/index.md#method-canSetProperty) | Returns a value indicating whether a property can be set. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-className"></span>[`className()`](/docs/api/yii/base/baseobject/index.md#method-className) static | Returns the fully qualified name of this class. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-detachBehavior"></span>[`detachBehavior()`](/docs/api/yii/base/component/index.md#method-detachBehavior) | Detaches a behavior from the component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-detachBehaviors"></span>[`detachBehaviors()`](/docs/api/yii/base/component/index.md#method-detachBehaviors) | Detaches all behaviors from the component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-end"></span>[`end()`](/docs/api/yii/base/widget/index.md#method-end) static | Ends a widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-ensureBehaviors"></span>[`ensureBehaviors()`](/docs/api/yii/base/component/index.md#method-ensureBehaviors) | Makes sure that the behaviors declared in [`behaviors()`](/docs/api/yii/base/component/index.md#method-behaviors) are attached to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-getBehavior"></span>[`getBehavior()`](/docs/api/yii/base/component/index.md#method-getBehavior) | Returns the named behavior object. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-getBehaviors"></span>[`getBehaviors()`](/docs/api/yii/base/component/index.md#method-getBehaviors) | Returns all behaviors attached to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-getId"></span>[`getId()`](/docs/api/yii/base/widget/index.md#method-getId) | Returns the ID of the widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-getView"></span>[`getView()`](/docs/api/yii/base/widget/index.md#method-getView) | Returns the view object that can be used to render views or view files. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-getViewPath"></span>[`getViewPath()`](/docs/api/yii/base/widget/index.md#method-getViewPath) | Returns the directory containing the view files for this widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-hasEventHandlers"></span>[`hasEventHandlers()`](/docs/api/yii/base/component/index.md#method-hasEventHandlers) | Returns a value indicating whether there is any handler attached to the named event. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-hasMethod"></span>[`hasMethod()`](/docs/api/yii/base/component/index.md#method-hasMethod) | Returns a value indicating whether a method is defined. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-hasProperty"></span>[`hasProperty()`](/docs/api/yii/base/component/index.md#method-hasProperty) | Returns a value indicating whether a property is defined for this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-init"></span>[`init()`](/docs/api/yii/grid/gridview/index.md#method-init) | Initializes the grid view. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="method-off"></span>[`off()`](/docs/api/yii/base/component/index.md#method-off) | Detaches an existing event handler from this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-on"></span>[`on()`](/docs/api/yii/base/component/index.md#method-on) | Attaches an event handler to an event. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-render"></span>[`render()`](/docs/api/yii/base/widget/index.md#method-render) | Renders a view. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-renderCaption"></span>[`renderCaption()`](/docs/api/yii/grid/gridview/index.md#method-renderCaption) | Renders the caption element. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="method-renderColumnGroup"></span>[`renderColumnGroup()`](/docs/api/yii/grid/gridview/index.md#method-renderColumnGroup) | Renders the column group HTML. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="method-renderEmpty"></span>[`renderEmpty()`](/docs/api/yii/widgets/baselistview/index.md#method-renderEmpty) | Renders the HTML content indicating that the list view has no data. | [`yii\widgets\BaseListView`](/docs/api/yii/widgets/baselistview/index.md) |
| <span id="method-renderErrors"></span>[`renderErrors()`](/docs/api/yii/grid/gridview/index.md#method-renderErrors) | Renders validator errors of filter model. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="method-renderFile"></span>[`renderFile()`](/docs/api/yii/base/widget/index.md#method-renderFile) | Renders a view file. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-renderFilters"></span>[`renderFilters()`](/docs/api/yii/grid/gridview/index.md#method-renderFilters) | Renders the filter. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="method-renderItems"></span>[`renderItems()`](/docs/api/yii/grid/gridview/index.md#method-renderItems) | Renders the data models for the grid view. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="method-renderPager"></span>[`renderPager()`](/docs/api/yii/widgets/baselistview/index.md#method-renderPager) | Renders the pager. | [`yii\widgets\BaseListView`](/docs/api/yii/widgets/baselistview/index.md) |
| <span id="method-renderSection"></span>[`renderSection()`](/docs/api/yii/grid/gridview/index.md#method-renderSection) | Renders a section of the specified name. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="method-renderSorter"></span>[`renderSorter()`](/docs/api/yii/widgets/baselistview/index.md#method-renderSorter) | Renders the sorter. | [`yii\widgets\BaseListView`](/docs/api/yii/widgets/baselistview/index.md) |
| [`renderSummary()`](#method-renderSummary) | Renders the row-count sentence for the rows currently on screen. | `GridView` |
| <span id="method-renderTableBody"></span>[`renderTableBody()`](/docs/api/yii/grid/gridview/index.md#method-renderTableBody) | Renders the table body. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="method-renderTableFooter"></span>[`renderTableFooter()`](/docs/api/yii/grid/gridview/index.md#method-renderTableFooter) | Renders the table footer. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="method-renderTableHeader"></span>[`renderTableHeader()`](/docs/api/yii/grid/gridview/index.md#method-renderTableHeader) | Renders the table header. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="method-renderTableRow"></span>[`renderTableRow()`](/docs/api/yii/grid/gridview/index.md#method-renderTableRow) | Renders a table row with the given data model and key. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="method-run"></span>[`run()`](/docs/api/yii/grid/gridview/index.md#method-run) | Runs the widget. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="method-setId"></span>[`setId()`](/docs/api/yii/base/widget/index.md#method-setId) | Sets the ID of the widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-setView"></span>[`setView()`](/docs/api/yii/base/widget/index.md#method-setView) | Sets the view object to be used by this widget. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-trigger"></span>[`trigger()`](/docs/api/yii/base/component/index.md#method-trigger) | Triggers an event. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-widget"></span>[`widget()`](/docs/api/yii/base/widget/index.md#method-widget) static | Creates a widget instance and runs it. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="method-createDataColumn"></span>[`createDataColumn()`](/docs/api/yii/grid/gridview/index.md#method-createDataColumn) protected | Creates a [`DataColumn`](/docs/api/yii/grid/datacolumn/index.md) object based on a string in the format of "attribute:format:label". | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="method-getClientOptions"></span>[`getClientOptions()`](/docs/api/yii/grid/gridview/index.md#method-getClientOptions) protected | Returns the options for the grid view JS widget. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="method-guessColumns"></span>[`guessColumns()`](/docs/api/yii/grid/gridview/index.md#method-guessColumns) protected | This function tries to guess the columns to show from the given data if [`$columns`](/docs/api/yii/grid/gridview/index.md#property-columns) are not explicitly specified. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="method-initColumns"></span>[`initColumns()`](/docs/api/yii/grid/gridview/index.md#method-initColumns) protected | Creates column objects and initializes them. | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |

## Events

| Event | Type | Description | Defined by |
| --- | --- | --- | --- |
| <span id="event-EVENT_INIT"></span>[`EVENT_INIT`](/docs/api/yii/base/widget/index.md#event-EVENT_INIT) | [`yii\base\Event`](/docs/api/yii/base/event/index.md) | An event that is triggered when the widget is initialized via [`init()`](/docs/api/yii/base/widget/index.md#method-init). Event name: `'init'`. Available since 2.0.11. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="event-EVENT_BEFORE_RUN"></span>[`EVENT_BEFORE_RUN`](/docs/api/yii/base/widget/index.md#event-EVENT_BEFORE_RUN) | [`yii\base\WidgetEvent`](/docs/api/yii/base/widgetevent/index.md) | An event raised right before executing a widget. Event name: `'beforeRun'`. Available since 2.0.11. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |
| <span id="event-EVENT_AFTER_RUN"></span>[`EVENT_AFTER_RUN`](/docs/api/yii/base/widget/index.md#event-EVENT_AFTER_RUN) | [`yii\base\WidgetEvent`](/docs/api/yii/base/widgetevent/index.md) | An event raised right after executing a widget. Event name: `'afterRun'`. Available since 2.0.11. | [`yii\base\Widget`](/docs/api/yii/base/widget/index.md) |

## Constants

| Constant | Value | Description | Defined by |
| --- | --- | --- | --- |
| <span id="const-FILTER_POS_HEADER"></span>[`FILTER_POS_HEADER`](/docs/api/yii/grid/gridview/index.md#const-FILTER_POS_HEADER) | `'header'` |  | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="const-FILTER_POS_FOOTER"></span>[`FILTER_POS_FOOTER`](/docs/api/yii/grid/gridview/index.md#const-FILTER_POS_FOOTER) | `'footer'` |  | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |
| <span id="const-FILTER_POS_BODY"></span>[`FILTER_POS_BODY`](/docs/api/yii/grid/gridview/index.md#const-FILTER_POS_BODY) | `'body'` |  | [`yii\grid\GridView`](/docs/api/yii/grid/gridview/index.md) |

## Method details

### renderSummary() <span id="method-renderSummary"></span>

```php
public function renderSummary(): string
```

Renders the row-count sentence for the rows currently on screen.

Derives the counters the way [`BaseListView::renderSummary()`](/docs/api/yii/widgets/baselistview/index.md#method-renderSummary) does: the paginator's offset opens
the range and the number of rows rendered on the page closes it, while disabled pagination reports the whole set
as a single page. An empty page reports `0-0`, matching the shared renderer instead of collapsing to an empty
string.

**Returns**

`string`: Rendered row-count sentence.