Skip to content

pane:get_dimensions()

Since: Version 20201031-154415-9614e117

The functionality described in this section requires version 20201031-154415-9614e117 of wezterm, or a more recent version.

Returns a lua representation of the RenderableDimensions struct that identifies the dimensions and position of the viewport as well as the scrollback for the pane.

It has the following fields:

  • cols the number of columns
  • viewport_rows the number of vertical cells in the visible portion of the window
  • scrollback_rows the total number of lines in the scrollback and viewport
  • physical_top the top of the physical non-scrollback screen expressed as a stable index.
  • scrollback_top the top of the scrollback; the earliest row remembered by wezterm.