# ReportViewer.HistoryApi

## Content

# Interface: HistoryApi

[ReportViewer](../modules/ReportViewer).HistoryApi

Defines the contract for viewer history navigation.

**`example`**
```ts
const history = {} as HistoryApi;
history.movePrev();
```

## Table of contents

### Methods

- [canMoveNext](ReportViewer.HistoryApi#canmovenext)
- [canMovePrev](ReportViewer.HistoryApi#canmoveprev)
- [clear](ReportViewer.HistoryApi#clear)
- [moveNext](ReportViewer.HistoryApi#movenext)
- [movePrev](ReportViewer.HistoryApi#moveprev)

## Methods

### <a id="canmovenext" name="canmovenext"></a> canMoveNext

▸ **canMoveNext**(): `boolean`

Gets a value indicating whether a forward navigation is available.

**`example`**
```ts
const history = {} as HistoryApi;
const canMove = history.canMoveNext();
```

#### Returns

`boolean`

`true` if forward navigation is available; otherwise, `false`.

___

### <a id="canmoveprev" name="canmoveprev"></a> canMovePrev

▸ **canMovePrev**(): `boolean`

Gets a value indicating whether a backward navigation is available.

**`example`**
```ts
const history = {} as HistoryApi;
const canMove = history.canMovePrev();
```

#### Returns

`boolean`

`true` if backward navigation is available; otherwise, `false`.

___

### <a id="clear" name="clear"></a> clear

▸ **clear**(): `void`

Clears all history entries.

**`example`**
```ts
const history = {} as HistoryApi;
history.clear();
```

#### Returns

`void`

___

### <a id="movenext" name="movenext"></a> moveNext

▸ **moveNext**(): `void`

Navigates to the next entry in the browsing history.

**`example`**
```ts
const history = {} as HistoryApi;
history.moveNext();
```

#### Returns

`void`

___

### <a id="moveprev" name="moveprev"></a> movePrev

▸ **movePrev**(): `void`

Navigates to the previous entry in the browsing history.

**`example`**
```ts
const history = {} as HistoryApi;
history.movePrev();
```

#### Returns

`void`