[**@jupyterlite**](../../../README.md) *** [@jupyterlite](../../../README.md) / [@jupyterlite/iframe-extension](../README.md) / RenderedIFrame # Class: RenderedIFrame Defined in: [packages/iframe-extension/src/index.ts:33](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/iframe-extension/src/index.ts#L33) A class for rendering an IFrame document. ## Extends - `Widget` ## Implements - `IRenderer` ## Constructors ### Constructor > **new RenderedIFrame**(): `RenderedIFrame` Defined in: [packages/iframe-extension/src/index.ts:34](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/iframe-extension/src/index.ts#L34) #### Returns `RenderedIFrame` #### Overrides `Widget.constructor` ## Properties ### node > `readonly` **node**: `HTMLElement` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:37 Get the DOM node owned by the widget. #### Implementation of `IRenderMime.IRenderer.node` #### Inherited from `Widget.node` ## Accessors ### dataset #### Get Signature > **get** **dataset**(): `DOMStringMap` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:88 The dataset for the widget's DOM node. ##### Returns `DOMStringMap` #### Implementation of `IRenderMime.IRenderer.dataset` #### Inherited from `Widget.dataset` *** ### disposed #### Get Signature > **get** **disposed**(): `ISignal`\<`this`, `void`\> Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:33 A signal emitted when the widget is disposed. ##### Returns `ISignal`\<`this`, `void`\> #### Implementation of `IRenderMime.IRenderer.disposed` #### Inherited from `Widget.disposed` *** ### hiddenMode #### Get Signature > **get** **hiddenMode**(): `HiddenMode` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:92 Get the method for hiding the widget. ##### Returns `HiddenMode` #### Set Signature > **set** **hiddenMode**(`value`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:96 Set the method for hiding the widget. ##### Parameters ###### value `HiddenMode` ##### Returns `void` #### Implementation of `IRenderMime.IRenderer.hiddenMode` #### Inherited from `Widget.hiddenMode` *** ### id #### Get Signature > **get** **id**(): `string` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:80 Get the id of the widget's DOM node. ##### Returns `string` #### Set Signature > **set** **id**(`value`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:84 Set the id of the widget's DOM node. ##### Parameters ###### value `string` ##### Returns `void` #### Implementation of `IRenderMime.IRenderer.id` #### Inherited from `Widget.id` *** ### isAttached #### Get Signature > **get** **isAttached**(): `boolean` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:45 Test whether the widget's node is attached to the DOM. ##### Returns `boolean` #### Implementation of `IRenderMime.IRenderer.isAttached` #### Inherited from `Widget.isAttached` *** ### isDisposed #### Get Signature > **get** **isDisposed**(): `boolean` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:41 Test whether the widget has been disposed. ##### Returns `boolean` #### Implementation of `IRenderMime.IRenderer.isDisposed` #### Inherited from `Widget.isDisposed` *** ### isHidden #### Get Signature > **get** **isHidden**(): `boolean` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:53 Test whether the widget is explicitly hidden. #### Notes You should prefer `!{@link isVisible}` over `{@link isHidden}` if you want to know if the widget is hidden as this does not test if the widget is hidden because one of its ancestors is hidden. ##### Returns `boolean` #### Implementation of `IRenderMime.IRenderer.isHidden` #### Inherited from `Widget.isHidden` *** ### isVisible #### Get Signature > **get** **isVisible**(): `boolean` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:64 Test whether the widget is visible. #### Notes A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors. Since 2.7.0, this does not rely on the Widget.Flag.IsVisible flag. It recursively checks the visibility of all parent widgets. ##### Returns `boolean` #### Implementation of `IRenderMime.IRenderer.isVisible` #### Inherited from `Widget.isVisible` *** ### layout #### Get Signature > **get** **layout**(): `null` \| `Layout` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:116 Get the layout for the widget. ##### Returns `null` \| `Layout` #### Set Signature > **set** **layout**(`value`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:126 Set the layout for the widget. #### Notes The layout is single-use only. It cannot be changed after the first assignment. The layout is disposed automatically when the widget is disposed. ##### Parameters ###### value `null` | `Layout` ##### Returns `void` #### Implementation of `IRenderMime.IRenderer.layout` #### Inherited from `Widget.layout` *** ### parent #### Get Signature > **get** **parent**(): `null` \| `Widget` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:100 Get the parent of the widget. ##### Returns `null` \| `Widget` #### Set Signature > **set** **parent**(`value`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:112 Set the parent of the widget. #### Notes Children are typically added to a widget by using a layout, which means user code will not normally set the parent widget directly. The widget will be automatically removed from its old parent. This is a no-op if there is no effective parent change. ##### Parameters ###### value `null` | `Widget` ##### Returns `void` #### Implementation of `IRenderMime.IRenderer.parent` #### Inherited from `Widget.parent` *** ### title #### Get Signature > **get** **title**(): `Title`\<`Widget`\> Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:76 The title object for the widget. #### Notes The title object is used by some container widgets when displaying the widget alongside some title, such as a tab panel or side bar. Since not all widgets will use the title, it is created on demand. The `owner` property of the title is set to this widget. ##### Returns `Title`\<`Widget`\> #### Implementation of `IRenderMime.IRenderer.title` #### Inherited from `Widget.title` ## Methods ### activate() > **activate**(): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:211 Post an `'activate-request'` message to the widget. #### Notes This is a simple convenience method for posting the message. #### Returns `void` #### Implementation of `IRenderMime.IRenderer.activate` #### Inherited from `Widget.activate` *** ### addClass() > **addClass**(`name`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:164 Add a class name to the widget's DOM node. #### Parameters ##### name `string` The class name to add to the node. #### Notes If the class name is already added to the node, this is a no-op. The class name must not contain whitespace. #### Returns `void` #### Implementation of `IRenderMime.IRenderer.addClass` #### Inherited from `Widget.addClass` *** ### children() > **children**(): `IterableIterator`\<`Widget`\> Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:137 Create an iterator over the widget's children. #### Returns `IterableIterator`\<`Widget`\> A new iterator over the children of the widget. #### Notes The widget must have a populated layout in order to have children. If a layout is not installed, the returned iterator will be empty. #### Implementation of `IRenderMime.IRenderer.children` #### Inherited from `Widget.children` *** ### clearFlag() > **clearFlag**(`flag`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:275 Clear the given widget flag. #### Notes This will not typically be called directly by user code. Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version. #### Parameters ##### flag `Flag` #### Returns `void` #### Implementation of `IRenderMime.IRenderer.clearFlag` #### Inherited from `Widget.clearFlag` *** ### close() > **close**(): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:218 Send a `'close-request'` message to the widget. #### Notes This is a simple convenience method for sending the message. #### Returns `void` #### Implementation of `IRenderMime.IRenderer.close` #### Inherited from `Widget.close` *** ### contains() > **contains**(`widget`): `boolean` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:145 Test whether a widget is a descendant of this widget. #### Parameters ##### widget `Widget` The descendant widget of interest. #### Returns `boolean` `true` if the widget is a descendant, `false` otherwise. #### Implementation of `IRenderMime.IRenderer.contains` #### Inherited from `Widget.contains` *** ### dispose() > **dispose**(): `void` Defined in: [packages/iframe-extension/src/index.ts:69](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/iframe-extension/src/index.ts#L69) Dispose of the resources held by the iframe widget. #### Returns `void` #### Implementation of `IRenderMime.IRenderer.dispose` #### Overrides `Widget.dispose` *** ### fit() > **fit**(): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:204 Post a `'fit-request'` message to the widget. #### Notes This is a simple convenience method for posting the message. #### Returns `void` #### Implementation of `IRenderMime.IRenderer.fit` #### Inherited from `Widget.fit` *** ### hasClass() > **hasClass**(`name`): `boolean` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:153 Test whether the widget's DOM node has the given class name. #### Parameters ##### name `string` The class name of interest. #### Returns `boolean` `true` if the node has the class, `false` otherwise. #### Implementation of `IRenderMime.IRenderer.hasClass` #### Inherited from `Widget.hasClass` *** ### hide() > **hide**(): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:236 Hide the widget and make it hidden to its parent widget. #### Notes This causes the [isHidden](#ishidden) property to be `true`. If the widget is explicitly hidden, this is a no-op. #### Returns `void` #### Implementation of `IRenderMime.IRenderer.hide` #### Inherited from `Widget.hide` *** ### notifyLayout() > `protected` **notifyLayout**(`msg`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:295 Invoke the message processing routine of the widget's layout. #### Parameters ##### msg `Message` The message to dispatch to the layout. #### Notes This is a no-op if the widget does not have a layout. This will not typically be called directly by user code. #### Returns `void` #### Implementation of `IRenderMime.IRenderer.notifyLayout` #### Inherited from `Widget.notifyLayout` *** ### onActivateRequest() > `protected` **onActivateRequest**(`msg`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:330 A message handler invoked on an `'activate-request'` message. #### Notes The default implementation of this handler is a no-op. #### Parameters ##### msg `Message` #### Returns `void` #### Implementation of `IRenderMime.IRenderer.onActivateRequest` #### Inherited from `Widget.onActivateRequest` *** ### onAfterAttach() > `protected` **onAfterAttach**(`msg`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:372 A message handler invoked on an `'after-attach'` message. #### Notes The default implementation of this handler is a no-op. #### Parameters ##### msg `Message` #### Returns `void` #### Implementation of `IRenderMime.IRenderer.onAfterAttach` #### Inherited from `Widget.onAfterAttach` *** ### onAfterDetach() > `protected` **onAfterDetach**(`msg`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:386 A message handler invoked on an `'after-detach'` message. #### Notes The default implementation of this handler is a no-op. #### Parameters ##### msg `Message` #### Returns `void` #### Implementation of `IRenderMime.IRenderer.onAfterDetach` #### Inherited from `Widget.onAfterDetach` *** ### onAfterHide() > `protected` **onAfterHide**(`msg`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:358 A message handler invoked on an `'after-hide'` message. #### Notes The default implementation of this handler is a no-op. #### Parameters ##### msg `Message` #### Returns `void` #### Implementation of `IRenderMime.IRenderer.onAfterHide` #### Inherited from `Widget.onAfterHide` *** ### onAfterShow() > `protected` **onAfterShow**(`msg`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:344 A message handler invoked on an `'after-show'` message. #### Notes The default implementation of this handler is a no-op. #### Parameters ##### msg `Message` #### Returns `void` #### Implementation of `IRenderMime.IRenderer.onAfterShow` #### Inherited from `Widget.onAfterShow` *** ### onBeforeAttach() > `protected` **onBeforeAttach**(`msg`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:365 A message handler invoked on a `'before-attach'` message. #### Notes The default implementation of this handler is a no-op. #### Parameters ##### msg `Message` #### Returns `void` #### Implementation of `IRenderMime.IRenderer.onBeforeAttach` #### Inherited from `Widget.onBeforeAttach` *** ### onBeforeDetach() > `protected` **onBeforeDetach**(`msg`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:379 A message handler invoked on a `'before-detach'` message. #### Notes The default implementation of this handler is a no-op. #### Parameters ##### msg `Message` #### Returns `void` #### Implementation of `IRenderMime.IRenderer.onBeforeDetach` #### Inherited from `Widget.onBeforeDetach` *** ### onBeforeHide() > `protected` **onBeforeHide**(`msg`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:351 A message handler invoked on a `'before-hide'` message. #### Notes The default implementation of this handler is a no-op. #### Parameters ##### msg `Message` #### Returns `void` #### Implementation of `IRenderMime.IRenderer.onBeforeHide` #### Inherited from `Widget.onBeforeHide` *** ### onBeforeShow() > `protected` **onBeforeShow**(`msg`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:337 A message handler invoked on a `'before-show'` message. #### Notes The default implementation of this handler is a no-op. #### Parameters ##### msg `Message` #### Returns `void` #### Implementation of `IRenderMime.IRenderer.onBeforeShow` #### Inherited from `Widget.onBeforeShow` *** ### onChildAdded() > `protected` **onChildAdded**(`msg`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:393 A message handler invoked on a `'child-added'` message. #### Notes The default implementation of this handler is a no-op. #### Parameters ##### msg `ChildMessage` #### Returns `void` #### Implementation of `IRenderMime.IRenderer.onChildAdded` #### Inherited from `Widget.onChildAdded` *** ### onChildRemoved() > `protected` **onChildRemoved**(`msg`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:400 A message handler invoked on a `'child-removed'` message. #### Notes The default implementation of this handler is a no-op. #### Parameters ##### msg `ChildMessage` #### Returns `void` #### Implementation of `IRenderMime.IRenderer.onChildRemoved` #### Inherited from `Widget.onChildRemoved` *** ### onCloseRequest() > `protected` **onCloseRequest**(`msg`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:302 A message handler invoked on a `'close-request'` message. #### Notes The default implementation unparents or detaches the widget. #### Parameters ##### msg `Message` #### Returns `void` #### Implementation of `IRenderMime.IRenderer.onCloseRequest` #### Inherited from `Widget.onCloseRequest` *** ### onFitRequest() > `protected` **onFitRequest**(`msg`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:323 A message handler invoked on a `'fit-request'` message. #### Notes The default implementation of this handler is a no-op. #### Parameters ##### msg `Message` #### Returns `void` #### Implementation of `IRenderMime.IRenderer.onFitRequest` #### Inherited from `Widget.onFitRequest` *** ### onResize() > `protected` **onResize**(`msg`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:309 A message handler invoked on a `'resize'` message. #### Notes The default implementation of this handler is a no-op. #### Parameters ##### msg `ResizeMessage` #### Returns `void` #### Implementation of `IRenderMime.IRenderer.onResize` #### Inherited from `Widget.onResize` *** ### onUpdateRequest() > `protected` **onUpdateRequest**(`msg`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:316 A message handler invoked on an `'update-request'` message. #### Notes The default implementation of this handler is a no-op. #### Parameters ##### msg `Message` #### Returns `void` #### Implementation of `IRenderMime.IRenderer.onUpdateRequest` #### Inherited from `Widget.onUpdateRequest` *** ### processMessage() > **processMessage**(`msg`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:284 Process a message sent to the widget. #### Parameters ##### msg `Message` The message sent to the widget. #### Notes Subclasses may reimplement this method as needed. #### Returns `void` #### Implementation of `IRenderMime.IRenderer.processMessage` #### Inherited from `Widget.processMessage` *** ### removeClass() > **removeClass**(`name`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:175 Remove a class name from the widget's DOM node. #### Parameters ##### name `string` The class name to remove from the node. #### Notes If the class name is not yet added to the node, this is a no-op. The class name must not contain whitespace. #### Returns `void` #### Implementation of `IRenderMime.IRenderer.removeClass` #### Inherited from `Widget.removeClass` *** ### renderModel() > **renderModel**(`model`): `Promise`\<`void`\> Defined in: [packages/iframe-extension/src/index.ts:44](https://github.com/jupyterlite/jupyterlite/blob/14439ec34e3cade5baa221a050277e15da9d0c06/packages/iframe-extension/src/index.ts#L44) Render the IFrame into this widget's node. #### Parameters ##### model `IMimeModel` #### Returns `Promise`\<`void`\> #### Implementation of `IRenderMime.IRenderer.renderModel` *** ### setFlag() > **setFlag**(`flag`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:265 Set the given widget flag. #### Notes This will not typically be called directly by user code. Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version. #### Parameters ##### flag `Flag` #### Returns `void` #### Implementation of `IRenderMime.IRenderer.setFlag` #### Inherited from `Widget.setFlag` *** ### setHidden() > **setHidden**(`hidden`): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:245 Show or hide the widget according to a boolean value. #### Parameters ##### hidden `boolean` `true` to hide the widget, or `false` to show it. #### Notes This is a convenience method for `hide()` and `show()`. #### Returns `void` #### Implementation of `IRenderMime.IRenderer.setHidden` #### Inherited from `Widget.setHidden` *** ### show() > **show**(): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:227 Show the widget and make it visible to its parent widget. #### Notes This causes the [isHidden](#ishidden) property to be `false`. If the widget is not explicitly hidden, this is a no-op. #### Returns `void` #### Implementation of `IRenderMime.IRenderer.show` #### Inherited from `Widget.show` *** ### testFlag() > **testFlag**(`flag`): `boolean` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:255 Test whether the given widget flag is set. #### Notes This will not typically be called directly by user code. Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version. #### Parameters ##### flag `Flag` #### Returns `boolean` #### Implementation of `IRenderMime.IRenderer.testFlag` #### Inherited from `Widget.testFlag` *** ### toggleClass() > **toggleClass**(`name`, `force?`): `boolean` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:190 Toggle a class name on the widget's DOM node. #### Parameters ##### name `string` The class name to toggle on the node. ##### force? `boolean` Whether to force add the class (`true`) or force remove the class (`false`). If not provided, the presence of the class will be toggled from its current state. #### Returns `boolean` `true` if the class is now present, `false` otherwise. #### Notes The class name must not contain whitespace. #### Implementation of `IRenderMime.IRenderer.toggleClass` #### Inherited from `Widget.toggleClass` *** ### update() > **update**(): `void` Defined in: node\_modules/@lumino/widgets/types/widget.d.ts:197 Post an `'update-request'` message to the widget. #### Notes This is a simple convenience method for posting the message. #### Returns `void` #### Implementation of `IRenderMime.IRenderer.update` #### Inherited from `Widget.update`