Method | Description | |
---|---|---|
addColumn ( array $columnProperties ) | Add a column at the last position in the columns model. | |
addExport ( array $exportProperties ) | Add a export-type at the last position in exportButtonsOptions . | |
addGroupHeader ( array $properties = [] ) | Add a group header. This are columns that can be added above the normal grid columns. | |
addXDimension ( array $properties = [] ) | Add a X dimension. Use this method only when working with pivot grids. | |
addYDimension ( array $properties = [] ) | Add a Y dimension. Use this method only when working with pivot grids. | |
enableFilterToolbar ( boolean $createToggleButton = null, boolean $createClearButton = null ) | Enable filter toolbar. | |
hideCsvExporter ( ) | Hide CSV Navigator button. | |
hideXlsExporter ( ) | Hide XLS Navigator button. | |
renderGrid ( boolean $script = true, boolean $createTableElement = true, boolean $createPagerElement = true, boolean $echo = true ) : mixed | Main method that construct the html and javascript code of the grid. | |
setFileProperty ( string $option, $value ) | Set a Laravel Excel file property. | |
setFilterToolbarEvent ( string $event, string $code ) | Set a toolbar event. | |
setFilterToolbarOptions ( array $options ) | Set options for the toolbar filter when enabled. Online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:toolbar_searching | |
setGridAsPivot ( ) | When this method is called the grid will be treated as Pivot Grid (differents javascript methods are used to generate the grid) according to the official documentation. Online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:pivotdescription. | |
setGridEvent ( string $event, array $code ) | Set a jqGrid event. | |
setGridId ( string $id ) | Set an identifier to the grid. | |
setGridOption ( string $option, $value ) | Set a jqGrid option. | |
setNavigatorEvent ( string $module, string $event, string $code ) | Set an event in the navigator or in the diffrent modules add,edit,del,view, search. Online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:navigator | |
setNavigatorOptions ( string $module, array $options ) | Set options in the navigator or in any of the following modules add,edit,del,view, search. Online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:navigator | |
setSheetProperty ( string $option, $value ) | Set a Laravel Excel sheet property. |
public addGroupHeader ( array $properties = [] ) | ||
$properties | array | An array of valid group header options. Online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:groupingheadar |
public addXDimension ( array $properties = [] ) | ||
$properties | array | An array of valid xDimension options. Online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:pivotsettings |
public addYDimension ( array $properties = [] ) | ||
$properties | array | An array of valid yDimension options. Online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:pivotsettings |
public enableFilterToolbar ( boolean $createToggleButton = null, boolean $createClearButton = null ) | ||
$createToggleButton | boolean | If true a toggle button will be created in the navigator. Default is null |
$createClearButton | boolean | If true a clear button will be created in the navigator. Default is null |
public renderGrid ( boolean $script = true, boolean $createTableElement = true, boolean $createPagerElement = true, boolean $echo = true ) : mixed | ||
$script | boolean | If true a script tag before constructin the grid. Default is true |
$createTableElement | boolean | If true the table element is created automatically from this method. Default is true |
$createPagerElement | boolean | If true the pager element is created automatically from this method. Default is true |
$echo | boolean | If false the function return the string representing the grid. Default is true |
return | mixed | String if $echo is set to false, void in any other case |
public setFileProperty ( string $option, $value ) | ||
$option | string | A valid Laravel Excel file property, online documentation available at http://www.maatwebsite.nl/laravel-excel/docs/reference-guide |
public setFilterToolbarEvent ( string $event, string $code ) | ||
$event | string | Valid toolbar grid event, online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:toolbar_searching |
$code | string | Javascript code which will be executed when the event raises |
public setFilterToolbarOptions ( array $options ) | ||
$options | array | Options that are applicable to the filter toolbar |
public setGridAsPivot ( ) |
public setGridEvent ( string $event, array $code ) | ||
$event | string | Valid grid event, online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:events&s[]=event |
$code | array | Javascript code which will be executed when the event raises |
public setGridOption ( string $option, $value ) | ||
$option | string | A valid jqGrid option, online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:options or a valid pivot grid option, online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:pivotsettings a valid group header option, online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:groupingheadar |
public setSheetProperty ( string $option, $value ) | ||
$option | string | A valid Laravel Excel sheet property, online documentation available at http://www.maatwebsite.nl/laravel-excel/docs/reference-guide |