Class: `RenderedIFrame`#

@jupyterlite/iframe-extension.RenderedIFrame

A class for rendering an IFrame document.

Hierarchy#

Widget

↳ RenderedIFrame

Implements#

IRenderer

Constructors#

`constructor`#

new RenderedIFrame()

Overrides#

Widget.constructor

Defined in#

packages/iframe-extension/src/index.ts:34

Properties#

`_iframe`#

Private _iframe: HTMLIFrameElement

Defined in#

packages/iframe-extension/src/index.ts:74

`node`#

Readonly node: HTMLElement

Get the DOM node owned by the widget.

Implementation of#

IRenderMime.IRenderer.node

Inherited from#

Widget.node

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:37

Accessors#

`dataset`#

get dataset(): DOMStringMap

The dataset for the widget’s DOM node.

Returns#

DOMStringMap

Implementation of#

IRenderMime.IRenderer.dataset

Inherited from#

Widget.dataset

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:81

`disposed`#

get disposed(): ISignal<this, void>

A signal emitted when the widget is disposed.

Returns#

ISignal<this, void>

Implementation of#

IRenderMime.IRenderer.disposed

Inherited from#

Widget.disposed

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:33

`hiddenMode`#

get hiddenMode(): HiddenMode

Get the method for hiding the widget.

Returns#

HiddenMode

Implementation of#

IRenderMime.IRenderer.hiddenMode

Inherited from#

Widget.hiddenMode

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:85

set hiddenMode(value): void

Set the method for hiding the widget.

Parameters#

Name	Type
`value`	`HiddenMode`

Returns#

void

Implementation of#

IRenderMime.IRenderer.hiddenMode

Inherited from#

Widget.hiddenMode

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:89

`id`#

get id(): string

Get the id of the widget’s DOM node.

Returns#

string

Implementation of#

IRenderMime.IRenderer.id

Inherited from#

Widget.id

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:73

set id(value): void

Set the id of the widget’s DOM node.

Parameters#

Name	Type
`value`	`string`

Returns#

void

Implementation of#

IRenderMime.IRenderer.id

Inherited from#

Widget.id

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:77

`isAttached`#

get isAttached(): boolean

Test whether the widget’s node is attached to the DOM.

Returns#

boolean

Implementation of#

IRenderMime.IRenderer.isAttached

Inherited from#

Widget.isAttached

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:45

`isDisposed`#

get isDisposed(): boolean

Test whether the widget has been disposed.

Returns#

boolean

Implementation of#

IRenderMime.IRenderer.isDisposed

Inherited from#

Widget.isDisposed

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:41

`isHidden`#

get isHidden(): boolean

Test whether the widget is explicitly hidden.

Returns#

boolean

Implementation of#

IRenderMime.IRenderer.isHidden

Inherited from#

Widget.isHidden

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:49

`isVisible`#

get isVisible(): boolean

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.

Returns#

boolean

Implementation of#

IRenderMime.IRenderer.isVisible

Inherited from#

Widget.isVisible

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:57

`layout`#

get layout(): null | Layout

Get the layout for the widget.

Returns#

null | Layout

Implementation of#

IRenderMime.IRenderer.layout

Inherited from#

Widget.layout

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:109

set layout(value): void

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#

Name	Type
`value`	`null` \| `Layout`

Returns#

void

Implementation of#

IRenderMime.IRenderer.layout

Inherited from#

Widget.layout

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:119

`parent`#

get parent(): null | Widget

Get the parent of the widget.

Returns#

null | Widget

Implementation of#

IRenderMime.IRenderer.parent

Inherited from#

Widget.parent

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:93

set parent(value): void

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#

Name	Type
`value`	`null` \| `Widget`

Returns#

void

Implementation of#

IRenderMime.IRenderer.parent

Inherited from#

Widget.parent

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:105

`title`#

get title(): Title<Widget>

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

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:69

Methods#

`activate`#

activate(): void

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

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:204

`addClass`#

addClass(name): void

Add a class name to the widget’s DOM node.

Parameters#

Name	Type	Description
`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

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:157

`children`#

children(): IterableIterator<Widget>

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

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:130

`clearFlag`#

clearFlag(flag): void

Clear the given widget flag.

Notes#

This will not typically be called directly by user code.

Parameters#

Name	Type
`flag`	`Flag`

Returns#

void

Implementation of#

IRenderMime.IRenderer.clearFlag

Inherited from#

Widget.clearFlag

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:259

`close`#

close(): void

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

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:211

`contains`#

contains(widget): boolean

Test whether a widget is a descendant of this widget.

Parameters#

Name	Type	Description
`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

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:138

`dispose`#

dispose(): void

Dispose of the resources held by the iframe widget.

Returns#

void

Implementation of#

IRenderMime.IRenderer.dispose

