module-xterm_src_xterm.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>module:xterm/src/xterm - Documentation</title>

    <script src="scripts/prettify/prettify.js"></script>
    <script src="scripts/prettify/lang-css.js"></script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
</head>
<body>

<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
  <div class="navicon"></div>
</label>

<label for="nav-trigger" class="overlay"></label>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="module-xterm_src_xterm.html">xterm/src/xterm</a><ul class='methods'><li data-type='method'><a href="module-xterm_src_xterm.html#.bindBlur">bindBlur</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#.bindCopy">bindCopy</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#.bindCut">bindCut</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#.bindDrop">bindDrop</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#.bindFocus">bindFocus</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#.bindKeys">bindKeys</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#.bindPaste">bindPaste</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#.click">click</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#.loadAddon">loadAddon</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#.prepareCopiedTextForClipboard">prepareCopiedTextForClipboard</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#bell">bell</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#bindMouse">bindMouse</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#blankLine">blankLine</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#blur">blur</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#ch">ch</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#charAttributes">charAttributes</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#charPosAbsolute">charPosAbsolute</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#clearSelection">clearSelection</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#cursorBackward">cursorBackward</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#cursorBackwardTab">cursorBackwardTab</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#cursorCharAbsolute">cursorCharAbsolute</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#cursorDown">cursorDown</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#cursorForward">cursorForward</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#cursorForwardTab">cursorForwardTab</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#cursorNextLine">cursorNextLine</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#cursorPos">cursorPos</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#cursorPrecedingLine">cursorPrecedingLine</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#cursorUp">cursorUp</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#deleteChars">deleteChars</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#deleteColumns">deleteColumns</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#deleteLines">deleteLines</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#destroy">destroy</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#deviceStatus">deviceStatus</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#disableModifiers">disableModifiers</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#enableLocatorReporting">enableLocatorReporting</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#eraseAttr">eraseAttr</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#eraseChars">eraseChars</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#eraseInDisplay">eraseInDisplay</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#eraseInLine">eraseInLine</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#eraseLeft">eraseLeft</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#eraseLine">eraseLine</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#eraseRectangle">eraseRectangle</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#eraseRight">eraseRight</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#error">error</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#evaluateKeyEscapeSequence">evaluateKeyEscapeSequence</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#fillRectangle">fillRectangle</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#focus">focus</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#handler">handler</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#handleTitle">handleTitle</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#HPositionRelative">HPositionRelative</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#HVPosition">HVPosition</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#index">index</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#initGlobal">initGlobal</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#initMouseTracking">initMouseTracking</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#insertChars">insertChars</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#insertColumns">insertColumns</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#insertLines">insertLines</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#insertRow">insertRow</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#is">is</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#keyDown">keyDown</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#keyPress">keyPress</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#leaseContentEditable">leaseContentEditable</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#linePosAbsolute">linePosAbsolute</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#loadLEDs">loadLEDs</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#log">log</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#maxRange">maxRange</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#mediaCopy">mediaCopy</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#nextStop">nextStop</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#open">open</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#prevStop">prevStop</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#refresh">refresh</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#repeatPrecedingCharacter">repeatPrecedingCharacter</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#requestAnsiMode">requestAnsiMode</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#requestPrivateMode">requestPrivateMode</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#reset">reset</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#resetMode">resetMode</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#resetTitleModes">resetTitleModes</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#resize">resize</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#restoreCursor">restoreCursor</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#restorePrivateValues">restorePrivateValues</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#reverseIndex">reverseIndex</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#saveCursor">saveCursor</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#scroll">scroll</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#scrollDisp">scrollDisp</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#scrollDown">scrollDown</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#scrollUp">scrollUp</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#send">send</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#sendDeviceAttributes">sendDeviceAttributes</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#setAttrInRectangle">setAttrInRectangle</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#setCharProtectionAttr">setCharProtectionAttr</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#setConformanceLevel">setConformanceLevel</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#setCursorStyle">setCursorStyle</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#setgCharset">setgCharset</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#setgLevel">setgLevel</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#setMode">setMode</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#setPointerMode">setPointerMode</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#setResources">setResources</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#setScrollRegion">setScrollRegion</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#setupStops">setupStops</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#showCursor">showCursor</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#softReset">softReset</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#tabClear">tabClear</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#tabSet">tabSet</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#updateRange">updateRange</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#VPositionRelative">VPositionRelative</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#write">write</a></li><li data-type='method'><a href="module-xterm_src_xterm.html#writeln">writeln</a></li></ul></li></ul><h3>Modules</h3><ul><li><a href="module-xterm_addons_attach_attach.html">xterm/addons/attach/attach</a><ul class='methods'><li data-type='method'><a href="module-xterm_addons_attach_attach.html#.attach">attach</a></li><li data-type='method'><a href="module-xterm_addons_attach_attach.html#.detach">detach</a></li></ul></li><li><a href="module-xterm_addons_fit_fit.html">xterm/addons/fit/fit</a></li><li><a href="module-xterm_addons_linkify_linkify.html">xterm/addons/linkify/linkify</a><ul class='methods'><li data-type='method'><a href="module-xterm_addons_linkify_linkify.html#.findLinkMatch">findLinkMatch</a></li><li data-type='method'><a href="module-xterm_addons_linkify_linkify.html#.linkify">linkify</a></li><li data-type='method'><a href="module-xterm_addons_linkify_linkify.html#.linkifyTerminalLine">linkifyTerminalLine</a></li></ul></li></ul><h3>Events</h3><ul><li><a href="module-xterm_addons_linkify_linkify.html#~event:linkify">linkify</a></li><li><a href="module-xterm_addons_linkify_linkify.html#~event:linkify:line">linkify:line</a></li></ul>
</nav>

<div id="main">
    
    <h1 class="page-title">module:xterm/src/xterm</h1>
    

    




<section>

<header>
    
        <h2>
        module:xterm/src/xterm
        </h2>
        
            <div class="class-description"><p>Xterm Xterm</p></div>
        
    
</header>

<article>
    <div class="container-overview">
    
        

    
    <h2>Constructor</h2>
    

    <h4 class="name" id="module:xterm/src/xterm"><span class="type-signature"></span>new module:xterm/src/xterm<span class="signature">(options)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line155">line 155</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Creates a new <code>Terminal</code> object.</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            

            

            <td class="description last"><p>An object containing a set of options, the available options are:</p>
<ul>
<li>cursorBlink (boolean): Whether the terminal cursor blinks</li>
</ul></td>
        </tr>

    
    </tbody>
</table>
















    
    </div>

    

    

    

     

    

    
        <h3 class="subsection-title">Members</h3>

        
            
<h4 class="name" id=".charsets"><span class="type-signature">(static) </span>charsets<span class="type-signature"></span></h4>





<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4824">line 4824</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Character Sets</p>
</div>








        
            
<h4 class="name" id=".defaults"><span class="type-signature">(static) </span>defaults<span class="type-signature"></span></h4>





<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line409">line 409</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Options</p>
</div>








        
            
<h4 class="name" id=".EventEmitter"><span class="type-signature">(static) </span>EventEmitter<span class="type-signature"></span></h4>





<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line5136">line 5136</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Expose</p>
</div>








        
            
<h4 class="name" id=".flags"><span class="type-signature">(static) </span>flags<span class="type-signature"></span></h4>





<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line1172">line 1172</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Flags used to render terminal text properly</p>
</div>








        
            
<h4 class="name" id=".on"><span class="type-signature">(static) </span>on<span class="type-signature"></span></h4>





<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line5145">line 5145</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Adds an event listener to the terminal.</p>
</div>








        
            
