Skip to content

tes3uiScrollPane⚓︎

A structure containing properties specific to scroll panes.

This type inherits the following: tes3uiWidget

Properties⚓︎

contentPane⚓︎

Read-only. The content element of this pane.

Returns:


element⚓︎

Access back to the element this widget interface is for.

Returns:


positionX⚓︎

The horizontal scroll offset in pixels.

Returns:

  • result (number)

positionY⚓︎

The vertical scroll offset in pixels.

Returns:

  • result (number)
Example: An example of updating the position of a scroll pane widget.
--Updating position of scroll panes:
---@type tes3uiElement
local scrollpane -- Created somewhere before

scrollpane.widget.positionY = 30

-- This will update the position of the scrollpane
scrollpane:getTopLevelMenu():updateLayout()

scrollbarVisible⚓︎

If true, the scrollbar will be visible.

Returns:

  • result (boolean)

Methods⚓︎

contentsChanged⚓︎

Updates the scrollbar slider and scrollbar limits after adding or removing elements to the content container. Because content size depends on layout, this must be run after calling updateLayout on the widget element. Only required if the content size changes.

myObject:contentsChanged()