Overrides#

Widget.dispose

Defined in#

packages/iframe-extension/src/index.ts:69

`fit`#

fit(): void

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

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:197

`hasClass`#

hasClass(name): boolean

Test whether the widget’s DOM node has the given class name.

Parameters#

Name	Type	Description
`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

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:146

`hide`#

hide(): void

Hide the widget and make it hidden to its parent widget.

Notes#

This causes the 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

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:229

`notifyLayout`#

Protected notifyLayout(msg): void

Invoke the message processing routine of the widget’s layout.

Parameters#

Name	Type	Description
`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

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:279

`onActivateRequest`#

Protected onActivateRequest(msg): void

A message handler invoked on an 'activate-request' message.

Notes#

The default implementation of this handler is a no-op.

Parameters#

Name	Type
`msg`	`Message`

Returns#

void

Implementation of#

IRenderMime.IRenderer.onActivateRequest

Inherited from#

Widget.onActivateRequest

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:314

`onAfterAttach`#

Protected onAfterAttach(msg): void

A message handler invoked on an 'after-attach' message.

Notes#

The default implementation of this handler is a no-op.

Parameters#

Name	Type
`msg`	`Message`

Returns#

void

Implementation of#

IRenderMime.IRenderer.onAfterAttach

Inherited from#

Widget.onAfterAttach

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:356

`onAfterDetach`#

Protected onAfterDetach(msg): void

A message handler invoked on an 'after-detach' message.

Notes#

The default implementation of this handler is a no-op.

Parameters#

Name	Type
`msg`	`Message`

Returns#

void

Implementation of#

IRenderMime.IRenderer.onAfterDetach

Inherited from#

Widget.onAfterDetach

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:370

`onAfterHide`#

Protected onAfterHide(msg): void

A message handler invoked on an 'after-hide' message.

Notes#

The default implementation of this handler is a no-op.

Parameters#

Name	Type
`msg`	`Message`

Returns#

void

Implementation of#

IRenderMime.IRenderer.onAfterHide

Inherited from#

Widget.onAfterHide

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:342

`onAfterShow`#

Protected onAfterShow(msg): void

A message handler invoked on an 'after-show' message.

Notes#

The default implementation of this handler is a no-op.

Parameters#

Name	Type
`msg`	`Message`

Returns#

void

Implementation of#

IRenderMime.IRenderer.onAfterShow

Inherited from#

Widget.onAfterShow

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:328

`onBeforeAttach`#

Protected onBeforeAttach(msg): void

A message handler invoked on a 'before-attach' message.

Notes#

The default implementation of this handler is a no-op.

Parameters#

Name	Type
`msg`	`Message`

Returns#

void

Implementation of#

IRenderMime.IRenderer.onBeforeAttach

Inherited from#

Widget.onBeforeAttach

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:349

`onBeforeDetach`#

Protected onBeforeDetach(msg): void

A message handler invoked on a 'before-detach' message.

Notes#

The default implementation of this handler is a no-op.

Parameters#

Name	Type
`msg`	`Message`

Returns#

void

Implementation of#

IRenderMime.IRenderer.onBeforeDetach

Inherited from#

Widget.onBeforeDetach

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:363

`onBeforeHide`#

Protected onBeforeHide(msg): void

A message handler invoked on a 'before-hide' message.

Notes#

The default implementation of this handler is a no-op.

Parameters#

Name	Type
`msg`	`Message`

Returns#

void

Implementation of#

IRenderMime.IRenderer.onBeforeHide

Inherited from#

Widget.onBeforeHide

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:335

`onBeforeShow`#

Protected onBeforeShow(msg): void

A message handler invoked on a 'before-show' message.

Notes#

The default implementation of this handler is a no-op.

Parameters#

Name	Type
`msg`	`Message`

Returns#

void

Implementation of#

IRenderMime.IRenderer.onBeforeShow

Inherited from#

Widget.onBeforeShow

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:321

`onChildAdded`#

Protected onChildAdded(msg): void

A message handler invoked on a 'child-added' message.

Notes#

The default implementation of this handler is a no-op.

Parameters#

Name	Type
`msg`	`ChildMessage`

Returns#

void

Implementation of#

IRenderMime.IRenderer.onChildAdded

Inherited from#

Widget.onChildAdded

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:377

`onChildRemoved`#

Protected onChildRemoved(msg): void

A message handler invoked on a 'child-removed' message.

Notes#

The default implementation of this handler is a no-op.

Parameters#

Name	Type
`msg`	`ChildMessage`

Returns#

void

Implementation of#

IRenderMime.IRenderer.onChildRemoved

Inherited from#

Widget.onChildRemoved

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:384

`onCloseRequest`#

Protected onCloseRequest(msg): void

A message handler invoked on a 'close-request' message.