<h4 class="name" id=".tangoColors"><span class="type-signature">(static) </span>tangoColors<span class="type-signature"></span></h4>





<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line332">line 332</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Colors</p>
</div>








        
            
<h4 class="name" id="cursorState"><span class="type-signature"></span>cursorState<span class="type-signature"></span></h4>





<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line245">line 245</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Whether there is a full terminal refresh queued</p>
</div>








        
            
<h4 class="name" id="isRefreshing"><span class="type-signature"></span>isRefreshing<span class="type-signature"></span></h4>





<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line239">line 239</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Used to debounce the refresh function</p>
</div>








        
            
<h4 class="name" id="lines"><span class="type-signature"></span>lines<span class="type-signature"></span></h4>





<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line307">line 307</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>An array of all lines in the entire buffer, including the prompt. The lines are array of
characters which are 2-length arrays where [0] is an attribute and [1] is the character.</p>
</div>








        
            
<h4 class="name" id="x"><span class="type-signature"></span>x<span class="type-signature"></span></h4>





<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line229">line 229</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>The cursor's x position after ybase</p>
</div>








        
            
<h4 class="name" id="y"><span class="type-signature"></span>y<span class="type-signature"></span></h4>





<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line234">line 234</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>The cursor's y position after ybase</p>
</div>








        
            
<h4 class="name" id="ybase"><span class="type-signature"></span>ybase<span class="type-signature"></span></h4>





<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line219">line 219</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>The scroll position of the y cursor, ie. ybase + y = the y position within the entire
buffer</p>
</div>








        
            
<h4 class="name" id="ydisp"><span class="type-signature"></span>ydisp<span class="type-signature"></span></h4>





<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line224">line 224</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>The scroll position of the viewport</p>
</div>








        
    

    
        <h3 class="subsection-title">Methods</h3>

        
            

    

    <h4 class="name" id=".bindBlur"><span class="type-signature">(static) </span>bindBlur<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line471">line 471</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Binds the desired blur behavior on a given terminal object.</p>
</div>

























        
            

    

    <h4 class="name" id=".bindCopy"><span class="type-signature">(static) </span>bindCopy<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line632">line 632</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Binds copy functionality to the given terminal.</p>
</div>

























        
            

    

    <h4 class="name" id=".bindCut"><span class="type-signature">(static) </span>bindCut<span class="signature">(term)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line647">line 647</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Cancel the cut event completely.</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>term</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Xterm.html">Xterm</a></span>


            
            </td>

            

            

            <td class="description last"><p>The terminal on which to bind the cut event handling functionality.</p></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id=".bindDrop"><span class="type-signature">(static) </span>bindDrop<span class="signature">(term)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line660">line 660</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Do not perform the &quot;drop&quot; event. Altering the contents of the
terminal with drag n drop is unwanted behavior.</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>term</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Xterm.html">Xterm</a></span>


            
            </td>

            

            

            <td class="description last"><p>The terminal on which to bind the drop event handling functionality.</p></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id=".bindFocus"><span class="type-signature">(static) </span>bindFocus<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line447">line 447</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Binds the desired focus behavior on a given terminal object.</p>
</div>

























        
            

    

    <h4 class="name" id=".bindKeys"><span class="type-signature">(static) </span>bindKeys<span class="signature">(term)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line593">line 593</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Apply key handling to the terminal</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>term</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Xterm.html">Xterm</a></span>


            
            </td>

            

            

            <td class="description last"><p>The terminal on which to bind key handling</p></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id=".bindPaste"><span class="type-signature">(static) </span>bindPaste<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line533">line 533</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Bind to paste event and allow both keyboard and right-click pasting, without having the
contentEditable value set to true.</p>
</div>

























        
            

    

    <h4 class="name" id=".click"><span class="type-signature">(static) </span>click<span class="signature">(term)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line671">line 671</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Cancel click handling on the given terminal</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>term</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="Xterm.html">Xterm</a></span>


            
            </td>

            

            

            <td class="description last"><p>The terminal on which to bind the click event handling functionality.</p></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id=".loadAddon"><span class="type-signature">(static) </span>loadAddon<span class="signature">(addon)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line803">line 803</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Attempts to load an add-on using CommonJS or RequireJS (whichever is available).</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>addon</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last"><p>The name of the addon to load</p></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id=".prepareCopiedTextForClipboard"><span class="type-signature">(static) </span>prepareCopiedTextForClipboard<span class="signature">(text)</span><span class="type-signature"> &rarr; {string}</span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line611">line 611</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Prepares text copied from terminal selection, to be saved in the clipboard by:</p>
<ol>
<li>stripping all trailing white spaces</li>
<li>converting all non-breaking spaces to regular spaces</li>
</ol>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>text</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last"><p>The copied text that needs processing for storing in clipboard</p></td>
        </tr>

    
    </tbody>
</table>














<h5>Returns:</h5>

        


<dl class="param-type">
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    


        
            

    

    <h4 class="name" id="bell"><span class="type-signature"></span>bell<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line2848">line 2848</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Ring the bell.
Note: We could do sweet things with webaudio here</p>
</div>

























        
            

    

    <h4 class="name" id="bindMouse"><span class="type-signature"></span>bindMouse<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line827">line 827</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>XTerm mouse events
http://invisible-island.net/xterm/ctlseqs/ctlseqs.html#Mouse%20Tracking
To better understand these
the xterm code is very helpful:
Relevant files:
  button.c, charproc.c, misc.c
Relevant functions in xterm/button.c:
  BtnCode, EmitButtonCode, EditorButton, SendMousePosition</p>
</div>

























        
            

    

    <h4 class="name" id="blankLine"><span class="type-signature"></span>blankLine<span class="signature">(cur)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3111">line 3111</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Return the data array of a blank line/</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>cur</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"><p>First bunch of data for each &quot;blank&quot; character.</p></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id="blur"><span class="type-signature"></span>blur<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line462">line 462</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Blur the terminal. Delegates blur handling to the terminal's DOM element.</p>
</div>

























        
            

    

    <h4 class="name" id="ch"><span class="type-signature"></span>ch<span class="signature">(cur)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3132">line 3132</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>If cur return the back color xterm feature attribute. Else return defAttr.</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>cur</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id="charAttributes"><span class="type-signature"></span>charAttributes<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3444">line 3444</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Pm m  Character Attributes (SGR).
    Ps = 0  -&gt; Normal (default).
    Ps = 1  -&gt; Bold.
    Ps = 4  -&gt; Underlined.
    Ps = 5  -&gt; Blink (appears as Bold).
    Ps = 7  -&gt; Inverse.
    Ps = 8  -&gt; Invisible, i.e., hidden (VT300).
    Ps = 2 2  -&gt; Normal (neither bold nor faint).
    Ps = 2 4  -&gt; Not underlined.
    Ps = 2 5  -&gt; Steady (not blinking).
    Ps = 2 7  -&gt; Positive (not inverse).
    Ps = 2 8  -&gt; Visible, i.e., not hidden (VT300).
    Ps = 3 0  -&gt; Set foreground color to Black.
    Ps = 3 1  -&gt; Set foreground color to Red.
    Ps = 3 2  -&gt; Set foreground color to Green.
    Ps = 3 3  -&gt; Set foreground color to Yellow.
    Ps = 3 4  -&gt; Set foreground color to Blue.
    Ps = 3 5  -&gt; Set foreground color to Magenta.
    Ps = 3 6  -&gt; Set foreground color to Cyan.
    Ps = 3 7  -&gt; Set foreground color to White.
    Ps = 3 9  -&gt; Set foreground color to default (original).
    Ps = 4 0  -&gt; Set background color to Black.
    Ps = 4 1  -&gt; Set background color to Red.
    Ps = 4 2  -&gt; Set background color to Green.
    Ps = 4 3  -&gt; Set background color to Yellow.
    Ps = 4 4  -&gt; Set background color to Blue.
    Ps = 4 5  -&gt; Set background color to Magenta.
    Ps = 4 6  -&gt; Set background color to Cyan.
    Ps = 4 7  -&gt; Set background color to White.
    Ps = 4 9  -&gt; Set background color to default (original).</p>
