@jupyterlite

***`

@jupyterlite / @jupyterlite/application / ISingleWidgetShell

接口：ISingleWidgetShell#

定义于：packages/application/src/singleWidgetShell.ts:19

单部件应用壳接口。

扩展#

属性#

node#

readonly **node**: HTMLElement

定义于：node_modules/@lumino/widgets/types/widget.d.ts:37

获取部件拥有的 DOM 节点。

继承自#

SingleWidgetShell.node

访问器#

currentChanged#

获取签名#

**get** **currentChanged**(): ISignal<ISingleWidgetShell, IChangedArgs<Widget>>

定义于：packages/application/src/singleWidgetShell.ts:46

当当前部件更改时发出的信号。

返回#

ISignal<ISingleWidgetShell, IChangedArgs<Widget>>

继承自#

SingleWidgetShell.currentChanged

`***

currentWidget#

获取签名#

get currentWidget(): null | Widget

定义于：packages/application/src/singleWidgetShell.ts:53

壳主区域中的当前部件。

返回#

null | Widget

继承自#

SingleWidgetShell.currentWidget

***`

dataset#

获取签名#

**get** **dataset**(): DOMStringMap

定义于：node_modules/@lumino/widgets/types/widget.d.ts:88

部件 DOM 节点的数据集。

返回#

DOMStringMap

继承自#

SingleWidgetShell.dataset

`***

disposed#

获取签名#

get disposed(): ISignal<this, void>

定义于：node_modules/@lumino/widgets/types/widget.d.ts:33

部件被处置时发出的信号。

返回#

ISignal<this, void>

继承自#

SingleWidgetShell.disposed

***`

hiddenMode#

获取签名#

**get** **hiddenMode**(): HiddenMode

定义于：node_modules/@lumino/widgets/types/widget.d.ts:92

获取隐藏部件的方法。

返回#

HiddenMode

设置签名#

**set** **hiddenMode**(value): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:96

设置隐藏部件的方法。

参数#
value#

HiddenMode

返回#

void

继承自#

SingleWidgetShell.hiddenMode

`***

id#

获取签名#

get id(): string

定义于：node_modules/@lumino/widgets/types/widget.d.ts:80

获取部件 DOM 节点的 ID。

返回#

string

设置签名#

set id(value): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:84

设置部件 DOM 节点的 ID。

参数#
value#

string

返回#

void

继承自#

SingleWidgetShell.id

***`

isAttached#

获取签名#

**get** **isAttached**(): boolean

定义于：node_modules/@lumino/widgets/types/widget.d.ts:45

测试部件节点是否已附加到 DOM。

返回#

boolean

继承自#

SingleWidgetShell.isAttached

`***

isDisposed#

获取签名#

get isDisposed(): boolean

定义于：node_modules/@lumino/widgets/types/widget.d.ts:41

测试部件是否已被处置。

返回#

boolean

继承自#

SingleWidgetShell.isDisposed

***`

isHidden#

获取签名#

**get** **isHidden**(): boolean

定义于：node_modules/@lumino/widgets/types/widget.d.ts:53

测试部件是否明确隐藏。

备注#

如果您想知道部件是否隐藏，您应该优先使用 !{@link isVisible} 而不是 {@link isHidden}，因为这不会测试部件是否因为其某个祖先被隐藏而隐藏。

返回#

boolean

继承自#

SingleWidgetShell.isHidden

`***

isVisible#

获取签名#

get isVisible(): boolean

定义于：node_modules/@lumino/widgets/types/widget.d.ts:64

测试部件是否可见。

备注#

当部件附加到 DOM，没有明确隐藏，并且没有明确隐藏的祖先时，部件是可见的。

自 2.7.0 版起，这不依赖于 Widget.Flag.IsVisible 标志。它递归检查所有父部件的可见性。

返回#

boolean

继承自#

SingleWidgetShell.isVisible

***`

layout#

获取签名#

**get** **layout**(): null | Layout

定义于：node_modules/@lumino/widgets/types/widget.d.ts:116

获取部件的布局。

返回#

null | Layout

设置签名#

**set** **layout**(value): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:126

设置部件的布局。

备注#

布局只能使用一次。首次分配后无法更改。

当部件被处置时，布局会自动处置。

参数#
value#

null | Layout

返回#

void

继承自#

SingleWidgetShell.layout

`***

