Задать закрепленные колонки Options::setStickedColumns

Модуль: main — подключать отдельно не нужно

Метод Options::setStickedColumns задает закрепленные колонки — колонки, которые остаются на месте при горизонтальной прокрутке грида. Чтобы сохранить значение, вызовите save.

Сигнатура метода в классе Bitrix\Main\Grid\Options:

public function setStickedColumns($columns = [])

Параметры

Параметр Тип Описание
columns array Задает идентификаторы колонок. Если значение не массив, метод записывает пустой массив. По умолчанию — пустой массив

Тип в таблице описывает назначение аргумента. Сигнатура PHP не объявляет его.

Возвращаемое значение

Метод ничего не возвращает.

Особенности

Метод записывает колонки в представление default, а getStickedColumns читает текущее представление. Если текущее представление другое, getStickedColumns не вернет записанные колонки.

Примеры

Пример. Код закрепляет колонку ID и читает закрепленные колонки:

<?php
use Bitrix\Main\Grid\Options;

require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';

$options = new Options('units_grid');
$options->setStickedColumns(['ID']);

echo implode(',', $options->getStickedColumns() ?? []);

Если текущее представление — default, код выведет ID.

Смотрите также