# Contents Handles DOM manipulation, queries and events for View contents **Kind**: global class * [Contents](#Contents) * [new Contents(doc, content, section)](#new_Contents_new) * _instance_ * [.width([w])](#Contents+width) ⇒ number * [.height([h])](#Contents+height) ⇒ number * [.textSize()](#Contents+textSize) ⇒ Object * [.scrollWidth()](#Contents+scrollWidth) ⇒ number * [.scrollHeight()](#Contents+scrollHeight) ⇒ number * [.overflow([overflow])](#Contents+overflow) ⇒ string * [.overflowX([overflow])](#Contents+overflowX) ⇒ string * [.overflowY([overflow])](#Contents+overflowY) ⇒ string * [.css(property, value, [priority])](#Contents+css) ⇒ any * [.viewport([options])](#Contents+viewport) ⇒ object * [.root()](#Contents+root) ⇒ Element * [.locationOf(target, [ignoreClass])](#Contents+locationOf) ⇒ Object * [.appendStylesheet(key, input)](#Contents+appendStylesheet) ⇒ Promise.<Node> * [.removeStylesheet(key)](#Contents+removeStylesheet) ⇒ boolean * [.clearStylesheets()](#Contents+clearStylesheets) * [.appendScript(key, src)](#Contents+appendScript) ⇒ Promise.<Node> * [.removeScript(key)](#Contents+removeScript) ⇒ boolean * [.clearScripts()](#Contents+clearScripts) * [.appendClass(className)](#Contents+appendClass) * [.removeClass(className)](#Contents+removeClass) * [.range(cfi, [ignoreClass])](#Contents+range) ⇒ Range * [.cfiFromRange(range, [ignoreClass])](#Contents+cfiFromRange) ⇒ string * [.cfiFromNode(node, [ignoreClass])](#Contents+cfiFromNode) ⇒ string * [.map(layout)](#Contents+map) ⇒ Array.<object> * [.format(layout)](#Contents+format) * [.scale(scale, offsetX, offsetY)](#Contents+scale) * [.direction([dir])](#Contents+direction) * [.mapPage(cfiBase, layout, start, end, dev)](#Contents+mapPage) ⇒ any * [.writingMode([mode])](#Contents+writingMode) * [.destroy()](#Contents+destroy) * _static_ * [.content](#Contents.content) : Element * [.contentRect](#Contents.contentRect) : object * [.section](#Contents.section) : Section * [.mode](#Contents.mode) : string ## new Contents(doc, content, section) Constructor | Param | Type | Description | | --- | --- | --- | | doc | Document | Document | | content | Element | Parent Element (typically Body) | | section | Section | Section object reference | ## contents.width([w]) ⇒ number Get or Set width **Kind**: instance method of [Contents](#Contents) **Returns**: number - width | Param | Type | | --- | --- | | [w] | number | ## contents.height([h]) ⇒ number Get or Set height **Kind**: instance method of [Contents](#Contents) **Returns**: number - height | Param | Type | | --- | --- | | [h] | number | ## contents.textSize() ⇒ Object Get size of the text using Range **Kind**: instance method of [Contents](#Contents) ## contents.scrollWidth() ⇒ number Get documentElement scrollWidth **Kind**: instance method of [Contents](#Contents) **Returns**: number - width ## contents.scrollHeight() ⇒ number Get documentElement scrollHeight **Kind**: instance method of [Contents](#Contents) **Returns**: number - height ## contents.overflow([overflow]) ⇒ string Set overflow css style of the contents **Kind**: instance method of [Contents](#Contents) | Param | Type | | --- | --- | | [overflow] | string | ## contents.overflowX([overflow]) ⇒ string Set overflowX css style of the documentElement **Kind**: instance method of [Contents](#Contents) | Param | Type | | --- | --- | | [overflow] | string | ## contents.overflowY([overflow]) ⇒ string Set overflowY css style of the documentElement **Kind**: instance method of [Contents](#Contents) | Param | Type | | --- | --- | | [overflow] | string | ## contents.css(property, value, [priority]) ⇒ any Set Css styles on the contents element (typically Body) **Kind**: instance method of [Contents](#Contents) | Param | Type | Description | | --- | --- | --- | | property | string | | | value | string | | | [priority] | boolean | set as "important" | ## contents.viewport([options]) ⇒ object Get or Set the viewport element **Kind**: instance method of [Contents](#Contents) | Param | Type | | --- | --- | | [options] | object | | [options.width] | string | | [options.height] | string | | [options.scale] | string | | [options.minimum] | string | | [options.maximum] | string | | [options.scalable] | string | ## contents.root() ⇒ Element Get the documentElement **Kind**: instance method of [Contents](#Contents) **Returns**: Element - documentElement ## contents.locationOf(target, [ignoreClass]) ⇒ Object Get the location offset of a EpubCFI or an #id **Kind**: instance method of [Contents](#Contents) **Returns**: Object - target position left and top | Param | Type | Description | | --- | --- | --- | | target | string \| EpubCFI | | | [ignoreClass] | string | for the cfi | ## contents.appendStylesheet(key, input) ⇒ Promise.<Node> Append a stylesheet link/rules to the document head **Kind**: instance method of [Contents](#Contents) | Param | Type | Description | | --- | --- | --- | | key | string | | | input | string \| object | url or rules | **Example** ```js appendStylesheet("common", "/pach/to/stylesheet.css") ``` **Example** ```js appendStylesheet("common", "https://example.com/to/stylesheet.css") ``` **Example** ```js appendStylesheet("common", { h1: { "font-size": "1.5em" }}) ``` ## contents.removeStylesheet(key) ⇒ boolean Remove a stylesheet link from the document head **Kind**: instance method of [Contents](#Contents) | Param | Type | | --- | --- | | key | string | ## contents.clearStylesheets() Clear all injected stylesheets **Kind**: instance method of [Contents](#Contents) ## contents.appendScript(key, src) ⇒ Promise.<Node> Append a script node to the document head **Kind**: instance method of [Contents](#Contents) **Returns**: Promise.<Node> - loaded | Param | Type | Description | | --- | --- | --- | | key | string | | | src | string | url | **Example** ```js appendScript("common", "/path/to/script.js") ``` **Example** ```js appendScript("common", "https://examples.com/to/script.js") ``` ## contents.removeScript(key) ⇒ boolean Remove a script node from the document head **Kind**: instance method of [Contents](#Contents) | Param | Type | | --- | --- | | key | string | ## contents.clearScripts() Clear all injected scripts **Kind**: instance method of [Contents](#Contents) ## contents.appendClass(className) Append a class to the contents container **Kind**: instance method of [Contents](#Contents) | Param | Type | | --- | --- | | className | string | ## contents.removeClass(className) Remove a class from the contents container **Kind**: instance method of [Contents](#Contents) | Param | Type | | --- | --- | | className | string | ## contents.range(cfi, [ignoreClass]) ⇒ Range Get a Dom Range from EpubCFI **Kind**: instance method of [Contents](#Contents) **Returns**: Range - range | Param | Type | | --- | --- | | cfi | EpubCFI | | [ignoreClass] | string | ## contents.cfiFromRange(range, [ignoreClass]) ⇒ string Get an EpubCFI from a Dom Range **Kind**: instance method of [Contents](#Contents) **Returns**: string - EpubCFI | Param | Type | | --- | --- | | range | Range | | [ignoreClass] | string | ## contents.cfiFromNode(node, [ignoreClass]) ⇒ string Get an EpubCFI from a Dom node **Kind**: instance method of [Contents](#Contents) **Returns**: string - EpubCFI | Param | Type | | --- | --- | | node | Node | | [ignoreClass] | string | ## contents.map(layout) ⇒ Array.<object> map **Kind**: instance method of [Contents](#Contents) **Todo** - [ ] find where this is used - remove? | Param | Type | | --- | --- | | layout | Layout | ## contents.format(layout) Apply CSS to a Document **Kind**: instance method of [Contents](#Contents) | Param | Type | | --- | --- | | layout | Layout | ## contents.scale(scale, offsetX, offsetY) Scale contents from center **Kind**: instance method of [Contents](#Contents) | Param | Type | | --- | --- | | scale | number | | offsetX | number | | offsetY | number | ## contents.direction([dir]) Set the direction of the text **Kind**: instance method of [Contents](#Contents) | Param | Type | Default | Description | | --- | --- | --- | --- | | [dir] | string | "'ltr'" | values: `"ltr"` OR `"rtl"` | ## contents.mapPage(cfiBase, layout, start, end, dev) ⇒ any mapPage **Kind**: instance method of [Contents](#Contents) | Param | Type | | --- | --- | | cfiBase | string | | layout | Layout | | start | number | | end | number | | dev | boolean | ## contents.writingMode([mode]) Set the writingMode of the text **Kind**: instance method of [Contents](#Contents) | Param | Type | Default | Description | | --- | --- | --- | --- | | [mode] | string | "'horizontal-tb'" | `"horizontal-tb"` OR `"vertical-rl"` OR `"vertical-lr"` | ## contents.destroy() destroy **Kind**: instance method of [Contents](#Contents) ## Contents.content : Element document.body by current location **Kind**: static property of [Contents](#Contents) **Read only**: true ## Contents.contentRect : object **Kind**: static property of [Contents](#Contents) **Read only**: true ## Contents.section : Section **Kind**: static property of [Contents](#Contents) **Read only**: true ## Contents.mode : string writing-mode **Kind**: static property of [Contents](#Contents) **Read only**: true