parent#

获取签名#

get parent(): null | Widget

定义于：node_modules/@lumino/widgets/types/widget.d.ts:100

获取部件的父级。

返回#

null | Widget

设置签名#

set parent(value): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:112

设置部件的父级。

备注#

通常通过使用布局将子级添加到部件中，这意味着用户代码通常不会直接设置父部件。

部件将自动从其旧父级中移除。

如果父级没有有效更改，则此操作为空操作。

参数#
value#

null | Widget

返回#

void

继承自#

SingleWidgetShell.parent

***`

title#

获取签名#

**get** **title**(): Title<Widget>

定义于：node_modules/@lumino/widgets/types/widget.d.ts:76

部件的标题对象。

备注#

标题对象被某些容器部件用于在显示部件时同时显示标题，例如选项卡面板或侧边栏。

并非所有部件都会使用标题，因此它是按需创建的。

标题的 owner 属性设置为此部件。

返回#

Title<Widget>

继承自#

SingleWidgetShell.title

方法#

activate()#

**activate**(): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:211

向部件发布 'activate-request' 消息。

备注#

这只是发布消息的一个简单便利方法。

返回#

void

继承自#

SingleWidgetShell.activate

`***

activateById()#

activateById(id): void

定义于：packages/application/src/singleWidgetShell.ts:60

激活其区域中的部件。

参数#

id#

string

返回#

void

继承自#

SingleWidgetShell.activateById

***`

add()#

**add**(widget, area?, options?): void

定义于：packages/application/src/singleWidgetShell.ts:78

向应用程序壳添加部件。

参数#

widget#

部件

正在添加的部件。

area?#

"main"

部件应添加到壳中的可选区域。

options?#

IOpenOptions

可选打开选项。

返回#

void

继承自#

SingleWidgetShell.add

`***

addClass()#

addClass(name): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:164

向部件的 DOM 节点添加类名。

参数#

name#

string

要添加到节点的类名。

备注#

如果类名已添加到节点，则此操作为空操作。

类名不能包含空格。

返回#

void

继承自#

SingleWidgetShell.addClass

***`

children()#

**children**(): IterableIterator<Widget>

定义于：node_modules/@lumino/widgets/types/widget.d.ts:137

创建部件子级的迭代器。

返回#

IterableIterator<Widget>

部件子级的新迭代器。

备注#

部件必须具有填充的布局才能拥有子级。

如果未安装布局，则返回的迭代器将为空。

继承自#

SingleWidgetShell.children

`***

clearFlag()#

clearFlag(flag): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:275

清除给定的部件标志。

备注#

这通常不会由用户代码直接调用。

自 2.7.0 版起，Widget.Flag.IsVisible 已弃用。它将在未来的版本中移除。

参数#

flag#

Flag

返回#

void

继承自#

SingleWidgetShell.clearFlag

***`

close()#

**close**(): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:218

向部件发送 'close-request' 消息。

备注#

这只是发送消息的一个简单便利方法。

返回#

void

继承自#

SingleWidgetShell.close

`***

contains()#

contains(widget): boolean

定义于：node_modules/@lumino/widgets/types/widget.d.ts:145

测试部件是否为此部件的后代。

参数#

widget#

部件

感兴趣的后代部件。

返回#

boolean

如果部件是后代，则为 true，否则为 false。

继承自#

SingleWidgetShell.contains

***`

dispose()#

**dispose**(): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:29

处置部件及其后代部件。

备注#

处置后使用部件是不安全的。

第一次调用此方法后，所有后续调用都为空操作。

返回#

void

继承自#

SingleWidgetShell.dispose

`***

fit()#

fit(): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:204

向部件发布 'fit-request' 消息。

备注#

这只是发布消息的一个简单便利方法。

返回#

void

继承自#

SingleWidgetShell.fit

