---
title: "Scroll Depth"
slug: "integrated-scroll-depth"
updated: 2024-06-28T11:10:22Z
published: 2024-06-28T11:10:22Z
canonical: "docs.mapp.com/integrated-scroll-depth"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mapp.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Scroll Depth

The scroll depth extension is used to record how far users scroll down on a web page. This is a reference value that is of interest when you wish to find out more about user behavior. Learn more [here](/v1/docs/what-percentage-of-each-page-has-been-seen).

The predefined IDs are assigned to each parameters:

- Event parameter 501: Scroll Depth (Figure)
- Event parameter 502: Page Length
- Event parameter 540: Scroll Depth

## Methods and properties

### name

Get the name of the extension.

```javascript
/**
 * @type {string}
 */
wtSmart.extension.scroll_depth.name;
```

### version

Get the version of the extension.

```javascript
/**
 * @type {string}
 */
wtSmart.extension.scroll_depth.version;
```

### config

Set and get the current configuration of the extension.

- **roundResult**: By default the scroll depth in percent gets rounded up to full fives. Deactivate this option, to receive more detailed results.

```javascript
/**
 * @param {{
 *      [roundResult=true]: boolean
 * }} [config]
 *
 * @returns {object}
 */
wtSmart.extension.scroll_depth.config(config);
```

### isActivated

Get the status, if the extension is enabled.

```javascript
/**
 * @returns {boolean}
 */
wtSmart.extension.scroll_depth.isActivated();
```

### activate

Activate the extension.

```plaintext
wtSmart.extension.scroll_depth.activate();
```

### deactivate

Deactivate the extension.

```plaintext
wtSmart.extension.scroll_depth.deactivate();
```

### simulate

Simulate an internal *scroll* or *unload* event.

```javascript
/**
 * @param {string} eventName (scroll | unload)
 */
wtSmart.extension.scroll_depth.simulate(eventName);
```

### Example

```javascript
// is scroll depth activated
var isActivated = wtSmart.extension.scroll_depth.isActivated();

// set scroll depth config
wtSmart.extension.scroll_depth.config({
    roundResult: false
});

// get scroll depth config
var scrollDepthConfig = wtSmart.extension.scroll_depth.config();

// activate scroll depth
wtSmart.extension.scroll_depth.activate();

// deactivate scroll depth
wtSmart.extension.scroll_depth.deactivate();

// simulate an internal unload event
wtSmart.extension.scroll_depth.simulate('unload');
```

## Code Generator

Use the code generator to create individual code that you can then integrate directly into the website.

[Embedded content](https://static.webtrekk.com/pixel/wtsmart-gui/extension/scrollDepth/?nohelp=1)