Scroll Parent Window BX24.scrollParentWindow

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

The method BX24.scrollParentWindow sends a command to scroll the parent window to a specified vertical position. Starting from version 25.800.0 of the rest module, this method can be used in embedding locations of the application. The scroll will work if the application is not opened in a slider.

void BX24.scrollParentWindow(Integer scroll[, Function callback])
        

Parameters

Required parameters are marked with *

Name
type

Description

scroll*
integer

The vertical position to scroll the parent window. Inside the method, the value is converted using parseInt, and the command is sent only if the result is not NaN

callback
function

The callback function that is executed after the scroll command is sent

Code Example

How to Use Examples in Documentation

BX24.init(function () {
            BX24.scrollParentWindow(0, function () {
                console.log('Scroll command sent');
            });
        });
        

Response Handling

The method does not return any data (void).

Continue Learning