<p>  If 16-color support is compiled, the following apply.  Assume
  that xterm's resources are set so that the ISO color codes are
  the first 8 of a set of 16.  Then the aixterm colors are the
  bright versions of the ISO colors:
    Ps = 9 0  -&gt; Set foreground color to Black.
    Ps = 9 1  -&gt; Set foreground color to Red.
    Ps = 9 2  -&gt; Set foreground color to Green.
    Ps = 9 3  -&gt; Set foreground color to Yellow.
    Ps = 9 4  -&gt; Set foreground color to Blue.
    Ps = 9 5  -&gt; Set foreground color to Magenta.
    Ps = 9 6  -&gt; Set foreground color to Cyan.
    Ps = 9 7  -&gt; Set foreground color to White.
    Ps = 1 0 0  -&gt; Set background color to Black.
    Ps = 1 0 1  -&gt; Set background color to Red.
    Ps = 1 0 2  -&gt; Set background color to Green.
    Ps = 1 0 3  -&gt; Set background color to Yellow.
    Ps = 1 0 4  -&gt; Set background color to Blue.
    Ps = 1 0 5  -&gt; Set background color to Magenta.
    Ps = 1 0 6  -&gt; Set background color to Cyan.
    Ps = 1 0 7  -&gt; Set background color to White.</p>
<p>  If xterm is compiled with the 16-color support disabled, it
  supports the following, from rxvt:
    Ps = 1 0 0  -&gt; Set foreground and background color to
    default.</p>
<p>  If 88- or 256-color support is compiled, the following apply.
    Ps = 3 8  ; 5  ; Ps -&gt; Set foreground color to the second
    Ps.
    Ps = 4 8  ; 5  ; Ps -&gt; Set background color to the second
    Ps.</p>
</div>

























        
            

    

    <h4 class="name" id="charPosAbsolute"><span class="type-signature"></span>charPosAbsolute<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3795">line 3795</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Pm `  Character Position Absolute
  [column] (default = [row,1]) (HPA).</p>
</div>

























        
            

    

    <h4 class="name" id="clearSelection"><span class="type-signature"></span>clearSelection<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line497">line 497</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Clears all selected text, inside the terminal.</p>
</div>

























        
            

    

    <h4 class="name" id="cursorBackward"><span class="type-signature"></span>cursorBackward<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3274">line 3274</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps D
Cursor Backward Ps Times (default = 1) (CUB).</p>
</div>

























        
            

    

    <h4 class="name" id="cursorBackwardTab"><span class="type-signature"></span>cursorBackwardTab<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4436">line 4436</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps Z  Cursor Backward Tabulation Ps tab stops (default = 1) (CBT).</p>
</div>

























        
            

    

    <h4 class="name" id="cursorCharAbsolute"><span class="type-signature"></span>cursorCharAbsolute<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3692">line 3692</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps G
Cursor Character Absolute  [column] (default = [row,1]) (CHA).</p>
</div>

























        
            

    

    <h4 class="name" id="cursorDown"><span class="type-signature"></span>cursorDown<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3246">line 3246</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps B
Cursor Down Ps Times (default = 1) (CUD).</p>
</div>

























        
            

    

    <h4 class="name" id="cursorForward"><span class="type-signature"></span>cursorForward<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3260">line 3260</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps C
Cursor Forward Ps Times (default = 1) (CUF).</p>
</div>

























        
            

    

    <h4 class="name" id="cursorForwardTab"><span class="type-signature"></span>cursorForwardTab<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4366">line 4366</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps I
  Cursor Forward Tabulation Ps tab stops (default = 1) (CHT).</p>
</div>

























        
            

    

    <h4 class="name" id="cursorNextLine"><span class="type-signature"></span>cursorNextLine<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3663">line 3663</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps E
Cursor Next Line Ps Times (default = 1) (CNL).
same as CSI Ps B ?</p>
</div>

























        
            

    

    <h4 class="name" id="cursorPos"><span class="type-signature"></span>cursorPos<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3286">line 3286</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps ; Ps H
Cursor Position [row;column] (default = [1,1]) (CUP).</p>
</div>

























        
            

    

    <h4 class="name" id="cursorPrecedingLine"><span class="type-signature"></span>cursorPrecedingLine<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3679">line 3679</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps F
Cursor Preceding Line Ps Times (default = 1) (CNL).
reuse CSI Ps A ?</p>
</div>

























        
            

    

    <h4 class="name" id="cursorUp"><span class="type-signature"></span>cursorUp<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3234">line 3234</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps A
Cursor Up Ps Times (default = 1) (CUU).</p>
</div>

























        
            

    

    <h4 class="name" id="deleteChars"><span class="type-signature"></span>deleteChars<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3757">line 3757</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps P
Delete Ps Character(s) (default = 1) (DCH).</p>
</div>

























        
            

    

    <h4 class="name" id="deleteColumns"><span class="type-signature"></span>deleteColumns<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4804">line 4804</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI P m SP ~
Delete P s Column(s) (default = 1) (DECDC), VT420 and up
NOTE: xterm doesn't enable this code by default.</p>
</div>

























        
            

    

    <h4 class="name" id="deleteLines"><span class="type-signature"></span>deleteLines<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3730">line 3730</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps M
Delete Ps Line(s) (default = 1) (DL).</p>
</div>

























        
            

    

    <h4 class="name" id="destroy"><span class="type-signature"></span>destroy<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line1156">line 1156</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Destroys the terminal.</p>
</div>

























        
            

    

    <h4 class="name" id="deviceStatus"><span class="type-signature"></span>deviceStatus<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3585">line 3585</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps n  Device Status Report (DSR).
    Ps = 5  -&gt; Status Report.  Result (``OK'') is
  CSI 0 n
    Ps = 6  -&gt; Report Cursor Position (CPR) [row;column].
  Result is
  CSI r ; c R
CSI ? Ps n
  Device Status Report (DSR, DEC-specific).
    Ps = 6  -&gt; Report Cursor Position (CPR) [row;column] as CSI
    ? r ; c R (assumes page is zero).
    Ps = 1 5  -&gt; Report Printer status as CSI ? 1 0  n  (ready).
    or CSI ? 1 1  n  (not ready).
    Ps = 2 5  -&gt; Report UDK status as CSI ? 2 0  n  (unlocked)
    or CSI ? 2 1  n  (locked).
    Ps = 2 6  -&gt; Report Keyboard status as
  CSI ? 2 7  ;  1  ;  0  ;  0  n  (North American).
  The last two parameters apply to VT400 &amp; up, and denote key-
  board ready and LK01 respectively.
    Ps = 5 3  -&gt; Report Locator status as
  CSI ? 5 3  n  Locator available, if compiled-in, or
  CSI ? 5 0  n  No Locator, if not.</p>
