Interface: HistoryApi

ReportViewer.HistoryApi

Defines the contract for viewer history navigation.

example

const history = {} as HistoryApi;
history.movePrev();

Table of contents

Methods

• canMoveNext
• canMovePrev
• clear
• moveNext
• movePrev

Methods

canMoveNext

▸ canMoveNext(): boolean

Gets a value indicating whether a forward navigation is available.

example

const history = {} as HistoryApi;
const canMove = history.canMoveNext();

Returns

boolean

true if forward navigation is available; otherwise, false.

canMovePrev

▸ canMovePrev(): boolean

Gets a value indicating whether a backward navigation is available.

example

const history = {} as HistoryApi;
const canMove = history.canMovePrev();

Returns

boolean

true if backward navigation is available; otherwise, false.

clear

▸ clear(): void

Clears all history entries.

example

const history = {} as HistoryApi;
history.clear();

Returns

void

moveNext

▸ moveNext(): void

Navigates to the next entry in the browsing history.

example

const history = {} as HistoryApi;
history.moveNext();

Returns

void

movePrev

▸ movePrev(): void

Navigates to the previous entry in the browsing history.

example

const history = {} as HistoryApi;
history.movePrev();

Returns

void