Документация для разработчиков
Документация для разработчиков Документация по D7 Документация по REST Пользовательская документация
Темная тема

Параметры компонента

Ниже перечислены все параметры компонента грида (main.ui.grid).

Обязательные параметры

ПараметрТипОписание
GRID_IDstringИдентификатор грида, уникальный для каждого грида в рамках одной страницы.
COLUMNSarrayНабор колонок грида.
ROWSarrayСтроки грида.
AJAX_MODEstringВ значении обязательно должно быть указано Y.
AJAX_OPTION_JUMPstringВ значении обязательно должно быть указано N.
AJAX_OPTION_HISTORYstringВ значении обязательно должно быть указано N.

Дополнительные параметры

ПараметрТипОписание
NAV_STRINGstringПостраничная навигация в виде HTML строки.
NAV_OBJECT\Bitrix\Main\UI\PageNavigation / CDBResultОбъект постраничной навигации или объект CDBResult.
~NAV_PARAMSarrayПараметры компонента постраничной навигации (main.pagenavigation). Используется совместно с параметром NAV_OBJECT.
NAV_PARAM_NAMEstringИмя параметра в котором передается номер страницы.
CURRENT_PAGEintНомер текущей страницы. Нужен для корректной работы кнопки "Загрузить еще".
ENABLE_NEXT_PAGEbooleanОпределяет, доступна ли следующая страница. Параметр нужен для корректной работы кнопки "Загрузить еще".
ENABLE_COLLAPSIBLE_ROWSbooleanВключает группировку строк с разворачиванием.
TOTAL_ROWS_COUNTintКоличество строк на всех страницах.
TOTAL_ROWS_COUNT_HTMLstringПозволяет вывести собственный счетчик общего количества строк. Например, как в CRM, где общее количество строк выводится отложено, по клику на ссылку.
PAGE_SIZESarrayМассив элементов для выпадающего списка выбора размера страницы. 
'PAGE_SIZES' => [
	[
		'NAME' => 20,
		'VALUE' => 20,
	],
	[
		'NAME' => 40,
		'VALUE' => 40,
	],
	...,
],
SETTINGS_WINDOW_TITLEstringЗаголовок попапа настройки грида.
COLUMNS_ALL_WITH_SECTIONSarrayСписок колонок с разделами, для попапа настройки грида.
HEADERS_SECTIONSarrayРазделы колонок для попапа настроек грида.
ENABLE_FIELDS_SEARCHstringВключает возможность поиска колонок в настройках грида.
TOP_ACTION_PANEL_RENDER_TOstringОпределяет куда выводить BX.UI.ActionPanel. В качестве значения принимает имя функции которая возвращает ссылку на DOM-элемент.
TOP_ACTION_PANEL_PINNED_MODEstringОпределяет значение параметра pinnedMode, для BX.UI.ActionPanel.
TOP_ACTION_PANEL_CLASSstringОпределяет CSS-класс для BX.UI.ActionPanel.
ACTION_PANELarrayНабор действий/элементов для панели групповых действий, либо для BX.UI.ActionPanel.
ACTION_PANEL_OPTIONSarrayДополнительные параметры для BX.UI.ActionPanel. Пока доступен только параметр MAX_HEIGHT.
DEFAULT_PAGE_SIZEintРазмер страницы по умолчанию.
STUBstring / arrayЗаглушка пустого грида. Может принимать HTML-строку, либо массив. 
'STUB' => [
	'title' => string,
	'description' => string,
],
LAZY_LOADarrayВключает режим отложенной загрузки списка колонок. 
'LAZY_LOAD' => [
	'CONTROLLER' => 'my.controller.name',
],
SHOW_CHECK_ALL_CHECKBOXESbooleanРазрешает отображение чекбоксов "Выбрать все".
SHOW_ROW_CHECKBOXESbooleanРазрешает отображение чекбоксов для строк.
SHOW_ROW_ACTIONS_MENUbooleanРазрешает отображение меню действий строки.
SHOW_GRID_SETTINGS_MENUbooleanРазрешает отображение меню настройки грида (кнопка с шестеренкой).
SHOW_MORE_BUTTONbooleanРазрешает отображение кнопки "Загрузить еще".
SHOW_NAVIGATION_PANELbooleanРазрешает отображение кнопки панели навигации. (Постраничка, размер страницы и т. д.)
SHOW_PAGINATIONbooleanРазрешает отображение постраничной навигации.
SHOW_SELECTED_COUNTERbooleanРазрешает отображение счетчика выделенных строк.
SHOW_TOTAL_COUNTERbooleanРазрешает отображение счетчика общего количества строк на всех страницах.
SHOW_PAGESIZEbooleanРазрешает отображение выпадающего списка с выбором размера страницы.
SHOW_ACTION_PANELbooleanРазрешает отображение панели групповых действий.
SHOW_GROUP_EDIT_BUTTONbooleanРазрешает вывод стандартной кнопки "Редактировать" в панель групповых действий.
SHOW_GROUP_DELETE_BUTTONbooleanРазрешает вывод стандартной кнопки "Удалить" в панель групповых действий.
SHOW_SELECT_ALL_RECORDS_CHECKBOXbooleanВыводит или скрывает чекбокс выбора всех строк, на всех страницах. По умолчанию чекбокс скрыт.
ALLOW_COLUMNS_SORTbooleanРазрешает сортировку колонок перетаскиванием.
ALLOW_ROWS_SORTbooleanРазрешает сортировку строк перетаскиванием.
ALLOW_ROWS_SORT_IN_EDIT_MODEbooleanРазрешает сортировку строк перетаскиванием в режиме инлайн-редактирования.
ALLOW_EDIT_SELECTIONbooleanРазрешает выделение строк в режиме инлайн-редактирования.
ALLOW_ROWS_SORT_INSTANT_SAVEbooleanРазрешает сохранение сортировки строк сразу, по окончании перетаскивания.
ALLOW_STICKED_COLUMNSbooleanРазрешает закрепление колонок с параметром sticked при горизонтальной прокрутке.
ALLOW_COLUMNS_RESIZEbooleanРазрешает изменение размера колонок.
ALLOW_HORIZONTAL_SCROLLbooleanРазрешает горизонтальную прокрутку, если грид не помещается по ширине.
ALLOW_SORTbooleanРазрешает сортировку по клику на заголовок колонки.
ALLOW_PIN_HEADERbooleanРазрешает закрепление шапки грида к верху окна браузера при прокрутке.
ALLOW_INLINE_EDITbooleanРазрешает инлайн-редактирование строк.
ALLOW_CONTEXT_MENUbooleanРазрешает вывод контекстного меню по клику правой кнопкой на строку.
HANDLE_RESPONSE_ERRORSbooleanВключает режим дополнительной обработки ответа. В этом режиме грид проверяет, что если в ответе бэкенда будет массив messages, то грид выведет эти сообщения в попапе.