</div>

























        
            

    

    <h4 class="name" id="disableModifiers"><span class="type-signature"></span>disableModifiers<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4526">line 4526</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI &gt; Ps n
  Disable modifiers which may be enabled via the CSI &gt; Ps; Ps m
  sequence.  This corresponds to a resource value of &quot;-1&quot;, which
  cannot be set with the other sequence.  The parameter identi-
  fies the resource to be disabled:
    Ps = 1  -&gt; modifyCursorKeys.
    Ps = 2  -&gt; modifyFunctionKeys.
    Ps = 4  -&gt; modifyOtherKeys.
  If the parameter is omitted, modifyFunctionKeys is disabled.
  When modifyFunctionKeys is disabled, xterm uses the modifier
  keys to make an extended sequence of functions rather than
  adding a parameter to each function key to denote the modi-
  fiers.</p>
</div>

























        
            

    

    <h4 class="name" id="enableLocatorReporting"><span class="type-signature"></span>enableLocatorReporting<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4739">line 4739</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps ; Pu ' z
  Enable Locator Reporting (DECELR).
  Valid values for the first parameter:
    Ps = 0  -&gt; Locator disabled (default).
    Ps = 1  -&gt; Locator enabled.
    Ps = 2  -&gt; Locator enabled for one report, then disabled.
  The second parameter specifies the coordinate unit for locator
  reports.
  Valid values for the second parameter:
    Pu = 0  &lt;- or omitted -&gt; default to character cells.
    Pu = 1  &lt;- device physical pixels.
    Pu = 2  &lt;- character cells.</p>
</div>

























        
            

    

    <h4 class="name" id="eraseAttr"><span class="type-signature"></span>eraseAttr<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line322">line 322</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>back_color_erase feature for xterm.</p>
</div>

























        
            

    

    <h4 class="name" id="eraseChars"><span class="type-signature"></span>eraseChars<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3776">line 3776</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps X
Erase Ps Character(s) (default = 1) (ECH).</p>
</div>

























        
            

    

    <h4 class="name" id="eraseInDisplay"><span class="type-signature"></span>eraseInDisplay<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3326">line 3326</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps J  Erase in Display (ED).
    Ps = 0  -&gt; Erase Below (default).
    Ps = 1  -&gt; Erase Above.
    Ps = 2  -&gt; Erase All.
    Ps = 3  -&gt; Erase Saved Lines (xterm).
CSI ? Ps J
  Erase in Display (DECSED).
    Ps = 0  -&gt; Selective Erase Below (default).
    Ps = 1  -&gt; Selective Erase Above.
    Ps = 2  -&gt; Selective Erase All.</p>
</div>

























        
            

    

    <h4 class="name" id="eraseInLine"><span class="type-signature"></span>eraseInLine<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3365">line 3365</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps K  Erase in Line (EL).
    Ps = 0  -&gt; Erase to Right (default).
    Ps = 1  -&gt; Erase to Left.
    Ps = 2  -&gt; Erase All.
CSI ? Ps K
  Erase in Line (DECSEL).
    Ps = 0  -&gt; Selective Erase to Right (default).
    Ps = 1  -&gt; Selective Erase to Left.
    Ps = 2  -&gt; Selective Erase All.</p>
</div>

























        
            

    

    <h4 class="name" id="eraseLeft"><span class="type-signature"></span>eraseLeft<span class="signature">(x, y)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3087">line 3087</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Erase in the identified line everything from &quot;x&quot; to the start of the line (left).</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"><p>The column from which to start erasing to the start of the line.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"><p>The line in which to operate.</p></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id="eraseLine"><span class="type-signature"></span>eraseLine<span class="signature">(y)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3102">line 3102</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Erase all content in the given line</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"><p>The line to erase all of its contents.</p></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id="eraseRectangle"><span class="type-signature"></span>eraseRectangle<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4752">line 4752</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Pt; Pl; Pb; Pr$ z
  Erase Rectangular Area (DECERA), VT400 and up.
    Pt; Pl; Pb; Pr denotes the rectangle.
NOTE: xterm doesn't enable this code by default.</p>
</div>

























        
            

    

    <h4 class="name" id="eraseRight"><span class="type-signature"></span>eraseRight<span class="signature">(x, y)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3068">line 3068</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Erase in the identified line everything from &quot;x&quot; to the end of the line (right).</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"><p>The column from which to start erasing to the end of the line.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"><p>The line in which to operate.</p></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id="error"><span class="type-signature"></span>error<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line2871">line 2871</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Log the current state as error to the console.</p>
</div>

























        
            

    

    <h4 class="name" id="evaluateKeyEscapeSequence"><span class="type-signature"></span>evaluateKeyEscapeSequence<span class="signature">(ev)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line2574">line 2574</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Returns an object that determines how a KeyboardEvent should be handled. The key of the
returned value is the new key code to pass to the PTY.</p>
<p>Reference: http://invisible-island.net/xterm/ctlseqs/ctlseqs.html</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>ev</code></td>
            

            <td class="type">
            
                
<span class="param-type">KeyboardEvent</span>


            
            </td>

            

            

            <td class="description last"><p>The keyboard event to be translated to key escape sequence.</p></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id="fillRectangle"><span class="type-signature"></span>fillRectangle<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4702">line 4702</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Pc; Pt; Pl; Pb; Pr$ x
  Fill Rectangular Area (DECFRA), VT420 and up.
    Pc is the character to use.
    Pt; Pl; Pb; Pr denotes the rectangle.
NOTE: xterm doesn't enable this code by default.</p>
</div>

























        
            

    

    <h4 class="name" id="focus"><span class="type-signature"></span>focus<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line438">line 438</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Focus the terminal. Delegates focus handling to the terminal's DOM element.</p>
</div>

























        
            

    

    <h4 class="name" id="handler"><span class="type-signature"></span>handler<span class="signature">(data)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3153">line 3153</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Emit the 'data' event and populate the given data.</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>data</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last"><p>The data to populate in the event.</p></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id="handleTitle"><span class="type-signature"></span>handleTitle<span class="signature">(title)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3162">line 3162</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Emit the 'title' event and populate the given title.</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>title</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last"><p>The title to populate in the event.</p></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id="HPositionRelative"><span class="type-signature"></span>HPositionRelative<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3810">line 3810</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>141 61 a * HPR -
Horizontal Position Relative
reuse CSI Ps C ?</p>
</div>

























        
            

    

    <h4 class="name" id="HVPosition"><span class="type-signature"></span>HVPosition<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3920">line 3920</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps ; Ps f
  Horizontal and Vertical Position [row;column] (default =
  [1,1]) (HVP).</p>
</div>

























        
            

    

    <h4 class="name" id="index"><span class="type-signature"></span>index<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3174">line 3174</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>ESC D Index (IND is 0x84).</p>
</div>

























        
            

    

    <h4 class="name" id="initGlobal"><span class="type-signature"></span>initGlobal<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line484">line 484</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Initialize default behavior</p>
</div>

























        
            

    

    <h4 class="name" id="initMouseTracking"><span class="type-signature"></span>initMouseTracking<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4410">line 4410</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps ; Ps ; Ps ; Ps ; Ps T
  Initiate highlight mouse tracking.  Parameters are
  [func;startx;starty;firstrow;lastrow].  See the section Mouse
  Tracking.</p>
</div>

























        
            

    

    <h4 class="name" id="insertChars"><span class="type-signature"></span>insertChars<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3642">line 3642</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps @
Insert Ps (Blank) Character(s) (default = 1) (ICH).</p>
</div>

























        
            

    

    <h4 class="name" id="insertColumns"><span class="type-signature"></span>insertColumns<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4782">line 4782</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI P m SP }
Insert P s Column(s) (default = 1) (DECIC), VT420 and up.
NOTE: xterm doesn't enable this code by default.</p>
</div>

























        
            

    

    <h4 class="name" id="insertLines"><span class="type-signature"></span>insertLines<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3703">line 3703</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps L
