Class IFrame

A Lumino widget which wraps an IFrame.

Hierarchy

Widget
- IFrame

Constructors

constructor

new IFrame(options?: IFrame.IOptions): IFrame
Create a new IFrame widget.
Parameters
- options: IFrame.IOptions = {}
Returns IFrame
Overrides Widget.constructor
- Defined in packages/ui-components/src/components/iframe.ts:13

Properties

`Readonly`node

node: HTMLElement

Get the DOM node owned by the widget.

Accessors

dataset

get dataset(): DOMStringMap
The dataset for the widget's DOM node.

Returns DOMStringMap
Inherited from Widget.dataset
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:88

disposed

get disposed(): ISignal<this, void>
A signal emitted when the widget is disposed.

Returns ISignal<this, void>
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
Inherited from Widget.hiddenMode
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:92
set hiddenMode(value: HiddenMode): void
Set the method for hiding the widget.
Parameters
- value: HiddenMode
Returns void
Inherited from Widget.hiddenMode
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:96

id

get id(): string
Get the id of the widget's DOM node.

Returns string
Inherited from Widget.id
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:80
set id(value: string): void
Set the id of the widget's DOM node.
Parameters
- value: string
Returns void
Inherited from Widget.id
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:84

isAttached

get isAttached(): boolean
Test whether the widget's node is attached to the DOM.

Returns boolean
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
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.

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
Inherited from Widget.isHidden
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:53

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.

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
Inherited from Widget.isVisible
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:64

layout

get layout(): null | Layout
Get the layout for the widget.

Returns null | Layout
Inherited from Widget.layout
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:116
set layout(value: null | Layout): 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
- value: null | Layout
Returns void
Inherited from Widget.layout
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:126

loading

get loading(): IFrame.Loading
Loading for the iFrame

Notes
By default, 'eager' loading is chosen

For more information, see https://developer.mozilla.org/en-US/docs/Web/API/HTMLIFrameElement/loading

Returns IFrame.Loading
- Defined in packages/ui-components/src/components/iframe.ts:50
set loading(value: IFrame.Loading): void
Parameters
- value: IFrame.Loading
Returns void
- Defined in packages/ui-components/src/components/iframe.ts:53

parent

get parent(): null | Widget
Get the parent of the widget.

Returns null | Widget
Inherited from Widget.parent
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:100
set parent(value: null | Widget): 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
- value: null | Widget
Returns void
Inherited from Widget.parent
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:112

referrerPolicy

get referrerPolicy(): IFrame.ReferrerPolicy
Referrer policy for the iframe.

Notes
By default, no-referrer is chosen.

For more information, see https://developer.mozilla.org/en-US/docs/Web/API/HTMLIFrameElement/referrerPolicy

Returns IFrame.ReferrerPolicy
- Defined in packages/ui-components/src/components/iframe.ts:29
set referrerPolicy(value: IFrame.ReferrerPolicy): void
Parameters
- value: IFrame.ReferrerPolicy
Returns void
- Defined in packages/ui-components/src/components/iframe.ts:32

sandbox

get sandbox(): IFrame.SandboxExceptions[]
Exceptions to the sandboxing.

Notes
By default, all sandboxing security policies are enabled. This setting allows the user to selectively disable these policies. This should be done with care, as it can introduce security risks, and possibly allow malicious sites to execute code in a JupyterLab session.

For more information, see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe

Returns IFrame.SandboxExceptions[]
- Defined in packages/ui-components/src/components/iframe.ts:75
set sandbox(values: IFrame.SandboxExceptions[]): void
Parameters
- values: IFrame.SandboxExceptions[]
Returns void
- Defined in packages/ui-components/src/components/iframe.ts:78

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>
Inherited from Widget.title
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:76

url

get url(): string
The url of the IFrame.

Returns string
- Defined in packages/ui-components/src/components/iframe.ts:88
set url(url: string): void
Parameters
- url: string
Returns void
- Defined in packages/ui-components/src/components/iframe.ts:91

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
Inherited from Widget.activate
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:211

addClass

addClass(name: string): void
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
Inherited from Widget.addClass
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:164

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.
Inherited from Widget.children
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:137

clearFlag

clearFlag(flag: Flag): void
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
Inherited from Widget.clearFlag
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:275

close

close(): void
Send a 'close-request' message to the widget.

Notes
This is a simple convenience method for sending the message.

Returns void
Inherited from Widget.close
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:218

contains

contains(widget: Widget): boolean
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.
Inherited from Widget.contains
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:145

dispose

dispose(): void
Dispose of the widget and its descendant widgets.

Notes
It is unsafe to use the widget after it has been disposed.

All calls made to this method after the first are a no-op.

Returns void
Inherited from Widget.dispose
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:29

fit

fit(): void
Post a 'fit-request' message to the widget.

Notes
This is a simple convenience method for posting the message.

Returns void
Inherited from Widget.fit
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:204

