# pane.Pane

- **Module:** pane
- **Package:** @libtmux/libtmux
- **Language:** TypeScript
- **Kind:** class
- **Source:** https://github.com/libtmux/libtmux-ts/blob/2cb93308200da38a26b59876618116850f110607/packages/libtmux/src/pane.ts#L77
- **Page:** https://libtmux.org/reference/ts/pane-pane/

## Members

- `paneBrand` (attribute)
- `server` (attribute) — The server this pane belongs to.
- `constructor` (method)
- `window` (method) — The window placement containing this pane.
- `session` (method) — The session containing this pane.
- `showHooks` (method) — Read hooks set on this pane itself.
- `setHook` (method) — Bind a tmux command to a pane-scoped hook.
- `unsetHook` (method) — Remove every command bound to a pane-scoped hook.
- `showOptions` (method) — Every option set on this pane itself, not the ones it inherits.
- `showResolvedOptions` (method) — The option values that govern this pane, own and inherited together.
- `setOption` (method) — Set an option on this pane.
- `unsetOption` (method) — Remove an option from this pane.
- `split` (method) — Split this pane and resolve the created pane.
- `kill` (method) — Destroy this pane.
- `killIfWindowUnshared` (method) — Destroy this pane only if its window has one placement.
- `plan` (method) — The same mutations, described instead of run.
- `sendKeys` (method) — Send keys to this pane, following them with Enter unless told not to.
- `capture` (method) — Capture this pane's contents as lines.
- `clearHistory` (method) — Discard this pane's scrollback history.
- `resize` (method) — Resize this pane; tmux ignores a dimension its layout cannot honour.
- `swapWith` (method) — Exchange positions with another pane.
- `select` (method) — Make this pane active in its window.
- `setTitle` (method) — Set this pane's title.
- `pasteBuffer` (method) — Paste a named buffer into this pane, as if it were typed.
- `refreshed` (method) — This pane, read again at a new instant.
- `displayMessage` (method) — Expand a tmux format string against this pane.
- `respawn` (method) — Restart this pane's command in place.
- `pipeTo` (method) — Send everything this pane writes to a shell command as well as its screen.
- `breakOut` (method) — Move this pane out into a window of its own, in the session it is in.
- `joinTo` (method) — Move this pane into another window as a split.
- `enterCopyMode` (method) — Enter this pane's copy mode.
- `exitCopyMode` (method) — Leave this pane's copy mode.
- `displayPopup` (method) — Open a popup over the client showing this pane.
- `displayMenu` (method) — Show a menu over the client showing this pane.
- `chooseTree` (method) — Open the interactive session and window chooser in this pane.
- `chooseBuffer` (method) — Open the interactive buffer chooser in this pane.
- `findWindow` (method) — Search windows interactively from this pane.
- `sendPrefix` (method) — Send the configured prefix key to this pane.
- `customizeMode` (method) — Open tmux's interactive option editor in this pane.
- `cmd` (method) — Run a tmux command this package does not model, addressed at this pane.
- `equals` (method) — Whether `other` is this same pane on this same server.
- `sameTmuxIdAs` (method) — Whether `other` carries the same `%n`, wherever it came from.
- `toString` (method) — How this handle renders in a log line, a template literal, or an error.
- `format` (property) — The raw tmux format row, addressed by tmux's own token names.
