# IframeView IframeView class **Kind**: global class * [IframeView](#IframeView) * [new IframeView(layout, section, [options])](#new_IframeView_new) * _instance_ * [.render(request)](#IframeView+render) ⇒ Promise.<string> * [.reset()](#IframeView+reset) * [.update()](#IframeView+update) * [.load(contents)](#IframeView+load) ⇒ Promise.<any> * [.onLoad(event, defer)](#IframeView+onLoad) * [.display(request)](#IframeView+display) ⇒ Promise.<view> * [.show()](#IframeView+show) * [.hide()](#IframeView+hide) * [.offset()](#IframeView+offset) ⇒ Object * [.position()](#IframeView+position) ⇒ DOMRect * [.locationOf(target)](#IframeView+locationOf) ⇒ Object * [.highlight(cfiRange, [data], [cb], [className], [styles])](#IframeView+highlight) ⇒ object * [.underline(cfiRange, [data], [cb], [className], [styles])](#IframeView+underline) ⇒ object * [.unhighlight(cfiRange)](#IframeView+unhighlight) ⇒ boolean * [.ununderline(cfiRange)](#IframeView+ununderline) ⇒ boolean * [.destroy()](#IframeView+destroy) * _static_ * [.id](#IframeView.id) : string * [.contents](#IframeView.contents) : Contents * [.container](#IframeView.container) : Element * [.marks](#IframeView.marks) : Marks * [.method](#IframeView.method) : string * [.writingMode](#IframeView.writingMode) : string * ["loaderror" (err)](#IframeView.event_loaderror) * ["rendered" (view)](#IframeView.event_rendered) * ["resized" (rect)](#IframeView.event_resized) * ["displayed"](#IframeView.event_displayed) * ["shown" (view)](#IframeView.event_shown) * ["hidden" (view)](#IframeView.event_hidden) * ["markClicked" (cfiRange, data)](#IframeView.event_markClicked) * ["markClicked" (cfiRange, data)](#IframeView.event_markClicked) ## new IframeView(layout, section, [options]) Constructor | Param | Type | Default | Description | | --- | --- | --- | --- | | layout | Layout | | | | section | Section | | | | [options] | object | | | | [options.method] | string | "'write'" | values: `"blobUrl"` OR `"srcdoc"` OR `"write"` | | [options.ignoreClass] | string | "''" | | | [options.sandbox] | Array.<string> | [] | iframe sandbox policy list | ## iframeView.render(request) ⇒ Promise.<string> render **Kind**: instance method of [IframeView](#IframeView) **Returns**: Promise.<string> - section render | Param | Type | | --- | --- | | request | function | ## iframeView.reset() reset **Kind**: instance method of [IframeView](#IframeView) ## iframeView.update() Update view **Kind**: instance method of [IframeView](#IframeView) ## iframeView.load(contents) ⇒ Promise.<any> load **Kind**: instance method of [IframeView](#IframeView) **Returns**: Promise.<any> - loading promise | Param | Type | | --- | --- | | contents | string | ## iframeView.onLoad(event, defer) onLoad **Kind**: instance method of [IframeView](#IframeView) | Param | Type | | --- | --- | | event | Event | | defer | Defer | ## iframeView.display(request) ⇒ Promise.<view> display **Kind**: instance method of [IframeView](#IframeView) **Returns**: Promise.<view> - displayed promise | Param | Type | | --- | --- | | request | function | ## iframeView.show() show **Kind**: instance method of [IframeView](#IframeView) ## iframeView.hide() hide **Kind**: instance method of [IframeView](#IframeView) ## iframeView.offset() ⇒ Object offset **Kind**: instance method of [IframeView](#IframeView) ## iframeView.position() ⇒ DOMRect position **Kind**: instance method of [IframeView](#IframeView) ## iframeView.locationOf(target) ⇒ Object locationOf **Kind**: instance method of [IframeView](#IframeView) | Param | Type | | --- | --- | | target | string \| EpubCFI | ## iframeView.highlight(cfiRange, [data], [cb], [className], [styles]) ⇒ object highlight **Kind**: instance method of [IframeView](#IframeView) | Param | Type | Default | Description | | --- | --- | --- | --- | | cfiRange | string | | | | [data] | object | {} | | | [cb] | function | | callback function | | [className] | string | "'epubjs-hl'" | | | [styles] | object | {} | | ## iframeView.underline(cfiRange, [data], [cb], [className], [styles]) ⇒ object underline **Kind**: instance method of [IframeView](#IframeView) | Param | Type | Default | | --- | --- | --- | | cfiRange | string | | | [data] | object | {} | | [cb] | function | | | [className] | string | "'epubjs-ul'" | | [styles] | object | {} | ## iframeView.unhighlight(cfiRange) ⇒ boolean unhighlight **Kind**: instance method of [IframeView](#IframeView) | Param | Type | | --- | --- | | cfiRange | string | ## iframeView.ununderline(cfiRange) ⇒ boolean ununderline **Kind**: instance method of [IframeView](#IframeView) | Param | Type | | --- | --- | | cfiRange | string | ## iframeView.destroy() destroy **Kind**: instance method of [IframeView](#IframeView) ## IframeView.id : string **Kind**: static property of [IframeView](#IframeView) **Read only**: true ## IframeView.contents : Contents **Kind**: static property of [IframeView](#IframeView) **Read only**: true ## IframeView.container : Element **Kind**: static property of [IframeView](#IframeView) **Read only**: true ## IframeView.marks : Marks **Kind**: static property of [IframeView](#IframeView) **Read only**: true ## IframeView.method : string Load method **Kind**: static property of [IframeView](#IframeView) **Read only**: true ## IframeView.writingMode : string **Kind**: static property of [IframeView](#IframeView) **Read only**: true ## "loaderror" (err) **Kind**: event emitted by [IframeView](#IframeView) | Param | Type | | --- | --- | | err | object | ## "rendered" (view) **Kind**: event emitted by [IframeView](#IframeView) | Param | Type | | --- | --- | | view | [IframeView](#IframeView) | ## "resized" (rect) **Kind**: event emitted by [IframeView](#IframeView) | Param | Type | | --- | --- | | rect | object | ## "displayed" **Kind**: event emitted by [IframeView](#IframeView) ## "shown" (view) **Kind**: event emitted by [IframeView](#IframeView) | Param | Type | | --- | --- | | view | [IframeView](#IframeView) | ## "hidden" (view) **Kind**: event emitted by [IframeView](#IframeView) | Param | Type | | --- | --- | | view | [IframeView](#IframeView) | ## "markClicked" (cfiRange, data) **Kind**: event emitted by [IframeView](#IframeView) | Param | Type | | --- | --- | | cfiRange | string | | data | object | ## "markClicked" (cfiRange, data) **Kind**: event emitted by [IframeView](#IframeView) | Param | Type | | --- | --- | | cfiRange | string | | data | object |