# PageList ⇐ Array Page List Parser **Kind**: global class **Extends**: Array **Link**: https://www.w3.org/TR/epub/#sec-nav-pagelist * [PageList](#PageList) ⇐ Array * [new PageList()](#new_PageList_new) * _instance_ * [.parse(target)](#PageList+parse) ⇒ [Promise.<PageList>](#PageList) * [.pageFromCfi(cfi)](#PageList+pageFromCfi) ⇒ number * [.cfiFromPage(pg)](#PageList+cfiFromPage) ⇒ string \| null * [.pageFromPercentage(value)](#PageList+pageFromPercentage) ⇒ number * [.percentageFromPage(pg)](#PageList+percentageFromPage) ⇒ number * [.percentageFromCfi(cfi)](#PageList+percentageFromCfi) ⇒ number * [.clear()](#PageList+clear) * [.destroy()](#PageList+destroy) * _static_ * [.pages](#PageList.pages) : Array.<number> * [.locations](#PageList.locations) : Array.<string> * [.firstPage](#PageList.firstPage) : number * [.lastPage](#PageList.lastPage) : number * [.totalPages](#PageList.totalPages) : number ## new PageList() Constructor ## pageList.parse(target) ⇒ [Promise.<PageList>](#PageList) Parse Page List **Kind**: instance method of [PageList](#PageList) | Param | Type | | --- | --- | | target | Node \| Array.<object> | ## pageList.pageFromCfi(cfi) ⇒ number Get a page index from a EpubCFI **Kind**: instance method of [PageList](#PageList) **Returns**: number - Page index | Param | Type | Description | | --- | --- | --- | | cfi | string | EpubCFI | ## pageList.cfiFromPage(pg) ⇒ string \| null Get a EpubCFI by Page index **Kind**: instance method of [PageList](#PageList) **Returns**: string \| null - cfi | Param | Type | Description | | --- | --- | --- | | pg | string \| number | Page index | ## pageList.pageFromPercentage(value) ⇒ number Get a Page index from Book percentage **Kind**: instance method of [PageList](#PageList) **Returns**: number - Page index | Param | Type | Description | | --- | --- | --- | | value | number | Percentage | ## pageList.percentageFromPage(pg) ⇒ number Returns a value between 0 - 1 corresponding to the location of a page **Kind**: instance method of [PageList](#PageList) **Returns**: number - Percentage | Param | Type | Description | | --- | --- | --- | | pg | number | the page | ## pageList.percentageFromCfi(cfi) ⇒ number Returns a value between 0 - 1 corresponding to the location of a cfi **Kind**: instance method of [PageList](#PageList) **Returns**: number - Percentage | Param | Type | Description | | --- | --- | --- | | cfi | string | EpubCFI | ## pageList.clear() Clear PageList **Kind**: instance method of [PageList](#PageList) ## pageList.destroy() Destroy **Kind**: instance method of [PageList](#PageList) ## PageList.pages : Array.<number> Page indexes **Kind**: static property of [PageList](#PageList) **Read only**: true ## PageList.locations : Array.<string> **Kind**: static property of [PageList](#PageList) **Read only**: true ## PageList.firstPage : number **Kind**: static property of [PageList](#PageList) **Read only**: true ## PageList.lastPage : number **Kind**: static property of [PageList](#PageList) **Read only**: true ## PageList.totalPages : number **Kind**: static property of [PageList](#PageList) **Read only**: true