hasClass

hasClass(name: string): boolean
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.
Inherited from Widget.hasClass
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:153

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
Inherited from Widget.hide
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:236

`Protected`notifyLayout

notifyLayout(msg: Message): void
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
Inherited from Widget.notifyLayout
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:295

`Protected`onActivateRequest

onActivateRequest(msg: Message): void
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
Inherited from Widget.onActivateRequest
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:330

`Protected`onAfterAttach

onAfterAttach(msg: Message): void
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
Inherited from Widget.onAfterAttach
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:372

`Protected`onAfterDetach

onAfterDetach(msg: Message): void
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
Inherited from Widget.onAfterDetach
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:386

`Protected`onAfterHide

onAfterHide(msg: Message): void
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
Inherited from Widget.onAfterHide
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:358

`Protected`onAfterShow

onAfterShow(msg: Message): void
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
Inherited from Widget.onAfterShow
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:344

`Protected`onBeforeAttach

onBeforeAttach(msg: Message): void
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
Inherited from Widget.onBeforeAttach
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:365

`Protected`onBeforeDetach

onBeforeDetach(msg: Message): void
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
Inherited from Widget.onBeforeDetach
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:379

`Protected`onBeforeHide

onBeforeHide(msg: Message): void
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
Inherited from Widget.onBeforeHide
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:351

`Protected`onBeforeShow

onBeforeShow(msg: Message): void
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
Inherited from Widget.onBeforeShow
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:337

`Protected`onChildAdded

onChildAdded(msg: ChildMessage): void
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
Inherited from Widget.onChildAdded
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:393

`Protected`onChildRemoved

onChildRemoved(msg: ChildMessage): void
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
Inherited from Widget.onChildRemoved
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:400

`Protected`onCloseRequest

onCloseRequest(msg: Message): void
A message handler invoked on a 'close-request' message.

Notes
The default implementation unparents or detaches the widget.
Parameters
- msg: Message
Returns void
Inherited from Widget.onCloseRequest
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:302

`Protected`onFitRequest

onFitRequest(msg: Message): void
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
Inherited from Widget.onFitRequest
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:323

`Protected`onResize

onResize(msg: ResizeMessage): void
A message handler invoked on a 'resize' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: ResizeMessage
Returns void
Inherited from Widget.onResize
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:309

`Protected`onUpdateRequest

onUpdateRequest(msg: Message): void
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
Inherited from Widget.onUpdateRequest
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:316

processMessage

processMessage(msg: Message): void
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
Inherited from Widget.processMessage
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:284

removeClass

removeClass(name: string): void
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
Inherited from Widget.removeClass
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:175

setFlag

setFlag(flag: Flag): void
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
Inherited from Widget.setFlag
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:265

setHidden

setHidden(hidden: boolean): void
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
Inherited from Widget.setHidden
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:245

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
Inherited from Widget.show
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:227

testFlag

testFlag(flag: Flag): boolean
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
Inherited from Widget.testFlag
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:255

toggleClass

toggleClass(name: string, force?: boolean): boolean
Toggle a class name on the widget's DOM node.
Parameters
- name: string
  The class name to toggle on the node.
- Optionalforce: 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.
Inherited from Widget.toggleClass
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:190

update

update(): void
Post an 'update-request' message to the widget.

Notes
This is a simple convenience method for posting the message.

Returns void
Inherited from Widget.update
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:197

Class IFrame

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns IFrame

Properties

Readonlynode

Accessors

dataset

Returns DOMStringMap

disposed

Returns ISignal<this, void>

hiddenMode

Returns HiddenMode

Parameters

Returns void

id

Returns string

Parameters

Returns void

isAttached

Returns boolean

isDisposed

Returns boolean

isHidden

Notes

Returns boolean

isVisible

Notes

Returns boolean

layout

Returns null | Layout

Notes

Parameters

Returns void

loading

Notes

Returns IFrame.Loading

Parameters

Returns void

parent

Returns null | Widget

Notes

Parameters

Returns void

referrerPolicy

Notes

Returns IFrame.ReferrerPolicy

Parameters

Returns void

sandbox

Notes

Returns IFrame.SandboxExceptions[]

Parameters

Returns void

title

Notes

Returns Title<Widget>

url

Returns string

Parameters

Returns void

Methods

activate

Notes

Returns void

addClass

Parameters

Notes

Returns void

children

Returns IterableIterator<Widget>

Notes

clearFlag

`Readonly`node

`Protected`notifyLayout

`Protected`onActivateRequest

`Protected`onAfterAttach

`Protected`onAfterDetach

`Protected`onAfterHide

`Protected`onAfterShow

`Protected`onBeforeAttach

`Protected`onBeforeDetach

`Protected`onBeforeHide

`Protected`onBeforeShow

`Protected`onChildAdded

`Protected`onChildRemoved

`Protected`onCloseRequest