| Property | Type | Description | |
|---|---|---|---|
| $afterSelectableCells | a javascript function that will be invoked after a selection is done.
The function signature is function(selected) where 'selected' refers to the selected columns. |
||
| $afterSortableUpdate | a javascript function that will be invoked after a successful sorting is done.
The function signature is function(id, position) where 'id' refers to the ID of the model id key,
'position' the new position in the list. |
||
| $bulkActionAlign | the aligment of the bulk actions. It can be 'left' or 'right'. | ||
| $bulkActions | the configuration options to display a TbBulkActions widget | ||
| $chartOptions | array | if configured, the extended view will display a highcharts chart. | |
| $componentsAfterAjaxUpdate | array | has scripts that will be executed after components have updated. It is used internally to render scripts required for components to work correctly. You may use it for your own scripts, just make sure it is of type array. | |
| $componentsReadyScripts | array | hold scripts that will be executed on document ready. It is used internally to render scripts required for components to work correctly. You may use it for your own scripts, just make sure it is of type array. | |
| $extendedSummary | array | displays an extended summary version.
There are different types of summary types,
please, see {@link TbSumOperation}, {@link TbSumOfTypeOperation},{@link TbPercentOfTypeGooglePieOperation}
{@link TbPercentOfTypeOperation} and {@link TbPercentOfTypeEasyPieOperation}.
The following is an example, please review the different types of TbOperation classes to find out more about
its configuration parameters.
'extendedSummary' => array(
'title' => '', // the extended summary title
'columns' => array( // the 'columns' that will be displayed at the extended summary
'id' => array( // column name "id"
'class' => 'TbSumOperation', // what is the type of TbOperation we are going to display
'label' => 'Sum of Ids' // label is name of label of the resulted value (ie Sum of Ids:)
),
'results' => array( // column name "results"
'class' => 'TbPercentOfTypeGooglePieOperation', // the type of TbOperation
'label' => 'How Many Of Each? ', // the label of the operation
'types' => array( // TbPercentOfTypeGooglePieOperation "types" attributes
'0' => array('label' => 'zeros'), // a value of "0" will be labelled "zeros"
'1' => array('label' => 'ones'), // a value of "1" will be labelled "ones"
'2' => array('label' => 'twos')) // a value of "2" will be labelled "twos"
)
)
),
|
|
| $extendedSummaryCssClass | string | is the class name of the layer containing the extended summary | |
| $extendedSummaryOptions | array | the HTML attributes of the layer containing the extended summary | |
| $fixedHeader | boolean | if set to true will keep the header fixed position | |
| $headerOffset | integer | ||
| $selectableCells | whether to allow selecting of cells | ||
| $selectableCellsFilter | the filter to use to allow selection. For example, if you set the "htmlOptions" property of a column to have a "class" of "tobeselected", you could set this property as: "td.tobeselected" in order to allow selection to those columns with that class only. | ||
| $sortableAction | Name of the action to call and sort values | ||
| $sortableAjaxSave | Save sort order by ajax defaults to false | ||
| $sortableAttribute | Database field name for row sorting | ||
| $sortableRows | boolean | ||
| $template | the template to be used to control the layout of various sections in the view. These tokens are recognized: {extendedSummary}, {summary}, {items} and {pager}. They will be replaced with the extended summary, summary text, the items, and the pager. |
| Property | Type | Description | |
|---|---|---|---|
| $bulk | component that will display the bulk actions to the grid | ||
| $displayChart | boolean | a helper property that is set to true if we have to render a chart. | |
| $displayExtendedSummary | boolean | a helper property that is set to true if we have to render the extended summary | |
| $extendedSummaryOperations | array | hold the supported operation types | |
| $extendedSummaryTypes | TbOperation[] | hold the current configured TbOperation that will process column values. |
| Method | Description | |
|---|---|---|
| init ( ) | ### .init() | |
| registerCustomClientScript ( ) | ### .registerCustomClientScript() | |
| renderBulkActions ( ) | ### .renderBulkActions() | |
| renderChart ( ) | ### .renderChart() | |
| renderContent ( ) | ### .renderContent() | |
| renderExtendedSummary ( ) | ### .renderExtendedSummary() | |
| renderExtendedSummaryContent ( ) | ### .renderExtendedSummaryContent() | |
| renderKeys ( ) | ### .renderKeys() | |
| renderTableFooter ( ) | ### .renderTableFooter() | |
| renderTableHeader ( ) | ### .renderTableHeader() | |
| renderTableRow ( integer $row ) | ### .renderTableRow() |
| Method | Description | |
|---|---|---|
| getAttribute ( CActiveRecord $data, string $attribute ) : mixed | ### .getAttribute() | |
| getColumnByName ( string $name ) : CDataColumn | null | ### .getColumnByName() | |
| getPrimaryKey ( CActiveRecord $data ) : null | string | ### .getPrimaryKey() | |
| getSummaryOperationInstance ( string $name, array $config ) : mixed | ### .getSummaryOperationInstance() | |
| parseColumnValue ( CDataColumn $column, integer $row ) : string | ### .parseColumnValue() |
| protected getAttribute ( CActiveRecord $data, string $attribute ) : mixed | ||
| $data | CActiveRecord | |
| $attribute | string | the attribute to get |
| return | mixed | the attribute value null if none found |
| protected getColumnByName ( string $name ) : CDataColumn | null | ||
| $name | string | |
| return | CDataColumn | null | |
| protected getPrimaryKey ( CActiveRecord $data ) : null | string | ||
| $data | CActiveRecord | |
| return | null | string | |
| protected parseColumnValue ( CDataColumn $column, integer $row ) : string | ||
| $column | CDataColumn | |
| $row | integer | the current row number |
| return | string | |
| public registerCustomClientScript ( ) |
| public renderExtendedSummaryContent ( ) |
| public renderKeys ( ) |
| public renderTableRow ( integer $row ) | ||
| $row | integer | the row number (zero-based). |
function(selected) where 'selected' refers to the selected columns. | public $afterSelectableCells |
function(id, position) where 'id' refers to the ID of the model id key,
'position' the new position in the list. | public $afterSortableUpdate |
| protected $bulk |
| public $bulkActionAlign |
| public $bulkActions |
| public array $chartOptions | ||
| return | array | |
| public array $componentsAfterAjaxUpdate | ||
| return | array | |
| public array $componentsReadyScripts | ||
| return | array | |
| protected bool $displayChart | ||
| return | boolean | |
| protected bool $displayExtendedSummary | ||
| return | boolean | |
'extendedSummary' => array(
'title' => '', // the extended summary title
'columns' => array( // the 'columns' that will be displayed at the extended summary
'id' => array( // column name "id"
'class' => 'TbSumOperation', // what is the type of TbOperation we are going to display
'label' => 'Sum of Ids' // label is name of label of the resulted value (ie Sum of Ids:)
),
'results' => array( // column name "results"
'class' => 'TbPercentOfTypeGooglePieOperation', // the type of TbOperation
'label' => 'How Many Of Each? ', // the label of the operation
'types' => array( // TbPercentOfTypeGooglePieOperation "types" attributes
'0' => array('label' => 'zeros'), // a value of "0" will be labelled "zeros"
'1' => array('label' => 'ones'), // a value of "1" will be labelled "ones"
'2' => array('label' => 'twos')) // a value of "2" will be labelled "twos"
)
)
),
| public array $extendedSummary | ||
| return | array | |
| public string $extendedSummaryCssClass | ||
| return | string | |
| protected array $extendedSummaryOperations | ||
| return | array | |
| public array $extendedSummaryOptions | ||
| return | array | |
| protected TbOperation[] $extendedSummaryTypes | ||
| return | TbOperation[] | |
| public bool $fixedHeader | ||
| return | boolean | |
| public $selectableCellsFilter |
| public $sortableAction |
| public $sortableAjaxSave |