---
title: PageModel
product: Form Library
api-type: class
description: The `PageModel` object describes a survey page and contains properties and methods that allow you to control the page and access its elements (panels and questions).
source: https://surveyjs.io/form-library/documentation/api-reference/pagemodel
---

# `PageModel`

The `PageModel` object describes a survey page and contains properties and methods that allow you to control the page and access its elements (panels and questions).

[View Demo](https://surveyjs.io/form-library/examples/nps-question/ (linkStyle))

## Inheritance

[`Base`](https://surveyjs.io/form-library/documentation/api-reference/base.md) → [`SurveyElementCore`](https://surveyjs.io/form-library/documentation/api-reference/surveyelementcore.md) → [`SurveyElement`](https://surveyjs.io/form-library/documentation/api-reference/surveyelement.md) → [`PanelModelBase`](https://surveyjs.io/form-library/documentation/api-reference/panelmodelbase.md) → [`PanelModel`](https://surveyjs.io/form-library/documentation/api-reference/panelmodel.md) → `PageModel`

## Properties

### `isActive`

**Type**: `boolean`

Returns `true` if this is the current page.

**Related APIs:** [`SurveyModel.currentPage`](#SurveyModel.currentPage)

### `isStartPage`

**Type**: `boolean`

Returns `true` if this page is a start page.

Refer to the following help topic for more information on how to configure a start page: [Start Page](https://surveyjs.io/form-library/documentation/design-survey-create-a-multi-page-survey#start-page).

### `navigationTitle`

**Type**: `string`

A caption displayed on a navigation button in the TOC or progress bar. Applies when [`showTOC`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#showTOC) is `true` or when the [progress bar is visible](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#showProgressBar), [`progressBarType`](https://surveyjs.io/form-library/documentation/surveymodel#progressBarType) is set to `"pages"`, and [`progressBarShowPageTitles`](https://surveyjs.io/form-library/documentation/surveymodel#progressBarShowPageTitles) is `true`.

[Table of Contents Demo](https://surveyjs.io/form-library/examples/table-of-contents/ (linkStyle))

[Progress Bar Demo](https://surveyjs.io/form-library/examples/configure-form-navigation-with-progress-indicators/ (linkStyle))

> If navigation titles are unspecified, the navigation buttons display page [titles](https://surveyjs.io/form-library/documentation/api-reference/page-model#title) or [names](https://surveyjs.io/form-library/documentation/pagemodel#name).

### `showNavigationButtons`

**Type**: `string | boolean`

Gets or sets the visibility of the Start, Next, Previous, and Complete navigation buttons on this page. Overrides the [`showNavigationButtons`](https://surveyjs.io/form-library/documentation/api-reference/survey-data-model#showNavigationButtons) property specified on the survey-level.

Default value: `undefined` (the visibility depends on the survey-level setting)

### `timeLimit`

**Type**: `number`

A time period that a respondent has to complete this page; measured in seconds. Applies only to [quiz surveys](https://surveyjs.io/form-library/documentation/design-survey-create-a-quiz).

Default value: 0 (time is unlimited)

Alternatively, you can use the `SurveyModel`'s [`timeLimitPerPage`](https://surveyjs.io/form-library/documentation/surveymodel#timeLimitPerPage) property to specify identical time periods for all survey pages.

**Related APIs:** [`timeSpent`](#timeSpent)

### `timeSpent`

**Type**: `number`

A time period that a respondent has spent on this page so far; measured in seconds. Applies only to [quiz surveys](https://surveyjs.io/form-library/documentation/design-survey-create-a-quiz).

**Related APIs:** [`timeLimit`](#timeLimit)

### `visibleIndex`

**Type**: `number`

The visible index of the page. It has values from 0 to visible page count - 1.

**Related APIs:** [`SurveyModel.visiblePages`](#SurveyModel.visiblePages), [`SurveyModel.pages`](#SurveyModel.pages)

### `wasShown`

**Type**: `boolean`

Returns `true` if the respondent has already seen this page during the current session.

## Methods

### `getAllPanels()`

**Return value:** `IPanel[]<IPanel>`

Returns a list of all panels on this page.

**Parameters:**

| Name | Type | Description |
| ---- | ---- | ----------- |
| `visibleOnly` | `boolean` | A Boolean value that specifies whether to include only visible panels. |
| `includingDesignTime` | `boolean` | For internal use. |

### `scrollToTop()`

Scrolls this page to the top.