Insert Ps Line(s) (default = 1) (IL).</p>
</div>

























        
            

    

    <h4 class="name" id="insertRow"><span class="type-signature"></span>insertRow<span class="signature">(row)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line683">line 683</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Insert the given row to the terminal or produce a new one
if no row argument is passed. Return the inserted row.</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>row</code></td>
            

            <td class="type">
            
                
<span class="param-type">HTMLElement</span>


            
            </td>

            

            

            <td class="description last"><p>(optional) The row to append to the terminal.</p></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id="is"><span class="type-signature"></span>is<span class="signature">(term)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3143">line 3143</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Evaluate if the current erminal is the given argument.</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>term</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            
            </td>

            

            

            <td class="description last"><p>The terminal to evaluate</p></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id="keyDown"><span class="type-signature"></span>keyDown<span class="signature">(ev)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line2537">line 2537</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Handle a keydown event
Key Resources:</p>
<ul>
<li>https://developer.mozilla.org/en-US/docs/DOM/KeyboardEvent</li>
</ul>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>ev</code></td>
            

            <td class="type">
            
                
<span class="param-type">KeyboardEvent</span>


            
            </td>

            

            

            <td class="description last"><p>The keydown event to be handled.</p></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id="keyPress"><span class="type-signature"></span>keyPress<span class="signature">(ev)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line2788">line 2788</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Handle a keypress event.
Key Resources:</p>
<ul>
<li>https://developer.mozilla.org/en-US/docs/DOM/KeyboardEvent</li>
</ul>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>ev</code></td>
            

            <td class="type">
            
                
<span class="param-type">KeyboardEvent</span>


            
            </td>

            

            

            <td class="description last"><p>The keypress event to be handled.</p></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id="leaseContentEditable"><span class="type-signature"></span>leaseContentEditable<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line509">line 509</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>This function temporarily enables (leases) the contentEditable value of the terminal, which
should be set back to false within 5 seconds at most.</p>
</div>

























        
            

    

    <h4 class="name" id="linePosAbsolute"><span class="type-signature"></span>linePosAbsolute<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3891">line 3891</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Pm d
Line Position Absolute  [row] (default = [1,column]) (VPA).</p>
</div>

























        
            

    

    <h4 class="name" id="loadLEDs"><span class="type-signature"></span>loadLEDs<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4623">line 4623</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps q  Load LEDs (DECLL).
    Ps = 0  -&gt; Clear all LEDS (default).
    Ps = 1  -&gt; Light Num Lock.
    Ps = 2  -&gt; Light Caps Lock.
    Ps = 3  -&gt; Light Scroll Lock.
    Ps = 2  1  -&gt; Extinguish Num Lock.
    Ps = 2  2  -&gt; Extinguish Caps Lock.
    Ps = 2  3  -&gt; Extinguish Scroll Lock.</p>
</div>

























        
            

    

    <h4 class="name" id="log"><span class="type-signature"></span>log<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line2861">line 2861</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Log the current state to the console.</p>
</div>

























        
            

    

    <h4 class="name" id="maxRange"><span class="type-signature"></span>maxRange<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3010">line 3010</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Set the range of refreshing to the maximyum value</p>
</div>

























        
            

    

    <h4 class="name" id="mediaCopy"><span class="type-signature"></span>mediaCopy<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4487">line 4487</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Pm i  Media Copy (MC).
    Ps = 0  -&gt; Print screen (default).
    Ps = 4  -&gt; Turn off printer controller mode.
    Ps = 5  -&gt; Turn on printer controller mode.
CSI ? Pm i
  Media Copy (MC, DEC-specific).
    Ps = 1  -&gt; Print line containing cursor.
    Ps = 4  -&gt; Turn off autoprint mode.
    Ps = 5  -&gt; Turn on autoprint mode.
    Ps = 1  0  -&gt; Print composed display, ignores DECPEX.
    Ps = 1  1  -&gt; Print all pages.</p>
</div>

























        
            

    

    <h4 class="name" id="nextStop"><span class="type-signature"></span>nextStop<span class="signature">(x)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3054">line 3054</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Move the cursor one tab stop forward from the given position (default is current).</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"><p>The position to move the cursor one tab stop forward.</p></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id="open"><span class="type-signature"></span>open<span class="signature">(parent)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line700">line 700</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Opens the terminal within an element.</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>parent</code></td>
            

            <td class="type">
            
                
<span class="param-type">HTMLElement</span>


            
            </td>

            

            

            <td class="description last"><p>The element to create the terminal within.</p></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id="prevStop"><span class="type-signature"></span>prevStop<span class="signature">(x)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3041">line 3041</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Move the cursor to the previous tab stop from the given position (default is current).</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"><p>The position to move the cursor to the previous tab stop.</p></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id="refresh"><span class="type-signature"></span>refresh<span class="signature">(start, end, queue)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line1202">line 1202</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Refreshes (re-renders) terminal content within two rows (inclusive)</p>
