<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/pane/get_dimensions.md - fork/wezterm @ main</title>
<meta name="description" content="docs/config/lua/pane/get_dimensions.md in fork/wezterm at main.">
<meta property="og:title" content="docs/config/lua/pane/get_dimensions.md - fork/wezterm @ main">
<meta property="og:description" content="docs/config/lua/pane/get_dimensions.md in fork/wezterm at main.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="main" data-tip="9c883a71b8b60323047762d8b47ae44f101773c6">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/wezterm</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/wezterm</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Wez Furlong</span><span class="commit-message" data-commit="40081cb5737da32058a3c87e14b84d8f2bfefdc4">docs: update a bunch of since lines to new macro</span><span class="snapshot-sha sha" data-commit="40081cb5737da32058a3c87e14b84d8f2bfefdc4">40081cb57</span><time datetime="2023-03-20T22:01:24-07:00" title="2023-03-20 22:01:24 -0700">2023-03-20</time></p>
<header class="topbar"><details class="switcher"><summary>main</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/wezterm/ref/main/">main</a><strong>tags</strong><a href="/fork/wezterm/ref/termiz-0.23.1/">termiz-0.23.1</a><a href="/fork/wezterm/ref/termiz-0.23.2/">termiz-0.23.2</a><a href="/fork/wezterm/ref/termiz-0.23.3/">termiz-0.23.3</a><a href="/fork/wezterm/ref/termwiz-0.23.0/">termwiz-0.23.0</a><a href="/fork/wezterm/ref/termwiz-0.23.1/">termwiz-0.23.1</a><a href="/fork/wezterm/ref/termwiz-0.23.2/">termwiz-0.23.2</a><a href="/fork/wezterm/ref/termwiz-0.23.3/">termwiz-0.23.3</a><a href="/fork/wezterm/ref/vtparse-0.7.0/">vtparse-0.7.0</a><a class="all" href="/fork/wezterm/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/wezterm/">wezterm</a> / <a href="/fork/wezterm/ref/main/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/main/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/main/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/main/tree/docs/config/lua/pane/">pane</a> / <span class="cur">get_dimensions.md</span></nav>
<span class="view-stats"><span>648 B</span><span>19 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/d0505675383175aabf432f45d5a5e09a81ee2864/docs/config/lua/pane/get_dimensions.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1><code>pane:get_dimensions()</code></h1>
<p>{{since('20201031-154415-9614e117')}}</p>
<p>Returns a lua representation of the <code>RenderableDimensions</code> struct
that identifies the dimensions and position of the viewport as
well as the scrollback for the pane.</p>
<p>It has the following fields:</p>
<ul>
<li><code>cols</code> the number of columns</li>
<li><code>viewport_rows</code> the number of vertical cells in the visible portion
of the window</li>
<li><code>scrollback_rows</code> the total number of lines in the scrollback and viewport</li>
<li><code>physical_top</code> the top of the physical non-scrollback screen expressed as
a stable index.</li>
<li><code>scrollback_top</code> the top of the scrollback; the earliest row remembered
by wezterm.</li>
</ul>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>`pane:get_dimensions()`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">{{since(&#39;20201031-154415-9614e117&#39;)}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">Returns a lua representation of the `RenderableDimensions` struct</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">that identifies the dimensions and position of the viewport as</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">well as the scrollback for the pane.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">It has the following fields:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p> * </a-p>`cols` the number of columns</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"> <a-p>* </a-p>`viewport_rows` the number of vertical cells in the visible portion</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>   </a-p>of the window</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"> <a-p>* </a-p>`scrollback_rows` the total number of lines in the scrollback and viewport</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"> <a-p>* </a-p>`physical_top` the top of the physical non-scrollback screen expressed as</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>   </a-p>a stable index.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"> <a-p>* </a-p>`scrollback_top` the top of the scrollback; the earliest row remembered</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>   </a-p>by wezterm.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"></span></span></pre></div></div>
</main>
</body>
</html>
