Arrangement

Provides access to saved arrangements.

class Arrangement

Provides access to saved arrangements.

static async_list(connection: iterm2.connection.Connection) → List[str]

Fetch a list of saved arrangements.

NOTE: This requires iTerm2 version 3.4.0 or later.

Parameters

connection (Connection) – The name of the arrangement.

Returns

A list of strings giving saved arrangement names.

Throws

SavedArrangementException

static async_restore(connection: iterm2.connection.Connection, name: str)

Restore a saved window arrangement.

Parameters
  • connection (Connection) – The name of the arrangement.

  • name (str) – The name of the arrangement to restore.

Throws

SavedArrangementException

static async_save(connection: iterm2.connection.Connection, name: str)

Save all windows as a new arrangement.

Replaces the arrangement with the given name if it already exists.

Parameters
  • connection (Connection) – The name of the arrangement.

  • name (str) – The name of the arrangement.

Throws

SavedArrangementException

class SavedArrangementException

A problem was encountered while saving or restoring an arrangement.


Indices and tables