# Locations Find Locations for a Book **Kind**: global class * [Locations](#Locations) * [new Locations([sections], [request], [pause])](#new_Locations_new) * _instance_ * [.generate([chars])](#Locations+generate) ⇒ [Promise.<Locations>](#Locations) * [.process(section)](#Locations+process) ⇒ [Promise.<Locations>](#Locations) * [.parse(contents, cfiBase, [chars])](#Locations+parse) ⇒ [Promise.<Locations>](#Locations) * [.locationFromCfi(value)](#Locations+locationFromCfi) ⇒ number * [.percentageFromCfi(cfi)](#Locations+percentageFromCfi) ⇒ number * [.percentageFromLocation(index)](#Locations+percentageFromLocation) ⇒ number * [.cfiFromLocation(index)](#Locations+cfiFromLocation) ⇒ string \| null * [.cfiFromPercentage(value)](#Locations+cfiFromPercentage) ⇒ string \| null * [.load(locations)](#Locations+load) ⇒ [Locations](#Locations) * [.save()](#Locations+save) ⇒ string * [.set([options])](#Locations+set) ⇒ [Locations](#Locations) * [.clear()](#Locations+clear) * [.destroy()](#Locations+destroy) * _static_ * [.current](#Locations.current) : Location * [.generated](#Locations.generated) : [Promise.<Locations>](#Locations) * ["changed" (current, changed)](#Locations.event_changed) ## new Locations([sections], [request], [pause]) Constructor | Param | Type | Default | | --- | --- | --- | | [sections] | Sections | | | [request] | function | | | [pause] | number | 100 | ## locations.generate([chars]) ⇒ [Promise.<Locations>](#Locations) Load all of sections in the book to generate locations **Kind**: instance method of [Locations](#Locations) **Returns**: [Promise.<Locations>](#Locations) - Locations | Param | Type | Description | | --- | --- | --- | | [chars] | number | how many chars to split on (default:150) | ## locations.process(section) ⇒ [Promise.<Locations>](#Locations) process **Kind**: instance method of [Locations](#Locations) | Param | Type | | --- | --- | | section | Section | ## locations.parse(contents, cfiBase, [chars]) ⇒ [Promise.<Locations>](#Locations) parse **Kind**: instance method of [Locations](#Locations) | Param | Type | | --- | --- | | contents | Element | | cfiBase | string | | [chars] | number | ## locations.locationFromCfi(value) ⇒ number Get a location from an EpubCFI **Kind**: instance method of [Locations](#Locations) **Returns**: number - Location index or -1 otherwise | Param | Type | Description | | --- | --- | --- | | value | string \| EpubCFI | EpubCFI | ## locations.percentageFromCfi(cfi) ⇒ number Get a percentage position in locations from an EpubCFI **Kind**: instance method of [Locations](#Locations) **Returns**: number - Percentage | Param | Type | Description | | --- | --- | --- | | cfi | string \| EpubCFI | EpubCFI | ## locations.percentageFromLocation(index) ⇒ number Get a percentage position from a location index **Kind**: instance method of [Locations](#Locations) **Returns**: number - Percentage | Param | Type | Description | | --- | --- | --- | | index | number | Location index | ## locations.cfiFromLocation(index) ⇒ string \| null Get an EpubCFI from location index **Kind**: instance method of [Locations](#Locations) **Returns**: string \| null - EpubCFI string format | Param | Type | Description | | --- | --- | --- | | index | number | Location index | ## locations.cfiFromPercentage(value) ⇒ string \| null Get an EpubCFI from location percentage **Kind**: instance method of [Locations](#Locations) **Returns**: string \| null - EpubCFI string format | Param | Type | Description | | --- | --- | --- | | value | number | Percentage in ranging from 0 to 1 | ## locations.load(locations) ⇒ [Locations](#Locations) Load locations from JSON **Kind**: instance method of [Locations](#Locations) | Param | Type | | --- | --- | | locations | string | ## locations.save() ⇒ string Save locations to JSON **Kind**: instance method of [Locations](#Locations) **Returns**: string - A JSON string ## locations.set([options]) ⇒ [Locations](#Locations) Set current location **Kind**: instance method of [Locations](#Locations) | Param | Type | Description | | --- | --- | --- | | [options] | object | | | [options.cfi] | string | EpubCFI string format | | [options.index] | number | Location index | | [options.percentage] | number | Percentage | ## locations.clear() clear locations **Kind**: instance method of [Locations](#Locations) ## locations.destroy() destroy **Kind**: instance method of [Locations](#Locations) ## Locations.current : Location Current Location **Kind**: static property of [Locations](#Locations) **Read only**: true ## Locations.generated : [Promise.<Locations>](#Locations) **Kind**: static property of [Locations](#Locations) **Read only**: true ## "changed" (current, changed) Current location changed **Kind**: event emitted by [Locations](#Locations) | Param | Type | Description | | --- | --- | --- | | current | object | Current location | | changed | object | Changed properties |