Element.scrollBy()

The scrollBy() method of the Element interface scrolls an element by the given amount.

Syntax

element.scrollBy(x-coord, y-coord);
element.scrollBy(options)

Parameters

  • x-coord is the horizontal pixel value that you want to scroll by.
  • y-coord is the vertical pixel value that you want to scroll by.

- or -

options

A dictionary containing the following parameters:

top

Specifies the number of pixels along the Y axis to scroll the window or element.

left

Specifies the number of pixels along the X axis to scroll the window or element.

behavior

Specifies whether the scrolling should animate smoothly (smooth), happen instantly in a single jump (instant), or let the browser choose (auto, default).

Examples

// scroll an element
element.scrollBy(300, 300);

Using options:

element.scrollBy({
  top: 100,
  left: 100,
  behavior: 'smooth'
});

Specifications

Specification
CSSOM View Module (CSSOM View)
# dom-element-scrollby

Browser compatibility

BCD tables only load in the browser