Документация для разработчиков
Темная тема

Переопределение параметров запроса

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

Методика

Для того чтобы переопределить параметры нужно подписаться на событие Grid::beforeRequest. Затем, в обработчике события, отредактировать объект запроса. Важно в обработчике проверить gridId, чтобы быть уверенным, что все действия выполняются для нужного грида.

import {EventEmitter, BaseEvent} from 'main.core.events';
import {Type, Uri} from 'main.core';

EventEmitter.subscribe('Grid::beforeRequest', (event: BaseEvent) => {
	const [, requestOptions] = event.getData();
	if (requestOptions.gridId === 'MY_GRID_ID')
	{
		Uri.addParam(
			requestOptions.url,
			{
				myCustomParam1: 'value1',	
				myCustomParam2: 'value2',	
			},
		);
	}
});

Доступные параметры запроса

ПараметрТипОписание
urlstringСсылка (URL), по которой грид выполнит запрос.
methodstringУказывается HTTP-метод. По умолчанию равен GET.
dataobjectДанные, которые будут отправлены методом POST, если в параметре выше выбран соответствующий метод. Данные из data перед запросом будут сконвертированы в FormData.
cancelRequestbooleanПараметр позволяет отменить выполнение запроса.



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

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

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

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

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Наверх