***`

hasClass()#

**hasClass**(name): boolean

定义于：node_modules/@lumino/widgets/types/widget.d.ts:153

测试部件的 DOM 节点是否具有给定的类名。

参数#

name#

string

感兴趣的类名。

返回#

boolean

如果节点具有该类，则为 true，否则为 false。

继承自#

SingleWidgetShell.hasClass

`***

hide()#

hide(): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:236

隐藏部件并使其对其父部件隐藏。

备注#

这会导致 isHidden 属性为 true。

如果部件已明确隐藏，则此操作为空操作。

返回#

void

继承自#

SingleWidgetShell.hide

***`

notifyLayout()#

protected **notifyLayout**(msg): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:295

调用部件布局的消息处理例程。

参数#

msg#

消息

要发送到布局的消息。

备注#

如果部件没有布局，则此操作为空操作。

这通常不会由用户代码直接调用。

返回#

void

继承自#

SingleWidgetShell.notifyLayout

`***

onActivateRequest()#

protected onActivateRequest(msg): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:330

在 'activate-request' 消息上调用的消息处理程序。

备注#

此处理程序的默认实现为空操作。

参数#

msg#

消息

返回#

void

继承自#

SingleWidgetShell.onActivateRequest

***`

onAfterAttach()#

protected **onAfterAttach**(msg): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:372

在 'after-attach' 消息上调用的消息处理程序。

备注#

此处理程序的默认实现为空操作。

参数#

msg#

消息

返回#

void

继承自#

SingleWidgetShell.onAfterAttach

`***

onAfterDetach()#

protected onAfterDetach(msg): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:386

在 'after-detach' 消息上调用的消息处理程序。

备注#

此处理程序的默认实现为空操作。

参数#

msg#

消息

返回#

void

继承自#

SingleWidgetShell.onAfterDetach

***`

onAfterHide()#

protected **onAfterHide**(msg): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:358

在 'after-hide' 消息上调用的消息处理程序。

备注#

此处理程序的默认实现为空操作。

参数#

msg#

消息

返回#

void

继承自#

SingleWidgetShell.onAfterHide

`***

onAfterShow()#

protected onAfterShow(msg): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:344

在 'after-show' 消息上调用的消息处理程序。

备注#

此处理程序的默认实现为空操作。

参数#

msg#

消息

返回#

void

继承自#

SingleWidgetShell.onAfterShow

***`

onBeforeAttach()#

protected **onBeforeAttach**(msg): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:365

在 'before-attach' 消息上调用的消息处理程序。

备注#

此处理程序的默认实现为空操作。

参数#

msg#

消息

返回#

void

继承自#

SingleWidgetShell.onBeforeAttach

`***

onBeforeDetach()#

protected onBeforeDetach(msg): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:379

在 'before-detach' 消息上调用的消息处理程序。

备注#

此处理程序的默认实现为空操作。

参数#

msg#

消息

返回#

void

继承自#

SingleWidgetShell.onBeforeDetach

***`

onBeforeHide()#

protected **onBeforeHide**(msg): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:351

在 'before-hide' 消息上调用的消息处理程序。

备注#

此处理程序的默认实现为空操作。

参数#

msg#

消息

返回#

void

继承自#

SingleWidgetShell.onBeforeHide

`***

onBeforeShow()#

protected onBeforeShow(msg): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:337

在 'before-show' 消息上调用的消息处理程序。

备注#

此处理程序的默认实现为空操作。

参数#

msg#

消息

返回#

void

继承自#

SingleWidgetShell.onBeforeShow

***`

onChildAdded()#

protected **onChildAdded**(msg): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:393

在 'child-added' 消息上调用的消息处理程序。

备注#

此处理程序的默认实现为空操作。

参数#

msg#

ChildMessage

返回#

void

继承自#

SingleWidgetShell.onChildAdded

`***

onChildRemoved()#

protected onChildRemoved(msg): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:400

在 'child-removed' 消息上调用的消息处理程序。

备注#

此处理程序的默认实现为空操作。

参数#

msg#

ChildMessage

返回#

void

继承自#

SingleWidgetShell.onChildRemoved

