<!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_text_from_region.md - fork/wezterm @ termiz-0.23.2</title>
<meta name="description" content="docs/config/lua/pane/get_text_from_region.md in fork/wezterm at termiz-0.23.2.">
<meta property="og:title" content="docs/config/lua/pane/get_text_from_region.md - fork/wezterm @ termiz-0.23.2">
<meta property="og:description" content="docs/config/lua/pane/get_text_from_region.md in fork/wezterm at termiz-0.23.2.">
<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="termiz-0.23.2" data-tip="8b7ca454b5e0a65b69b1b736db54eae3c195384b">
<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="3b8551e03c1092291f4cc5e1a0aab9e980550374">docs: update nightly features -&gt; current release</span><span class="snapshot-sha sha" data-commit="3b8551e03c1092291f4cc5e1a0aab9e980550374">3b8551e03</span><time datetime="2023-03-20T21:29:43-07:00" title="2023-03-20 21:29:43 -0700">2023-03-20</time></p>
<header class="topbar"><details class="switcher"><summary>termiz-0.23.2</summary><div class="menu"><strong>branches</strong><a 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 class="current" 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/termiz-0.23.2/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termiz-0.23.2/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/termiz-0.23.2/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/termiz-0.23.2/tree/docs/config/lua/pane/">pane</a> / <span class="cur">get_text_from_region.md</span></nav>
<span class="view-stats"><span>616 B</span><span>16 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/ffea382b8b54916ab132abc63f71a2f108460402/docs/config/lua/pane/get_text_from_region.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_text_from_region(start_x, start_y, end_x, end_y)</code></h1>
<p>{{since('20230320-124340-559cb7b0')}}</p>
<p>Returns the text from the specified region.</p>
<ul>
<li><code>start_x</code> and <code>end_x</code> are the starting and ending cell column, where 0 is the
left-most cell</li>
<li><code>start_y</code> and <code>end_y</code> are the starting and ending row, expressed as a stable
row index.  Use <a href="/fork/wezterm/ref/termiz-0.23.2/blob/docs/config/lua/pane/get_dimensions.md">pane:get_dimensions()</a> to retrieve the
currently valid stable index values for the top of scrollback and top of
viewport.</li>
</ul>
<p>The text within the region is unwrapped to its logical line representation,
rather than the wrapped-to-physical-display-width.</p>
</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_text_from_region(start_x, start_y, end_x, end_y)`</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;20230320-124340-559cb7b0&#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 the text from the specified region.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>* </a-p>`start_x` and `end_x` are the starting and ending cell column, where 0 is the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>  </a-p>left-most cell</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>* </a-p>`start_y` and `end_y` are the starting and ending row, expressed as a stable</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>  </a-p>row index.  Use [pane:get_dimensions()](get_dimensions.md) to retrieve the</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>currently valid stable index values for the top of scrollback and top of</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.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">The text within the region is unwrapped to its logical line representation,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text">rather than the wrapped-to-physical-display-width.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"></span></span></pre></div></div>
</main>
</body>
</html>