Обратите внимание, что несмотря на то, что параметр называется HANDLE_RESPONSE_ERRORS, сообщения могут быть не только об ошибках, но и например об успешном сохранении и т. д.

'messages' => [
	[
		'TITLE' => string,
		'TEXT' => string,
		'TYPE' => 'error' | 'warning' | 'info' | 'success',
	],
	...,
],
ALLOW_VALIDATEbooleanВключает режим валидации сохраняемых значений при инлайн-редактировании. В этом режиме грид, перед тем как отправить запрос на сохранение, отправляет дополнительный запрос validate. Если в ответе нет массива messages или он пустой, то грид выполняет следующий запрос на сохранение. В противном случае грид выведет попап с сообщениями из messages.
TILE_GRID_MODEbooleanВключает режим отображения грида в виде сетки.
JS_CLASS_TILE_GRID_ITEMbooleanПозволяет переопределить JS-класс для элемента.
ROW_LAYOUTarrayДекларативный шаблон строки. Позволяет выводить в грид строки со сложной разметкой, с rowspan и colspan. 
$rowLayout = [
	[
		['column' => 'col_0', 'rowspan' => 2],
		['column' => 'col_1'],
		['column' => 'col_2'],
		['column' => 'col_3']
	],
	[
		['data' => 'data_field_5', 'colspan' => 3],
	],
];

Такой шаблон будет эквивалентен HTML-разметке.

<tr>
	<td rowspan="2"></td>
	<td></td>
	<td></td>
	<td></td>
</tr>
<tr>
	<td colspan="3"></td>
</tr>



Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
0
Евгений Кулик 07.12.2023 15:23:06
Сообщение не промодерировано, возможны ошибки и неточности.
Цитата
пишет:
Для того чтобы заработала групировка строк с разворачиванием:

- Необходимо указать в параметрах  ENABLE_COLLAPSIBLE_ROWS
- Дополнительно необходимо указать в  ROWS  параметры,  parent_id ,  hasChild

Также необходимо проверять перед добавлением строчки в массив  ROWS , в каком состоянии находится ее родитель,
открыт или закрыт, иначе битрикс будет задваивать вложенные элементы

[CODE]   $this ->gridOptions =  new   \Bitrix\Main\Grid\Options ( $this ->arParams[ "GRID_ID" ]);
$this ->gridOptions-> getExpandedRows ()  Копировать  [/CODE]  
забыл добавить, что необходимо еще указать параметр 'shift' => true для колонки, около которой надо отобразить кнопку раскрытия строки
0
Андрей Чурсин 05.09.2023 11:27:52
Сообщение не промодерировано, возможны ошибки и неточности.
Классно!
Но с какой радости все компоненты системы имеют параметры типа STRING, а тут внезапно BOOLEAN ?

Значит если в шаблоне компонента я подключаю грид тогда следует у всех параметров (но не всех а только некоторых) проставить
Код
...
"SHOW_ROW_CHECKBOXES"       => $arParams['SHOW_ROW_CHECKBOXES'] == 'Y',
...
удобно, спасибо .
2
Евгений Кулик 03.08.2023 13:07:44
Сообщение не промодерировано, возможны ошибки и неточности.
Для того чтобы заработала групировка строк с разворачиванием:

- Необходимо указать в параметрах ENABLE_COLLAPSIBLE_ROWS
- Дополнительно необходимо указать в ROWS параметры, parent_id, hasChild

Также необходимо проверять перед добавлением строчки в массив ROWS, в каком состоянии находится ее родитель,
открыт или закрыт, иначе битрикс будет задваивать вложенные элементы

Код
$this->gridOptions = new \Bitrix\Main\Grid\Options($this->arParams["GRID_ID"]);
$this->gridOptions->getExpandedRows()
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Наверх