Notes#

The default implementation unparents or detaches the widget.

Parameters#

Name	Type
`msg`	`Message`

Returns#

void

Implementation of#

IRenderMime.IRenderer.onCloseRequest

Inherited from#

Widget.onCloseRequest

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:286

`onFitRequest`#

Protected onFitRequest(msg): void

A message handler invoked on a 'fit-request' message.

Notes#

The default implementation of this handler is a no-op.

Parameters#

Name	Type
`msg`	`Message`

Returns#

void

Implementation of#

IRenderMime.IRenderer.onFitRequest

Inherited from#

Widget.onFitRequest

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:307

`onResize`#

Protected onResize(msg): void

A message handler invoked on a 'resize' message.

Notes#

The default implementation of this handler is a no-op.

Parameters#

Name	Type
`msg`	`ResizeMessage`

Returns#

void

Implementation of#

IRenderMime.IRenderer.onResize

Inherited from#

Widget.onResize

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:293

`onUpdateRequest`#

Protected onUpdateRequest(msg): void

A message handler invoked on an 'update-request' message.

Notes#

The default implementation of this handler is a no-op.

Parameters#

Name	Type
`msg`	`Message`

Returns#

void

Implementation of#

IRenderMime.IRenderer.onUpdateRequest

Inherited from#

Widget.onUpdateRequest

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:300

`processMessage`#

processMessage(msg): void

Process a message sent to the widget.

Parameters#

Name	Type	Description
`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

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:268

`removeClass`#

removeClass(name): void

Remove a class name from the widget’s DOM node.

Parameters#

Name	Type	Description
`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

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:168

`renderModel`#

renderModel(model): Promise<void>

Render the IFrame into this widget’s node.

Parameters#

Name	Type
`model`	`IMimeModel`

Returns#

Promise<void>

Implementation of#

IRenderMime.IRenderer.renderModel

Defined in#

packages/iframe-extension/src/index.ts:44

`setFlag`#

setFlag(flag): void

Set the given widget flag.

Notes#

This will not typically be called directly by user code.

Parameters#

Name	Type
`flag`	`Flag`

Returns#

void

Implementation of#

IRenderMime.IRenderer.setFlag

Inherited from#

Widget.setFlag

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:252

`setHidden`#

setHidden(hidden): void

Show or hide the widget according to a boolean value.

Parameters#

Name	Type	Description
`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

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:238

`show`#

show(): void

Show the widget and make it visible to its parent widget.

Notes#

This causes the 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

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:220

`testFlag`#

testFlag(flag): boolean

Test whether the given widget flag is set.

Notes#

This will not typically be called directly by user code.

Parameters#

Name	Type
`flag`	`Flag`

Returns#

boolean

Implementation of#

IRenderMime.IRenderer.testFlag

Inherited from#

Widget.testFlag

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:245

`toggleClass`#

toggleClass(name, force?): boolean

Toggle a class name on the widget’s DOM node.

Parameters#

Name	Type	Description
`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

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:183

`update`#

update(): void

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

Defined in#

node_modules/@lumino/widgets/types/widget.d.ts:190

Class: RenderedIFrame#

Hierarchy#

Implements#

Constructors#

constructor#

Overrides#

Defined in#

Properties#

_iframe#

Defined in#

node#

Implementation of#

Inherited from#

Defined in#

Accessors#

dataset#

Returns#

Implementation of#

Inherited from#

Defined in#

disposed#

Returns#

Implementation of#

Inherited from#

Defined in#

hiddenMode#

Returns#

Implementation of#

Inherited from#

Defined in#

Parameters#

Returns#

Implementation of#

Inherited from#

Defined in#

id#

Returns#

Implementation of#

Inherited from#

Defined in#

Parameters#

Returns#

Implementation of#

Inherited from#

Defined in#

isAttached#

Returns#

Implementation of#

Inherited from#

Defined in#

isDisposed#

Returns#

Implementation of#

Inherited from#

Defined in#

isHidden#

Returns#

Implementation of#

Inherited from#

Defined in#

isVisible#

Notes#

Returns#

Implementation of#

Inherited from#

Defined in#

layout#

Returns#

Implementation of#

Inherited from#

Defined in#

Notes#

Parameters#

Returns#

Implementation of#

Inherited from#

Defined in#

parent#

Returns#

Implementation of#

Class: `RenderedIFrame`#

`constructor`#

`_iframe`#

`node`#

`dataset`#

`disposed`#

`hiddenMode`#

`id`#

`isAttached`#

`isDisposed`#

`isHidden`#

`isVisible`#

`layout`#

`parent`#

`title`#

`activate`#

`addClass`#

`children`#

`clearFlag`#

`close`#

`contains`#

`dispose`#

`fit`#

`hasClass`#

`hide`#