Class WindowedList<T, U>

Windowed list widget

Type Parameters

T extends WindowedList.IModel = WindowedList.IModel
U = any

Hierarchy (View Summary)

Widget
- WindowedList
  - StaticNotebook

Constructors

constructor

new WindowedList<
    T extends WindowedList.IModel<any> = WindowedList.IModel<any>,
    U = any,
>(
    options: WindowedList.IOptions<T, U>,
): WindowedList<T, U>
Constructor
Type Parameters
- T extends WindowedList.IModel<any> = WindowedList.IModel<any>
- U = any
Parameters
- options: WindowedList.IOptions<T, U>
  Constructor options
Returns WindowedList<T, U>
Overrides Widget.constructor
- Defined in packages/ui-components/src/components/windowedlist.ts:859

Properties

`Protected`_viewModel

_viewModel: T

`Protected`jumped

jumped: Signal<WindowedList<T, U>, number> = ...

A signal that emits the index when the virtual scrollbar jumps to an item.

`Readonly`node

node: HTMLElement

Get the DOM node owned by the widget.

`Protected`renderer

renderer: WindowedList.IRenderer<U>

The renderer for this windowed list. Set at instantiation.

`Static` `Readonly`DEFAULT_WIDGET_SIZE

DEFAULT_WIDGET_SIZE: 50

Default widget size

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

isParentHidden

get isParentHidden(): boolean
Whether the parent is hidden or not.

This should be set externally if a container is hidden to stop updating the widget size when hidden.

Returns boolean
- Defined in packages/ui-components/src/components/windowedlist.ts:920
set isParentHidden(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in packages/ui-components/src/components/windowedlist.ts:923

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(): WindowedLayout
Widget layout

Returns WindowedLayout
Overrides Widget.layout
- Defined in packages/ui-components/src/components/windowedlist.ts:930

outerNode

get outerNode(): HTMLElement
The outer container of the windowed list.

Returns HTMLElement
- Defined in packages/ui-components/src/components/windowedlist.ts:937

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

scrollbar

get scrollbar(): boolean
Flag to enable virtual scrollbar.

Returns boolean
- Defined in packages/ui-components/src/components/windowedlist.ts:951
set scrollbar(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in packages/ui-components/src/components/windowedlist.ts:954

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

`Protected`viewModel

get viewModel(): T
Windowed list view model

Returns T
- Defined in packages/ui-components/src/components/windowedlist.ts:972

viewportNode

get viewportNode(): HTMLElement
Viewport

Returns HTMLElement
- Defined in packages/ui-components/src/components/windowedlist.ts:944

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 the windowed list.

Returns void
Overrides Widget.dispose
- Defined in packages/ui-components/src/components/windowedlist.ts:979

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

handleEvent

handleEvent(event: Event): void
Callback on event.
Parameters
- event: Event
  Event
Returns void
- Defined in packages/ui-components/src/components/windowedlist.ts:989

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.
Parameters
- msg: Message
Returns void
Overrides Widget.onAfterAttach
- Defined in packages/ui-components/src/components/windowedlist.ts:1114

`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 an 'before-detach' message.
Parameters
- msg: Message
Returns void
Overrides Widget.onBeforeDetach
- Defined in packages/ui-components/src/components/windowedlist.ts:1134

`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 an 'resize-request' message.
Parameters
- msg: ResizeMessage
Returns void
Overrides Widget.onResize
- Defined in packages/ui-components/src/components/windowedlist.ts:1188

`Protected`onScroll

onScroll(event: Event): void
Callback on scroll event
Parameters
- event: Event
  Scroll event
Returns void
- Defined in packages/ui-components/src/components/windowedlist.ts:1146

`Protected`onStateChanged

onStateChanged(
model: WindowedList.IModel<any>,
changes: IChangedArgs<number | boolean, number | boolean, string>,
): void
Callback on view model change
Parameters
- model: WindowedList.IModel<any>
  Windowed list model
- changes: IChangedArgs<number | boolean, number | boolean, string>
  Change
Returns void
- Defined in packages/ui-components/src/components/windowedlist.ts:1205

`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
Overrides Widget.onUpdateRequest
- Defined in packages/ui-components/src/components/windowedlist.ts:1238

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

scrollTo

scrollTo(scrollOffset: number): void
Scroll to the specified offset scrollTop.
Parameters
- scrollOffset: number
  Offset to scroll
Returns void
Deprecated
since v4 This is an internal helper. Prefer calling scrollToItem.
- Defined in packages/ui-components/src/components/windowedlist.ts:1014

scrollToItem

scrollToItem(
    index: number,
    align?: ScrollToAlign,
    margin?: number,
    alignPreference?: BaseScrollToAlignment,
): Promise<void>
Scroll to the specified item.

By default, the list will scroll as little as possible to ensure the item is fully visible (auto). You can control the alignment of the item though by specifying a second alignment parameter. Acceptable values are:

auto - Automatically align with the top or bottom minimising the amount scrolled, If alignPreference is given, follow such preferred alignment. If item is smaller than the viewport and fully visible, do not scroll at all. smart - If the item is significantly visible, don't scroll at all (regardless of whether it fits in the viewport). If the item is less than one viewport away, scroll so that it becomes fully visible (following the auto heuristics). If the item is more than one viewport away, scroll so that it is centered within the viewport (center if smaller than viewport, top-center otherwise). center - Align the middle of the item with the middle of the viewport (it only works well for items smaller than the viewport). top-center - Align the top of the item with the middle of the viewport (works well for items larger than the viewport). end - Align the bottom of the item to the bottom of the list. start - Align the top of item to the top of the list.
Parameters
- index: number
  Item index to scroll to
- align: ScrollToAlign = 'auto'
  Type of alignment
- margin: number = 0.25
  In 'smart' mode the viewport proportion to add
- OptionalalignPreference: BaseScrollToAlignment
  Allows to override the alignment of item when the auto heuristic decides that the item needs to be scrolled into view.
Returns Promise<void>
- Defined in packages/ui-components/src/components/windowedlist.ts:1053

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 WindowedList<T, U>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns WindowedList<T, U>

Properties

Protected_viewModel

Protectedjumped

Readonlynode

Protectedrenderer

Static ReadonlyDEFAULT_WIDGET_SIZE

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

isParentHidden

Returns boolean

Parameters

Returns void

isVisible

Notes

Returns boolean

layout

Returns WindowedLayout

outerNode

Returns HTMLElement

parent

Returns null | Widget

Notes

Parameters

Returns void

scrollbar

Returns boolean

Parameters

Returns void

title

Notes

Returns Title<Widget>

ProtectedviewModel

Returns T

viewportNode

Returns HTMLElement

Methods

activate

Notes

Returns void

addClass

Parameters

Notes

Returns void

children

Returns IterableIterator<Widget>

Notes

clearFlag

Notes

Parameters

`Protected`_viewModel

`Protected`jumped

`Readonly`node

`Protected`renderer

`Static` `Readonly`DEFAULT_WIDGET_SIZE

`Protected`viewModel

`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