***`

onCloseRequest()#

protected **onCloseRequest**(msg): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:302

在 'close-request' 消息上调用的消息处理程序。

备注#

此处理程序的默认实现会解除部件的父级或分离部件。

参数#

msg#

消息

返回#

void

继承自#

SingleWidgetShell.onCloseRequest

`***

onFitRequest()#

protected onFitRequest(msg): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:323

在 'fit-request' 消息上调用的消息处理程序。

备注#

此处理程序的默认实现为空操作。

参数#

msg#

消息

返回#

void

继承自#

SingleWidgetShell.onFitRequest

***`

onResize()#

protected **onResize**(msg): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:309

在 'resize' 消息上调用的消息处理程序。

备注#

此处理程序的默认实现为空操作。

参数#

msg#

ResizeMessage

返回#

void

继承自#

SingleWidgetShell.onResize

`***

onUpdateRequest()#

protected onUpdateRequest(msg): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:316

在 'update-request' 消息上调用的消息处理程序。

备注#

此处理程序的默认实现为空操作。

参数#

msg#

消息

返回#

void

继承自#

SingleWidgetShell.onUpdateRequest

***`

processMessage()#

**processMessage**(msg): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:284

处理发送给部件的消息。

参数#

msg#

消息

发送给部件的消息。

备注#

子类可以根据需要重新实现此方法。

返回#

void

继承自#

SingleWidgetShell.processMessage

`***

removeClass()#

removeClass(name): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:175

从部件的 DOM 节点中移除类名。

参数#

name#

string

要从节点中移除的类名。

备注#

如果类名尚未添加到节点，则此操作为空操作。

类名不能包含空格。

返回#

void

继承自#

SingleWidgetShell.removeClass

***`

setFlag()#

**setFlag**(flag): void

定义于：node_modules/@lumino/widgets/types/widget.d.ts:265

设置给定的部件标志。

备注#

这通常不会由用户代码直接调用。

自 2.7.0 版起，Widget.Flag.IsVisible 已弃用。它将在未来的版本中移除。

参数#

flag#

Flag

返回#

void

继承自#

SingleWidgetShell.setFlag

`***

setHidden()#

setHidden(hidden): void

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

根据布尔值显示或隐藏小部件。

参数#

hidden#

boolean

true 用于隐藏小部件，false 用于显示它。

备注#

这是 hide() 和 show() 的便捷方法。

返回#

void

继承自#

SingleWidgetShell.setHidden

***`

show()#

**show**(): void

定义于: node_modules/@lumino/widgets/types/widget.d.ts:227

显示小部件并使其对其父小部件可见。

备注#

这会导致 isHidden 属性为 false。

如果小部件未明确隐藏，则这是一个无操作。

返回#

void

继承自#

SingleWidgetShell.show

`***

testFlag()#

testFlag(flag): boolean

定义于: node_modules/@lumino/widgets/types/widget.d.ts:255

测试是否设置了给定的小部件标志。

备注#

这通常不会由用户代码直接调用。

自 2.7.0 版起，Widget.Flag.IsVisible 已弃用。它将在未来的版本中移除。

参数#

flag#

Flag

返回#

boolean

继承自#

SingleWidgetShell.testFlag

***`

toggleClass()#

**toggleClass**(name, force?): boolean

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

在小部件的 DOM 节点上切换类名。

参数#

name#

string

要在节点上切换的类名。

force?#

boolean

是否强制添加类 (true) 或强制移除类 (false)。如果未提供，将根据类的当前状态切换其存在。

返回#

boolean

如果类现在存在则为 true，否则为 false。

备注#

类名不能包含空格。

继承自#

SingleWidgetShell.toggleClass

`***

update()#

update(): void

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

向小部件发布 'update-request' 消息。

备注#

这只是发布消息的一个简单便利方法。

返回#

void

继承自#

SingleWidgetShell.update

***`

widgets()#

**widgets**(area): IterableIterator\<Widget`>

定义于: packages/application/src/singleWidgetShell.ts:103

返回给定区域的小部件列表。

参数#

area#

"main"

区域

返回#

IterableIterator<Widget>

继承自#

SingleWidgetShell.widgets

本页内容
在 GitHub 上编辑

此页面