Core LibrarystableAPI Reference

Choose documentation 3

stable

Current version

stable
English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Python API

method libtmux stable

Window.select_layout

Select layout for window.

Source and package
Qualified name
libtmux.Window.select_layout
Module
libtmux
Declared in
Window
Package
libtmux
Source
src/libtmux/window.py
Other languages
PowerShell Julia RubyLuaTypeScriptRustGoJavaC#C++Swift Kotlin Scala F#
select_layout ( self, layout: str | None = None, spread: bool | None = None, next_layout: bool | None = None, previous_layout: bool | None = None, ) → Window

Description#

Wrapper for $ tmux select-layout <layout>.

Parameters
  • layout (str | None) # – String of the layout, 'even-horizontal', 'tiled', etc. Entering None (leaving this blank) is same as select-layout with no layout. In recent tmux versions, it picks the most recently set layout. 'even-horizontal' Panes are spread out evenly from left to right across the window. 'even-vertical' Panes are spread evenly from top to bottom. 'main-horizontal' A large (main) pane is shown at the top of the window and the remaining panes are spread from left to right in the leftover space at the bottom. 'main-vertical' Similar to main-horizontal but the large pane is placed on the left and the others spread from top to bottom along the right. 'tiled' Panes are spread out as evenly as possible over the window in both rows and columns. 'custom' Custom dimensions (see tmux(1) manpages).

  • spread (bool | None) # – Spread panes out evenly (-E flag). added 0.56

  • next_layout (bool | None) # – Move to the next layout (-n flag). added 0.56

  • previous_layout (bool | None) # – Move to the previous layout (-p flag). added 0.56

Returns

Window Self, for method chaining.

Raises

tmux command select-layout

In other ports Set a window's pane layout
Esc

Type to search.

Reference preview Open reference