<p>Rendering Engine:</p>
<p>In the screen buffer, each character is stored as a an array with a character
and a 32-bit integer:</p>
<ul>
<li>First value: a utf-16 character.</li>
<li>Second value:</li>
<li>Next 9 bits: background color (0-511).</li>
<li>Next 9 bits: foreground color (0-511).</li>
<li>Next 14 bits: a mask for misc. flags:<ul>
<li>1=bold</li>
<li>2=underline</li>
<li>4=blink</li>
<li>8=inverse</li>
<li>16=invisible</li>
</ul>
</li>
</ul>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>start</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"><p>The row to start from (between 0 and terminal's height terminal - 1)</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>end</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"><p>The row to end at (between fromRow and terminal's height terminal - 1)</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>queue</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last"><p>Whether the refresh should ran right now or be queued</p></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id="repeatPrecedingCharacter"><span class="type-signature"></span>repeatPrecedingCharacter<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4447">line 4447</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps b  Repeat the preceding graphic character Ps times (REP).</p>
</div>

























        
            

    

    <h4 class="name" id="requestAnsiMode"><span class="type-signature"></span>requestAnsiMode<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4579">line 4579</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps$ p
  Request ANSI mode (DECRQM).  For VT300 and up, reply is
    CSI Ps; Pm$ y
  where Ps is the mode number as in RM, and Pm is the mode
  value:
    0 - not recognized
    1 - set
    2 - reset
    3 - permanently set
    4 - permanently reset</p>
</div>

























        
            

    

    <h4 class="name" id="requestPrivateMode"><span class="type-signature"></span>requestPrivateMode<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4591">line 4591</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI ? Ps$ p
  Request DEC private mode (DECRQM).  For VT300 and up, reply is
    CSI ? Ps; Pm$ p
  where Ps is the mode number as in DECSET, Pm is the mode value
  as in the ANSI DECRQM.</p>
</div>

























        
            

    

    <h4 class="name" id="reset"><span class="type-signature"></span>reset<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3209">line 3209</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>ESC c Full Reset (RIS).</p>
</div>

























        
            

    

    <h4 class="name" id="resetMode"><span class="type-signature"></span>resetMode<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4226">line 4226</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Pm l  Reset Mode (RM).
    Ps = 2  -&gt; Keyboard Action Mode (AM).
    Ps = 4  -&gt; Replace Mode (IRM).
    Ps = 1 2  -&gt; Send/receive (SRM).
    Ps = 2 0  -&gt; Normal Linefeed (LNM).
CSI ? Pm l
  DEC Private Mode Reset (DECRST).
    Ps = 1  -&gt; Normal Cursor Keys (DECCKM).
    Ps = 2  -&gt; Designate VT52 mode (DECANM).
    Ps = 3  -&gt; 80 Column Mode (DECCOLM).
    Ps = 4  -&gt; Jump (Fast) Scroll (DECSCLM).
    Ps = 5  -&gt; Normal Video (DECSCNM).
    Ps = 6  -&gt; Normal Cursor Mode (DECOM).
    Ps = 7  -&gt; No Wraparound Mode (DECAWM).
    Ps = 8  -&gt; No Auto-repeat Keys (DECARM).
    Ps = 9  -&gt; Don't send Mouse X &amp; Y on button press.
    Ps = 1 0  -&gt; Hide toolbar (rxvt).
    Ps = 1 2  -&gt; Stop Blinking Cursor (att610).
    Ps = 1 8  -&gt; Don't print form feed (DECPFF).
    Ps = 1 9  -&gt; Limit print to scrolling region (DECPEX).
    Ps = 2 5  -&gt; Hide Cursor (DECTCEM).
    Ps = 3 0  -&gt; Don't show scrollbar (rxvt).
    Ps = 3 5  -&gt; Disable font-shifting functions (rxvt).
    Ps = 4 0  -&gt; Disallow 80 -&gt; 132 Mode.
    Ps = 4 1  -&gt; No more(1) fix (see curses resource).
    Ps = 4 2  -&gt; Disable Nation Replacement Character sets (DEC-
    NRCM).
    Ps = 4 4  -&gt; Turn Off Margin Bell.
    Ps = 4 5  -&gt; No Reverse-wraparound Mode.
    Ps = 4 6  -&gt; Stop Logging.  (This is normally disabled by a
    compile-time option).
    Ps = 4 7  -&gt; Use Normal Screen Buffer.
    Ps = 6 6  -&gt; Numeric keypad (DECNKM).
    Ps = 6 7  -&gt; Backarrow key sends delete (DECBKM).
    Ps = 1 0 0 0  -&gt; Don't send Mouse X &amp; Y on button press and
    release.  See the section Mouse Tracking.
    Ps = 1 0 0 1  -&gt; Don't use Hilite Mouse Tracking.
    Ps = 1 0 0 2  -&gt; Don't use Cell Motion Mouse Tracking.
    Ps = 1 0 0 3  -&gt; Don't use All Motion Mouse Tracking.
    Ps = 1 0 0 4  -&gt; Don't send FocusIn/FocusOut events.
    Ps = 1 0 0 5  -&gt; Disable Extended Mouse Mode.
    Ps = 1 0 1 0  -&gt; Don't scroll to bottom on tty output
    (rxvt).
    Ps = 1 0 1 1  -&gt; Don't scroll to bottom on key press (rxvt).
    Ps = 1 0 3 4  -&gt; Don't interpret &quot;meta&quot; key.  (This disables
    the eightBitInput resource).
    Ps = 1 0 3 5  -&gt; Disable special modifiers for Alt and Num-
    Lock keys.  (This disables the numLock resource).
    Ps = 1 0 3 6  -&gt; Don't send ESC  when Meta modifies a key.
    (This disables the metaSendsEscape resource).
    Ps = 1 0 3 7  -&gt; Send VT220 Remove from the editing-keypad
    Delete key.
    Ps = 1 0 3 9  -&gt; Don't send ESC  when Alt modifies a key.
    (This disables the altSendsEscape resource).
    Ps = 1 0 4 0  -&gt; Do not keep selection when not highlighted.
    (This disables the keepSelection resource).
    Ps = 1 0 4 1  -&gt; Use the PRIMARY selection.  (This disables
    the selectToClipboard resource).
    Ps = 1 0 4 2  -&gt; Disable Urgency window manager hint when
    Control-G is received.  (This disables the bellIsUrgent
    resource).
    Ps = 1 0 4 3  -&gt; Disable raising of the window when Control-
    G is received.  (This disables the popOnBell resource).
    Ps = 1 0 4 7  -&gt; Use Normal Screen Buffer, clearing screen
    first if in the Alternate Screen.  (This may be disabled by
    the titeInhibit resource).
    Ps = 1 0 4 8  -&gt; Restore cursor as in DECRC.  (This may be
    disabled by the titeInhibit resource).
    Ps = 1 0 4 9  -&gt; Use Normal Screen Buffer and restore cursor
    as in DECRC.  (This may be disabled by the titeInhibit
    resource).  This combines the effects of the 1 0 4 7  and 1 0
    4 8  modes.  Use this with terminfo-based applications rather
    than the 4 7  mode.
    Ps = 1 0 5 0  -&gt; Reset terminfo/termcap function-key mode.
    Ps = 1 0 5 1  -&gt; Reset Sun function-key mode.
    Ps = 1 0 5 2  -&gt; Reset HP function-key mode.
    Ps = 1 0 5 3  -&gt; Reset SCO function-key mode.
    Ps = 1 0 6 0  -&gt; Reset legacy keyboard emulation (X11R6).
    Ps = 1 0 6 1  -&gt; Reset keyboard emulation to Sun/PC style.
    Ps = 2 0 0 4  -&gt; Reset bracketed paste mode.</p>
</div>

























        
            

    

    <h4 class="name" id="resetTitleModes"><span class="type-signature"></span>resetTitleModes<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4428">line 4428</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI &gt; Ps; Ps T
  Reset one or more features of the title modes to the default
  value.  Normally, &quot;reset&quot; disables the feature.  It is possi-
  ble to disable the ability to reset features by compiling a
  different default for the title modes into xterm.
    Ps = 0  -&gt; Do not set window/icon labels using hexadecimal.
    Ps = 1  -&gt; Do not query window/icon labels using hexadeci-
    mal.
    Ps = 2  -&gt; Do not set window/icon labels using UTF-8.
    Ps = 3  -&gt; Do not query window/icon labels using UTF-8.
  (See discussion of &quot;Title Modes&quot;).</p>
</div>

























        
            

    

    <h4 class="name" id="resize"><span class="type-signature"></span>resize<span class="signature">(x, y)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line2884">line 2884</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Resizes the terminal.</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>x</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"><p>The number of columns to resize to.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"><p>The number of rows to resize to.</p></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id="restoreCursor"><span class="type-signature"></span>restoreCursor<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4352">line 4352</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI u
  Restore cursor (ANSI.SYS).</p>
</div>

























        
            

    

    <h4 class="name" id="restorePrivateValues"><span class="type-signature"></span>restorePrivateValues<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4660">line 4660</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI ? Pm r
  Restore DEC Private Mode Values.  The value of Ps previously
  saved is restored.  Ps values are the same as for DECSET.</p>
</div>

























        
            

    

    <h4 class="name" id="reverseIndex"><span class="type-signature"></span>reverseIndex<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3187">line 3187</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>ESC M Reverse Index (RI is 0x8d).</p>
</div>

























        
            

    

    <h4 class="name" id="saveCursor"><span class="type-signature"></span>saveCursor<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4342">line 4342</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI s
  Save cursor (ANSI.SYS).</p>
</div>

























        
            

    

    <h4 class="name" id="scroll"><span class="type-signature"></span>scroll<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line1416">line 1416</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Scroll the terminal</p>
</div>

























        
            

    

    <h4 class="name" id="scrollDisp"><span class="type-signature"></span>scrollDisp<span class="signature">(disp)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line1460">line 1460</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Scroll the display of the terminal</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>disp</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"><p>The number of lines to scroll down (negatives scroll up).</p></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id="scrollDown"><span class="type-signature"></span>scrollDown<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4392">line 4392</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps T  Scroll down Ps lines (default = 1) (SD).</p>
