Прокрутить родительское окно BX24.scrollParentWindow

BX24.scrollParentWindow(scroll: integer | string, callback?: callable): void;

Метод BX24.scrollParentWindow прокручивает родительское окно — страницу Битрикс24, внутри которой находится фрейм приложения, — до указанной позиции по вертикали. Например, если фрейм приложения выше экрана, кнопка «Наверх» внизу приложения может вернуть пользователя к началу страницы.

Начиная с версии модуля rest 25.800.0 метод можно использовать в местах встраивания приложения. Прокрутка работает, если приложение открыто не в слайдере, например на своей странице в Битрикс24. В окне, которое открыл BX24.openApplication, страница не прокручивается.

Метод работает только внутри фрейма приложения в Битрикс24. Вызывайте его после инициализации библиотеки в обработчике BX24.init. Собственный scope методу не нужен: он управляет интерфейсом, а не обращается к REST API.

Параметры методаПараметры метода

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

Пример кодаПример кода

Как использовать примеры в документации

Прокрутить страницу Битрикс24 к началу по кнопке:

<button id="scroll-top">Наверх</button>

<script>
    BX24.init(function () {
        document.getElementById('scroll-top').addEventListener('click', function () {
            BX24.scrollParentWindow(0, function (result) {
                console.log('Позиция:', result.scroll);
            });
        });
    });
</script>

Обработка ответаОбработка ответа

Метод не возвращает данные (void). Когда Битрикс24 обработает команду, он вызовет callback и передаст объект с позицией, которую вы указали:

{
    "scroll": 0
}

Возвращаемые данныеВозвращаемые данные

Обработка ошибокОбработка ошибок

Кодов ошибок метод не возвращает.

Продолжите изучениеПродолжите изучение

• Интерфейс, навигация и контекст: обзор методов
• Перезагрузить страницу BX24.reloadWindow
• Установить заголовок страницы BX24.setTitle