Свойство | Тип | Описание | |
---|---|---|---|
$clearButton | boolean | Clear button | |
$clearButtonText | boolean | Clear button Text | |
$colModel | array | Columns model array | |
$colModelValidators | array | PropertyValidatorInterface array | |
$defaultColModelProperties | array | Default column model properties array | |
$defaultExportButtonsOptions | array | Default Export Buttons Options | |
$defaultFileProperties | array | Laravel Excel Default File Properties | |
$defaultFilterToolbarButtonsOptions | array | Default filter toolbar button options | |
$defaultGridOptions | array | Default grid options array | |
$defaultGroupHeaderOptions | array | Default group header options array | |
$defaultNavigatorOptions | array | Default navigator options | |
$defaultPivotGridOptions | array | Default pivot grid options array | |
$defaultSheetProperties | array | Laravel Excel Default Sheet Properties | |
$defaultfilterToolbarOptions | array | Default filter toolbar options | |
$exportButtonsOptions | array | Filter toolbar button options array | |
$exportButtonsVisible | boolean | Check on exist visible export button(s) | |
$fileProperties | array | Laravel Excel File Properties | |
$filterToolbar | boolean | Filter toolbar | |
$filterToolbarButtonsOptions | array | Filter toolbar button options array | |
$filterToolbarOptions | array | Filter toolbar options array | |
$filterToolbarValidators | array | PropertyValidatorInterface array | |
$frozenColumn | boolean | Frozen columns | |
$functionTypeProperties | array | Array of JqGrid function type properties | |
$gridId | string | Grid ID | |
$groupHeaderOptions | array | Group Header options array | |
$groupHeaderOptionsNames | array | Group header options names array | |
$jqPivot | boolean | Pivot Grid | |
$navigatorAddOptions | array | Navigator add options array | |
$navigatorDeleteOptions | array | Navigator delete options array | |
$navigatorEditOptions | array | Navigator edit options array | |
$navigatorOptions | array | Navigator options array | |
$navigatorSearchOptions | array | Navigator search options array | |
$navigatorValidators | array | PropertyValidatorInterface array | |
$navigatorViewOptions | array | Navigator view options array | |
$optionValidators | array | PropertyValidatorInterface array | |
$options | array | Options array | |
$pivotOptions | array | Options array | |
$pivotOptionsNames | array | Pivot options names array | |
$sheetProperties | array | Laravel Excel Sheet Properties | |
$toggleButton | boolean | Toggle button | |
$toggleButtonText | boolean | Toggle button Text | |
$token | string | Session token |
Метод | Описание | |
---|---|---|
__construct ( array $optionValidators = [], array $colModelValidators = [], array $navigatorValidators = [], array $filterToolbarValidators = [], array $defaultGridOptions = [], array $defaultPivotGridOptions = [], array $defaultGroupHeaderOptions = [], array $defaultColModelProperties = [], array $defaultNavigatorOptions = [], array $defaultfilterToolbarOptions = [], array $defaultFilterToolbarButtonsOptions = [], array $defaultExportButtonsOptions = [], array $defaultFileProperties = [], array $defaultSheetProperties = [], array $functionTypeProperties = [], array $pivotOptionsNames = [], array $groupHeaderOptionsNames = [], $token ) | Create a new JqGridRender instance. | |
addAggregate ( array $properties = [] ) | Add an aggregate. Use this method only when working with pivot grids. | |
addColumn ( array $properties = [] ) | Add a column at the last position in the columns model. | |
addExport ( array $properties = [] ) | ||
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, string $code ) | Set a jqGrid event. | |
setGridId ( string $id = null ) | Add a column at the last position in the columns model. | |
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. |
Метод | Описание | |
---|---|---|
getJavascriptExportFunctionCode ( string $exportFormat ) : void | Get exporter's javascript code. | |
markFunctionTypeProperty ( array &$properties ) : void | Mark function type properties. | |
reset ( ) : void | Reset variables to their original state. |
public __construct ( array $optionValidators = [], array $colModelValidators = [], array $navigatorValidators = [], array $filterToolbarValidators = [], array $defaultGridOptions = [], array $defaultPivotGridOptions = [], array $defaultGroupHeaderOptions = [], array $defaultColModelProperties = [], array $defaultNavigatorOptions = [], array $defaultfilterToolbarOptions = [], array $defaultFilterToolbarButtonsOptions = [], array $defaultExportButtonsOptions = [], array $defaultFileProperties = [], array $defaultSheetProperties = [], array $functionTypeProperties = [], array $pivotOptionsNames = [], array $groupHeaderOptionsNames = [], $token ) | ||
$optionValidators | array | |
$colModelValidators | array | |
$navigatorValidators | array | |
$filterToolbarValidators | array | |
$defaultGridOptions | array | |
$defaultPivotGridOptions | array | |
$defaultGroupHeaderOptions | array | |
$defaultColModelProperties | array | |
$defaultNavigatorOptions | array | |
$defaultfilterToolbarOptions | array | |
$defaultFilterToolbarButtonsOptions | array | |
$defaultExportButtonsOptions | array | |
$defaultFileProperties | array | |
$defaultSheetProperties | array | |
$functionTypeProperties | array | |
$pivotOptionsNames | array | |
$groupHeaderOptionsNames | array |
public addAggregate ( array $properties = [] ) | ||
$properties | array | An array of valid aggregate options (all jqGrid column model property can be used). Online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:pivotsettings |
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 |
protected getJavascriptExportFunctionCode ( string $exportFormat ) : void | ||
$exportFormat | string | |
Результат | void |
protected markFunctionTypeProperty ( array &$properties ) : void | ||
$properties | array | An array of valid jqGrid column model property, the key of the array must correspond to a column model property. |
Результат | void |
public renderGrid ( boolean $script = true, boolean $createTableElement = true, boolean $createPagerElement = true, boolean $echo = true ) : mixed | ||
$script | boolean | If true javascript tags will be included within the output. 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 |
Результат | 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, string $code ) | ||
$event | string | Valid grid event, online documentation available at http://www.trirand.com/jqgridwiki/doku.php?id=wiki:events&s[]=event |
$code | string | 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 |
protected bool $clearButtonText | ||
Результат | boolean |
protected array $colModelValidators | ||
Результат | array |
protected array $defaultColModelProperties | ||
Результат | array |
protected array $defaultExportButtonsOptions | ||
Результат | array |
protected array $defaultFileProperties | ||
Результат | array |
protected array $defaultFilterToolbarButtonsOptions | ||
Результат | array |
protected array $defaultGridOptions | ||
Результат | array |
protected array $defaultGroupHeaderOptions | ||
Результат | array |
protected array $defaultPivotGridOptions | ||
Результат | array |
protected array $defaultSheetProperties | ||
Результат | array |
protected array $defaultfilterToolbarOptions | ||
Результат | array |
protected array $exportButtonsOptions | ||
Результат | array |
protected bool $exportButtonsVisible | ||
Результат | boolean |
protected array $fileProperties | ||
Результат | array |
protected array $filterToolbarButtonsOptions | ||
Результат | array |
protected array $filterToolbarOptions | ||
Результат | array |
protected array $filterToolbarValidators | ||
Результат | array |
protected array $functionTypeProperties | ||
Результат | array |
protected array $groupHeaderOptions | ||
Результат | array |
protected array $groupHeaderOptionsNames | ||
Результат | array |
protected array $optionValidators | ||
Результат | array |
protected array $pivotOptionsNames | ||
Результат | array |
protected array $sheetProperties | ||
Результат | array |
protected bool $toggleButtonText | ||
Результат | boolean |