</div>

























        
            

    

    <h4 class="name" id="scrollUp"><span class="type-signature"></span>scrollUp<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4377">line 4377</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps S  Scroll up Ps lines (default = 1) (SU).</p>
</div>

























        
            

    

    <h4 class="name" id="send"><span class="type-signature"></span>send<span class="signature">(data)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line2831">line 2831</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Send data for handling to the terminal</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>data</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id="sendDeviceAttributes"><span class="type-signature"></span>sendDeviceAttributes<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3857">line 3857</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps c  Send Device Attributes (Primary DA).
    Ps = 0  or omitted -&gt; request attributes from terminal.  The
    response depends on the decTerminalID resource setting.
    -&gt; CSI ? 1 ; 2 c  (<code>VT100 with Advanced Video Option'')
    -&gt; CSI ? 1 ; 0 c  (</code>VT101 with No Options'')
    -&gt; CSI ? 6 c  (<code>VT102'')
    -&gt; CSI ? 6 0 ; 1 ; 2 ; 6 ; 8 ; 9 ; 1 5 ; c  (</code>VT220'')
  The VT100-style response parameters do not mean anything by
  themselves.  VT220 parameters do, telling the host what fea-
  tures the terminal supports:
    Ps = 1  -&gt; 132-columns.
    Ps = 2  -&gt; Printer.
    Ps = 6  -&gt; Selective erase.
    Ps = 8  -&gt; User-defined keys.
    Ps = 9  -&gt; National replacement character sets.
    Ps = 1 5  -&gt; Technical characters.
    Ps = 2 2  -&gt; ANSI color, e.g., VT525.
    Ps = 2 9  -&gt; ANSI text locator (i.e., DEC Locator mode).
CSI &gt; Ps c
  Send Device Attributes (Secondary DA).
    Ps = 0  or omitted -&gt; request the terminal's identification
    code.  The response depends on the decTerminalID resource set-
    ting.  It should apply only to VT220 and up, but xterm extends
    this to VT100.
    -&gt; CSI  &gt; Pp ; Pv ; Pc c
  where Pp denotes the terminal type
    Pp = 0  -&gt; <code>VT100''.
    Pp = 1  -&gt;</code>VT220''.
  and Pv is the firmware version (for xterm, this was originally
  the XFree86 patch number, starting with 95).  In a DEC termi-
  nal, Pc indicates the ROM cartridge registration number and is
  always zero.
