Options extends CGridOptions
Class Options of main.ui.grid
Table of Contents
Methods
- __construct() : mixed
- Options constructor.
- deleteView() : mixed
- Deletes view settings by view id
- getCollapsedGroups() : array<string|int, mixed>|null
- Gets ids of collapsed groups
- getCurrentOptions() : array<string|int, mixed>
- getExpandedRows() : array<string|int, mixed>|null
- Gets ids of expanded rows
- getId() : string
- Gets grid id
- getSorting() : array<string|int, mixed>
- Gets current grid sorting
- getStickedColumns() : array<string|int, string>|null
- Gets sticked columns
- getUsedColumns() : array<string|int, mixed>
- Gets used columns
- resetExpandedRows() : mixed
- Resets saved expanded ids of rows
- resetView() : mixed
- Resets view settings by view id
- save() : mixed
- Saves all options
- setCollapsedGroups() : mixed
- Sets collapsed groups
- setColumnsSizes() : mixed
- Sets width of grid columns
- setCustomNames() : mixed
- Sets custom names of grid columns
- setExpandedRows() : mixed
- Sets ids of expanded rows
- setPageSize() : mixed
- Sets page size
- setStickedColumns() : mixed
- Sets sticked columns
Methods
__construct()
Options constructor.
public
__construct(mixed $gridId[, array<string|int, mixed> $filterPresets = array() ]) : mixed
Parameters
- $gridId : mixed
-
$arParams["GRID_ID"]
- $filterPresets : array<string|int, mixed> = array()
deleteView()
Deletes view settings by view id
public
deleteView(string $viewId) : mixed
Parameters
- $viewId : string
getCollapsedGroups()
Gets ids of collapsed groups
public
getCollapsedGroups() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullgetCurrentOptions()
public
getCurrentOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>getExpandedRows()
Gets ids of expanded rows
public
getExpandedRows() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullgetId()
Gets grid id
public
getId() : string
Return values
string —$arParams["GRID_ID"]
getSorting()
Gets current grid sorting
public
getSorting([array<string|int, mixed> $default = array() ]) : array<string|int, mixed>
Parameters
- $default : array<string|int, mixed> = array()
-
- Default value
Return values
array<string|int, mixed>getStickedColumns()
Gets sticked columns
public
getStickedColumns() : array<string|int, string>|null
Return values
array<string|int, string>|nullgetUsedColumns()
Gets used columns
public
getUsedColumns([array<string|int, mixed> $defaultColumns = array() ]) : array<string|int, mixed>
Parameters
- $defaultColumns : array<string|int, mixed> = array()
Return values
array<string|int, mixed>resetExpandedRows()
Resets saved expanded ids of rows
public
resetExpandedRows() : mixed
resetView()
Resets view settings by view id
public
resetView(string $viewId) : mixed
Parameters
- $viewId : string
save()
Saves all options
public
save() : mixed
setCollapsedGroups()
Sets collapsed groups
public
setCollapsedGroups([array<string|int, mixed> $ids = array() ]) : mixed
Parameters
- $ids : array<string|int, mixed> = array()
setColumnsSizes()
Sets width of grid columns
public
setColumnsSizes(number|null $expand, array<string|int, mixed> $sizes) : mixed
Parameters
- $expand : number|null
- $sizes : array<string|int, mixed>
setCustomNames()
Sets custom names of grid columns
public
setCustomNames(array<string|int, mixed> $names) : mixed
Parameters
- $names : array<string|int, mixed>
setExpandedRows()
Sets ids of expanded rows
public
setExpandedRows([array<string|int, mixed> $ids = array() ]) : mixed
Parameters
- $ids : array<string|int, mixed> = array()
setPageSize()
Sets page size
public
setPageSize(int $size) : mixed
Parameters
- $size : int
setStickedColumns()
Sets sticked columns
public
setStickedColumns([array<string|int, string> $columns = [] ]) : mixed
Parameters
- $columns : array<string|int, string> = []