# Section Represents a Section of the Book In most books this is equivalent to a Chapter **Kind**: global class * [Section](#Section) * [new Section(item, hooks)](#new_Section_new) * _instance_ * [.load(request)](#Section+load) ⇒ Promise.<Element> * [.render(request)](#Section+render) ⇒ Promise.<string> * [.find(query)](#Section+find) ⇒ Array.<object> * [.search(query, [maxSeqEle])](#Section+search) ⇒ Array.<object> * [.cfiFromRange(range)](#Section+cfiFromRange) ⇒ string * [.cfiFromElement(el)](#Section+cfiFromElement) ⇒ string * [.unload()](#Section+unload) * [.destroy()](#Section+destroy) * _static_ * [.idref](#Section.idref) : string * [.linear](#Section.linear) : boolean * [.index](#Section.index) : number * [.href](#Section.href) : string * [.url](#Section.url) : string * [.canonical](#Section.canonical) : string * [.cfiBase](#Section.cfiBase) : string * [.next](#Section.next) : function * [.prev](#Section.prev) : function * [.properties](#Section.properties) : Array.<string> * [.document](#Section.document) : Document * [.contents](#Section.contents) : Element * [.output](#Section.output) : string ## new Section(item, hooks) Constructor | Param | Type | Description | | --- | --- | --- | | item | object | Spine Item | | hooks | object | | ## section.load(request) ⇒ Promise.<Element> Load the section from its url **Kind**: instance method of [Section](#Section) **Returns**: Promise.<Element> - a promise with the xml document | Param | Type | Description | | --- | --- | --- | | request | function | a request method to use for loading | ## section.render(request) ⇒ Promise.<string> Render the contents of a section **Kind**: instance method of [Section](#Section) **Returns**: Promise.<string> - output a serialized XML Document **Todo** - [ ] better way to return this from hooks? | Param | Type | Description | | --- | --- | --- | | request | function | a request method to use for loading | ## section.find(query) ⇒ Array.<object> Find a string in a section **Kind**: instance method of [Section](#Section) **Returns**: Array.<object> - A list of matches, with form { cfi, excerpt } | Param | Type | Description | | --- | --- | --- | | query | string | The query string to find | ## section.search(query, [maxSeqEle]) ⇒ Array.<object> Search a string in multiple sequential Element of the section. If the document.createTreeWalker api is missed(eg: IE8), use `find` as a fallback. **Kind**: instance method of [Section](#Section) **Returns**: Array.<object> - A list of matches, with form { cfi, excerpt } | Param | Type | Default | Description | | --- | --- | --- | --- | | query | string | | The query string to search | | [maxSeqEle] | number | 5 | The maximum number of Element that are combined for search, default value is 5. | ## section.cfiFromRange(range) ⇒ string Get a CFI from a Range in the Section **Kind**: instance method of [Section](#Section) **Returns**: string - cfi an EpubCFI string | Param | Type | | --- | --- | | range | Range | ## section.cfiFromElement(el) ⇒ string Get a CFI from an Element in the Section **Kind**: instance method of [Section](#Section) **Returns**: string - cfi an EpubCFI string | Param | Type | | --- | --- | | el | Element | ## section.unload() Unload the section document **Kind**: instance method of [Section](#Section) ## section.destroy() destroy **Kind**: instance method of [Section](#Section) ## Section.idref : string **Kind**: static property of [Section](#Section) **Read only**: true ## Section.linear : boolean **Kind**: static property of [Section](#Section) **Read only**: true ## Section.index : number **Kind**: static property of [Section](#Section) **Read only**: true ## Section.href : string **Kind**: static property of [Section](#Section) **Read only**: true ## Section.url : string **Kind**: static property of [Section](#Section) **Read only**: true ## Section.canonical : string **Kind**: static property of [Section](#Section) **Read only**: true ## Section.cfiBase : string **Kind**: static property of [Section](#Section) **Read only**: true ## Section.next : function **Kind**: static property of [Section](#Section) **Read only**: true ## Section.prev : function **Kind**: static property of [Section](#Section) **Read only**: true ## Section.properties : Array.<string> **Kind**: static property of [Section](#Section) **Read only**: true ## Section.document : Document **Kind**: static property of [Section](#Section) **Read only**: true ## Section.contents : Element **Kind**: static property of [Section](#Section) **Read only**: true ## Section.output : string **Kind**: static property of [Section](#Section) **Read only**: true