More information:
  xterm/charproc.c - line 2012, for more information.
  vim responds with ^[[?0c or ^[[?1c after the terminal's response (?)</p>
</div>

























        
            

    

    <h4 class="name" id="setAttrInRectangle"><span class="type-signature"></span>setAttrInRectangle<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4672">line 4672</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Pt; Pl; Pb; Pr; Ps$ r
  Change Attributes in Rectangular Area (DECCARA), VT400 and up.
    Pt; Pl; Pb; Pr denotes the rectangle.
    Ps denotes the SGR attributes to change: 0, 1, 4, 5, 7.
NOTE: xterm doesn't enable this code by default.</p>
</div>

























        
            

    

    <h4 class="name" id="setCharProtectionAttr"><span class="type-signature"></span>setCharProtectionAttr<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4650">line 4650</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps &quot; q
  Select character protection attribute (DECSCA).  Valid values
  for the parameter:
    Ps = 0  -&gt; DECSED and DECSEL can erase (default).
    Ps = 1  -&gt; DECSED and DECSEL cannot erase.
    Ps = 2  -&gt; DECSED and DECSEL can erase.</p>
</div>

























        
            

    

    <h4 class="name" id="setConformanceLevel"><span class="type-signature"></span>setConformanceLevel<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4608">line 4608</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps ; Ps &quot; p
  Set conformance level (DECSCL).  Valid values for the first
  parameter:
    Ps = 6 1  -&gt; VT100.
    Ps = 6 2  -&gt; VT200.
    Ps = 6 3  -&gt; VT300.
  Valid values for the second parameter:
    Ps = 0  -&gt; 8-bit controls.
    Ps = 1  -&gt; 7-bit controls (always set for VT100).
    Ps = 2  -&gt; 8-bit controls.</p>
</div>

























        
            

    

    <h4 class="name" id="setCursorStyle"><span class="type-signature"></span>setCursorStyle<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4637">line 4637</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps SP q
  Set cursor style (DECSCUSR, VT520).
    Ps = 0  -&gt; blinking block.
    Ps = 1  -&gt; blinking block (default).
    Ps = 2  -&gt; steady block.
    Ps = 3  -&gt; blinking underline.
    Ps = 4  -&gt; steady underline.</p>
</div>

























        
            

    

    <h4 class="name" id="setgCharset"><span class="type-signature"></span>setgCharset<span class="signature">(g, charset)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line2775">line 2775</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Set the charset for the given G level of the terminal</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>g</code></td>
            

            <td class="type">
            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>charset</code></td>
            

            <td class="type">
            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id="setgLevel"><span class="type-signature"></span>setgLevel<span class="signature">(g)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line2765">line 2765</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Set the G level of the terminal</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>g</code></td>
            

            <td class="type">
            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id="setMode"><span class="type-signature"></span>setMode<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4022">line 4022</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Pm h  Set Mode (SM).
    Ps = 2  -&gt; Keyboard Action Mode (AM).
    Ps = 4  -&gt; Insert Mode (IRM).
    Ps = 1 2  -&gt; Send/receive (SRM).
    Ps = 2 0  -&gt; Automatic Newline (LNM).
CSI ? Pm h
  DEC Private Mode Set (DECSET).
    Ps = 1  -&gt; Application Cursor Keys (DECCKM).
    Ps = 2  -&gt; Designate USASCII for character sets G0-G3
    (DECANM), and set VT100 mode.
    Ps = 3  -&gt; 132 Column Mode (DECCOLM).
    Ps = 4  -&gt; Smooth (Slow) Scroll (DECSCLM).
    Ps = 5  -&gt; Reverse Video (DECSCNM).
    Ps = 6  -&gt; Origin Mode (DECOM).
    Ps = 7  -&gt; Wraparound Mode (DECAWM).
    Ps = 8  -&gt; Auto-repeat Keys (DECARM).
    Ps = 9  -&gt; Send Mouse X &amp; Y on button press.  See the sec-
    tion Mouse Tracking.
    Ps = 1 0  -&gt; Show toolbar (rxvt).
    Ps = 1 2  -&gt; Start Blinking Cursor (att610).
    Ps = 1 8  -&gt; Print form feed (DECPFF).
    Ps = 1 9  -&gt; Set print extent to full screen (DECPEX).
    Ps = 2 5  -&gt; Show Cursor (DECTCEM).
    Ps = 3 0  -&gt; Show scrollbar (rxvt).
    Ps = 3 5  -&gt; Enable font-shifting functions (rxvt).
    Ps = 3 8  -&gt; Enter Tektronix Mode (DECTEK).
    Ps = 4 0  -&gt; Allow 80 -&gt; 132 Mode.
    Ps = 4 1  -&gt; more(1) fix (see curses resource).
    Ps = 4 2  -&gt; Enable Nation Replacement Character sets (DECN-
    RCM).
    Ps = 4 4  -&gt; Turn On Margin Bell.
    Ps = 4 5  -&gt; Reverse-wraparound Mode.
    Ps = 4 6  -&gt; Start Logging.  This is normally disabled by a
    compile-time option.
    Ps = 4 7  -&gt; Use Alternate Screen Buffer.  (This may be dis-
    abled by the titeInhibit resource).
    Ps = 6 6  -&gt; Application keypad (DECNKM).
    Ps = 6 7  -&gt; Backarrow key sends backspace (DECBKM).
    Ps = 1 0 0 0  -&gt; Send Mouse X &amp; Y on button press and
    release.  See the section Mouse Tracking.
    Ps = 1 0 0 1  -&gt; Use Hilite Mouse Tracking.
    Ps = 1 0 0 2  -&gt; Use Cell Motion Mouse Tracking.
    Ps = 1 0 0 3  -&gt; Use All Motion Mouse Tracking.
    Ps = 1 0 0 4  -&gt; Send FocusIn/FocusOut events.
    Ps = 1 0 0 5  -&gt; Enable Extended Mouse Mode.
    Ps = 1 0 1 0  -&gt; Scroll to bottom on tty output (rxvt).
    Ps = 1 0 1 1  -&gt; Scroll to bottom on key press (rxvt).
    Ps = 1 0 3 4  -&gt; Interpret &quot;meta&quot; key, sets eighth bit.
    (enables the eightBitInput resource).
    Ps = 1 0 3 5  -&gt; Enable special modifiers for Alt and Num-
    Lock keys.  (This enables the numLock resource).
    Ps = 1 0 3 6  -&gt; Send ESC   when Meta modifies a key.  (This
    enables the metaSendsEscape resource).
    Ps = 1 0 3 7  -&gt; Send DEL from the editing-keypad Delete
    key.
    Ps = 1 0 3 9  -&gt; Send ESC  when Alt modifies a key.  (This
    enables the altSendsEscape resource).
    Ps = 1 0 4 0  -&gt; Keep selection even if not highlighted.
    (This enables the keepSelection resource).
    Ps = 1 0 4 1  -&gt; Use the CLIPBOARD selection.  (This enables
    the selectToClipboard resource).
    Ps = 1 0 4 2  -&gt; Enable Urgency window manager hint when
    Control-G is received.  (This enables the bellIsUrgent
    resource).
    Ps = 1 0 4 3  -&gt; Enable raising of the window when Control-G
    is received.  (enables the popOnBell resource).
    Ps = 1 0 4 7  -&gt; Use Alternate Screen Buffer.  (This may be
    disabled by the titeInhibit resource).
    Ps = 1 0 4 8  -&gt; Save cursor as in DECSC.  (This may be dis-
    abled by the titeInhibit resource).
    Ps = 1 0 4 9  -&gt; Save cursor as in DECSC and use Alternate
    Screen Buffer, clearing it first.  (This may be disabled by
    the titeInhibit resource).  This combines the effects of the 1
    0 4 7  and 1 0 4 8  modes.  Use this with terminfo-based
    applications rather than the 4 7  mode.
    Ps = 1 0 5 0  -&gt; Set terminfo/termcap function-key mode.
    Ps = 1 0 5 1  -&gt; Set Sun function-key mode.
    Ps = 1 0 5 2  -&gt; Set HP function-key mode.
    Ps = 1 0 5 3  -&gt; Set SCO function-key mode.
    Ps = 1 0 6 0  -&gt; Set legacy keyboard emulation (X11R6).
    Ps = 1 0 6 1  -&gt; Set VT220 keyboard emulation.
    Ps = 2 0 0 4  -&gt; Set bracketed paste mode.
Modes:
  http: *vt100.net/docs/vt220-rm/chapter4.html</p>
</div>

























        
            

    

    <h4 class="name" id="setPointerMode"><span class="type-signature"></span>setPointerMode<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4541">line 4541</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI &gt; Ps p
  Set resource value pointerMode.  This is used by xterm to
  decide whether to hide the pointer cursor as the user types.
  Valid values for the parameter:
    Ps = 0  -&gt; never hide the pointer.
    Ps = 1  -&gt; hide if the mouse tracking mode is not enabled.
    Ps = 2  -&gt; always hide the pointer.  If no parameter is
    given, xterm uses the default, which is 1 .</p>
</div>

























        
            

    

    <h4 class="name" id="setResources"><span class="type-signature"></span>setResources<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4506">line 4506</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI &gt; Ps; Ps m
  Set or reset resource-values used by xterm to decide whether
  to construct escape sequences holding information about the
  modifiers pressed with a given key.  The first parameter iden-
  tifies the resource to set/reset.  The second parameter is the
  value to assign to the resource.  If the second parameter is
  omitted, the resource is reset to its initial value.
    Ps = 1  -&gt; modifyCursorKeys.
    Ps = 2  -&gt; modifyFunctionKeys.
    Ps = 4  -&gt; modifyOtherKeys.
  If no parameters are given, all resources are reset to their
  initial values.</p>
</div>

























        
            

    

    <h4 class="name" id="setScrollRegion"><span class="type-signature"></span>setScrollRegion<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4329">line 4329</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps ; Ps r
  Set Scrolling Region [top;bottom] (default = full size of win-
  dow) (DECSTBM).
CSI ? Pm r</p>
</div>

























        
            

    

    <h4 class="name" id="setupStops"><span class="type-signature"></span>setupStops<span class="signature">(i)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3021">line 3021</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Setup the tab stops.</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>i</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id="showCursor"><span class="type-signature"></span>showCursor<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line1406">line 1406</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Display the cursor element</p>
</div>

























        
            

    

    <h4 class="name" id="softReset"><span class="type-signature"></span>softReset<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4550">line 4550</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI ! p   Soft terminal reset (DECSTR).
http://vt100.net/docs/vt220-rm/table4-10.html</p>
</div>

























        
            

    

    <h4 class="name" id="tabClear"><span class="type-signature"></span>tabClear<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line4464">line 4464</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>CSI Ps g  Tab Clear (TBC).
    Ps = 0  -&gt; Clear Current Column (default).
    Ps = 3  -&gt; Clear All.
Potentially:
  Ps = 2  -&gt; Clear Stops on Line.
  http://vt100.net/annarbor/aaa-ug/section6.html</p>
</div>

























        
            

    

    <h4 class="name" id="tabSet"><span class="type-signature"></span>tabSet<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3220">line 3220</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>ESC H Tab Set (HTS is 0x88).</p>
</div>

























        
            

    

    <h4 class="name" id="updateRange"><span class="type-signature"></span>updateRange<span class="signature">(y)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line2996">line 2996</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Updates the range of rows to refresh</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>y</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"><p>The number of rows to refresh next.</p></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id="VPositionRelative"><span class="type-signature"></span>VPositionRelative<span class="signature">()</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line3905">line 3905</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>145 65 e * VPR - Vertical Position Relative
reuse CSI Ps B ?</p>
</div>

























        
            

    

    <h4 class="name" id="write"><span class="type-signature"></span>write<span class="signature">(text)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line1476">line 1476</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Writes text to the terminal.</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>text</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last"><p>The text to write to the terminal.</p></td>
        </tr>

    
    </tbody>
</table>
















        
            

    

    <h4 class="name" id="writeln"><span class="type-signature"></span>writeln<span class="signature">(text)</span><span class="type-signature"></span></h4>

    




<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="src_xterm.js.html">src/xterm.js</a>, <a href="src_xterm.js.html#line2527">line 2527</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    

    

    

    

    

    

    
</dl>





<div class="description">
    <p>Writes text to the terminal, followed by a break line character (\n).</p>
</div>











    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>text</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last"><p>The text to write to the terminal.</p></td>
        </tr>

    
    </tbody>
</table>
















        
    

    

    
</article>

</section>




</div>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jul 14 2016 13:31:36 GMT+0000 (UTC) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>