|
|
<!doctype html>
|
|
|
<html class="default no-js" lang="zh-CN">
|
|
|
<head>
|
|
|
<meta charset="utf-8">
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
|
<title>Selection | VS Code API 中文文档</title>
|
|
|
<meta name="description" content="VS Code API 是一系列你可以在 Visual Studio Code 扩展中调用的 JavaScript API，这个站点列出了扩展开发者可以使用的所有 vscode api 中文文档，是 vscode 插件开发必备。">
|
|
|
<meta name="author" content="洛竹">
|
|
|
<meta name="copyright" content="洛竹">
|
|
|
<meta property="og:type" content="docs">
|
|
|
<meta property="og:url" content="https://vscode-api-cn.js.org/index.html">
|
|
|
<meta property="og:site_name" content="Vscode Api 中文文档">
|
|
|
<meta property="article:tag" content="vscode api">
|
|
|
<meta property="article:tag" content="vscode api 中文文档">
|
|
|
<meta property="article:tag" content="vscode 插件">
|
|
|
<meta property="article:tag" content="vscode 插件开发">
|
|
|
<meta property="article:tag" content="vscode Selection">
|
|
|
<meta property="og:description" content="VS Code API 是一系列你可以在 Visual Studio Code 扩展中调用的 JavaScript API，这个站点列出了扩展开发者可以使用的所有 vscode api 中文文档，是 vscode 插件开发必备。">
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
|
<link rel="shortcut icon" href="https://code.visualstudio.com/favicon.ico" sizes="128x128">
|
|
|
<link rel='canonical' href='https://vscode-api-cn.js.org/' />
|
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
|
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
|
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-7962287588031867" crossorigin="anonymous"></script>
|
|
|
<script type="text/javascript">
|
|
|
(function (c, l, a, r, i, t, y) {
|
|
|
c[a] = c[a] || function () { (c[a].q = c[a].q || []).push(arguments) };
|
|
|
t = l.createElement(r); t.async = 1; t.src = "https://www.clarity.ms/tag/" + i;
|
|
|
y = l.getElementsByTagName(r)[0]; y.parentNode.insertBefore(t, y);
|
|
|
})(window, document, "clarity", "script", "g1cbw4nxoq");
|
|
|
</script>
|
|
|
<!-- Google tag (gtag.js) -->
|
|
|
<script async src="https://www.googletagmanager.com/gtag/js?id=G-T4TRRS1LB1"></script>
|
|
|
<script>
|
|
|
window.dataLayer = window.dataLayer || [];
|
|
|
function gtag(){dataLayer.push(arguments);}
|
|
|
gtag('js', new Date());
|
|
|
|
|
|
gtag('config', 'G-T4TRRS1LB1');
|
|
|
</script>
|
|
|
<style>
|
|
|
.container-main {
|
|
|
padding-bottom: 50px;
|
|
|
}
|
|
|
</style>
|
|
|
</head>
|
|
|
<body>
|
|
|
<header>
|
|
|
<div class="tsd-page-toolbar">
|
|
|
<div class="container">
|
|
|
<div class="table-wrap">
|
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
|
<div class="field">
|
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
|
<input id="tsd-search-field" type="text" />
|
|
|
</div>
|
|
|
<ul class="results">
|
|
|
<li class="state loading">Preparing search index...</li>
|
|
|
<li class="state failure">The search index is not available</li>
|
|
|
</ul>
|
|
|
<a href="../index.html" class="title">VS Code API 中文文档</a>
|
|
|
</div>
|
|
|
<div class="table-cell" id="tsd-widgets">
|
|
|
<div id="tsd-filter">
|
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
|
<div class="tsd-filter-group">
|
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
|
<span class="tsd-select-label">All</span>
|
|
|
<ul class="tsd-select-list">
|
|
|
<li data-value="public">Public</li>
|
|
|
<li data-value="protected">Public/Protected</li>
|
|
|
<li data-value="private" class="selected">All</li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
|
</div>
|
|
|
</div>
|
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
<div class="tsd-page-title">
|
|
|
<div class="container">
|
|
|
<ul class="tsd-breadcrumb">
|
|
|
<li>
|
|
|
<a href="../modules.html">VS Code API 中文文档</a>
|
|
|
</li>
|
|
|
<li>
|
|
|
<a href="../modules/vscode.html">vscode</a>
|
|
|
</li>
|
|
|
<li>
|
|
|
<a href="vscode.Selection.html">Selection</a>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h1>Class Selection</h1>
|
|
|
</div>
|
|
|
</div>
|
|
|
</header>
|
|
|
<div class="container container-main">
|
|
|
<div class="row">
|
|
|
<div class="col-8 col-content">
|
|
|
<section class="tsd-panel tsd-comment">
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Represents a text selection in an editor.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
|
<h3>层级</h3>
|
|
|
<ul class="tsd-hierarchy">
|
|
|
<li>
|
|
|
<a href="vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a>
|
|
|
<ul class="tsd-hierarchy">
|
|
|
<li>
|
|
|
<span class="target">Selection</span>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
|
<h2>索引</h2>
|
|
|
<section class="tsd-panel tsd-index-panel">
|
|
|
<div class="tsd-index-content">
|
|
|
<section class="tsd-index-section ">
|
|
|
<h3>Constructors（1）</h3>
|
|
|
<ul class="tsd-index-list">
|
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="vscode.Selection.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-index-section ">
|
|
|
<h3>Properties（7）</h3>
|
|
|
<ul class="tsd-index-list">
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="vscode.Selection.html#start" class="tsd-kind-icon">start</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="vscode.Selection.html#end" class="tsd-kind-icon">end</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="vscode.Selection.html#isEmpty" class="tsd-kind-icon">is<wbr>Empty</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="vscode.Selection.html#isSingleLine" class="tsd-kind-icon">is<wbr>Single<wbr>Line</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.Selection.html#anchor" class="tsd-kind-icon">anchor</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.Selection.html#active" class="tsd-kind-icon">active</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.Selection.html#isReversed" class="tsd-kind-icon">is<wbr>Reversed</a></li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-index-section tsd-is-inherited">
|
|
|
<h3>Methods（5）</h3>
|
|
|
<ul class="tsd-index-list">
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="vscode.Selection.html#contains" class="tsd-kind-icon">contains</a></li>
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="vscode.Selection.html#isEqual" class="tsd-kind-icon">is<wbr>Equal</a></li>
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="vscode.Selection.html#intersection" class="tsd-kind-icon">intersection</a></li>
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="vscode.Selection.html#union" class="tsd-kind-icon">union</a></li>
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="vscode.Selection.html#with" class="tsd-kind-icon">with</a></li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
</div>
|
|
|
</section>
|
|
|
</section>
|
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
|
<h2>Constructors（1）</h2>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
|
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|
|
<h3>constructor</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
|
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Selection<span class="tsd-signature-symbol">(</span>anchor<span class="tsd-signature-symbol">: </span><a href="vscode.Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a>, active<span class="tsd-signature-symbol">: </span><a href="vscode.Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="vscode.Selection.html" class="tsd-signature-type" data-tsd-kind="Class">Selection</a></li>
|
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Selection<span class="tsd-signature-symbol">(</span>anchorLine<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, anchorCharacter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, activeLine<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, activeCharacter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="vscode.Selection.html" class="tsd-signature-type" data-tsd-kind="Class">Selection</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<p>Overrides <a href="vscode.Range.html">Range</a>.<a href="vscode.Range.html#constructor">constructor</a></p>
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/828f462/vscode.d.ts#L486">vscode.d.ts:486</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Create a selection from two positions.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>anchor: <a href="vscode.Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>A position.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>active: <a href="vscode.Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>A position.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="vscode.Selection.html" class="tsd-signature-type" data-tsd-kind="Class">Selection</a></h4>
|
|
|
</li>
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<p>Overrides <a href="vscode.Range.html">Range</a>.<a href="vscode.Range.html#constructor">constructor</a></p>
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/828f462/vscode.d.ts#L496">vscode.d.ts:496</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Create a selection from four coordinates.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>anchorLine: <span class="tsd-signature-type">number</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A zero-based line value.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>anchorCharacter: <span class="tsd-signature-type">number</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A zero-based character value.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>activeLine: <span class="tsd-signature-type">number</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A zero-based line value.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>activeCharacter: <span class="tsd-signature-type">number</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A zero-based character value.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="vscode.Selection.html" class="tsd-signature-type" data-tsd-kind="Class">Selection</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
</section>
|
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
|
<h2>Properties（7）</h2>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
|
|
<a name="start" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> start</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">:</span> <a href="vscode.Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<p>Inherited from <a href="vscode.Range.html">Range</a>.<a href="vscode.Range.html#start">start</a></p>
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/828f462/vscode.d.ts#L370">vscode.d.ts:370</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The start position. It is before or equal to <a href="vscode.Range.html#end">end</a>.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
|
|
<a name="end" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> end</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">end<span class="tsd-signature-symbol">:</span> <a href="vscode.Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<p>Inherited from <a href="vscode.Range.html">Range</a>.<a href="vscode.Range.html#end">end</a></p>
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/828f462/vscode.d.ts#L375">vscode.d.ts:375</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The end position. It is after or equal to <a href="vscode.Range.html#start">start</a>.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
|
|
<a name="isEmpty" class="tsd-anchor"></a>
|
|
|
<h3>is<wbr>Empty</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">is<wbr>Empty<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<p>Inherited from <a href="vscode.Range.html">Range</a>.<a href="vscode.Range.html#isEmpty">isEmpty</a></p>
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/828f462/vscode.d.ts#L400">vscode.d.ts:400</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p><code>true</code> if <code>start</code> and <code>end</code> are equal.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
|
|
<a name="isSingleLine" class="tsd-anchor"></a>
|
|
|
<h3>is<wbr>Single<wbr>Line</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">is<wbr>Single<wbr>Line<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<p>Inherited from <a href="vscode.Range.html">Range</a>.<a href="vscode.Range.html#isSingleLine">isSingleLine</a></p>
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/828f462/vscode.d.ts#L405">vscode.d.ts:405</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p><code>true</code> if <code>start.line</code> and <code>end.line</code> are equal.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="anchor" class="tsd-anchor"></a>
|
|
|
<h3>anchor</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">anchor<span class="tsd-signature-symbol">:</span> <a href="vscode.Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/828f462/vscode.d.ts#L472">vscode.d.ts:472</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The position at which the selection starts.
|
|
|
This position might be before or after <a href="vscode.Selection.html#active">active</a>.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="active" class="tsd-anchor"></a>
|
|
|
<h3>active</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">active<span class="tsd-signature-symbol">:</span> <a href="vscode.Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/828f462/vscode.d.ts#L478">vscode.d.ts:478</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The position of the cursor.
|
|
|
This position might be before or after <a href="vscode.Selection.html#anchor">anchor</a>.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="isReversed" class="tsd-anchor"></a>
|
|
|
<h3>is<wbr>Reversed</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">is<wbr>Reversed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/828f462/vscode.d.ts#L501">vscode.d.ts:501</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>A selection is reversed if <a href="vscode.Selection.html#active">active</a>.isBefore(<a href="vscode.Selection.html#anchor">anchor</a>).</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
</section>
|
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
|
|
|
<h2>Methods（5）</h2>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
|
<a name="contains" class="tsd-anchor"></a>
|
|
|
<h3>contains</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
|
<li class="tsd-signature tsd-kind-icon">contains<span class="tsd-signature-symbol">(</span>positionOrRange<span class="tsd-signature-symbol">: </span><a href="vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a><span class="tsd-signature-symbol"> | </span><a href="vscode.Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<p>Inherited from <a href="vscode.Range.html">Range</a>.<a href="vscode.Range.html#contains">contains</a></p>
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/828f462/vscode.d.ts#L414">vscode.d.ts:414</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Check if a position or a range is contained in this range.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>positionOrRange: <a href="vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a><span class="tsd-signature-symbol"> | </span><a href="vscode.Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A position or a range.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
|
<p><code>true</code> if the position or range is inside or equal
|
|
|
to this range.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
|
<a name="isEqual" class="tsd-anchor"></a>
|
|
|
<h3>is<wbr>Equal</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Equal<span class="tsd-signature-symbol">(</span>other<span class="tsd-signature-symbol">: </span><a href="vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<p>Inherited from <a href="vscode.Range.html">Range</a>.<a href="vscode.Range.html#isEqual">isEqual</a></p>
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/828f462/vscode.d.ts#L423">vscode.d.ts:423</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Check if <code>other</code> equals this range.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>other: <a href="vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A range.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
|
<p><code>true</code> when start and end are <a href="vscode.Position.html#isEqual">equal</a> to
|
|
|
start and end of this range.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
|
<a name="intersection" class="tsd-anchor"></a>
|
|
|
<h3>intersection</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
|
<li class="tsd-signature tsd-kind-icon">intersection<span class="tsd-signature-symbol">(</span>range<span class="tsd-signature-symbol">: </span><a href="vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<p>Inherited from <a href="vscode.Range.html">Range</a>.<a href="vscode.Range.html#intersection">intersection</a></p>
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/828f462/vscode.d.ts#L433">vscode.d.ts:433</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Intersect <code>range</code> with this range and returns a new range or <code>undefined</code>
|
|
|
if the ranges have no overlap.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>range: <a href="vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A range.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a></h4>
|
|
|
<p>A range of the greater start and smaller end positions. Will
|
|
|
return undefined when there is no overlap.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
|
<a name="union" class="tsd-anchor"></a>
|
|
|
<h3>union</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
|
<li class="tsd-signature tsd-kind-icon">union<span class="tsd-signature-symbol">(</span>other<span class="tsd-signature-symbol">: </span><a href="vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<p>Inherited from <a href="vscode.Range.html">Range</a>.<a href="vscode.Range.html#union">union</a></p>
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/828f462/vscode.d.ts#L441">vscode.d.ts:441</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Compute the union of <code>other</code> with this range.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>other: <a href="vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A range.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a></h4>
|
|
|
<p>A range of smaller start position and the greater end position.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
|
<a name="with" class="tsd-anchor"></a>
|
|
|
<h3>with</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
|
<li class="tsd-signature tsd-kind-icon">with<span class="tsd-signature-symbol">(</span>start<span class="tsd-signature-symbol">?: </span><a href="vscode.Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a>, end<span class="tsd-signature-symbol">?: </span><a href="vscode.Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a></li>
|
|
|
<li class="tsd-signature tsd-kind-icon">with<span class="tsd-signature-symbol">(</span>change<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>start<span class="tsd-signature-symbol">?: </span><a href="vscode.Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a><span class="tsd-signature-symbol">; </span>end<span class="tsd-signature-symbol">?: </span><a href="vscode.Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<p>Inherited from <a href="vscode.Range.html">Range</a>.<a href="vscode.Range.html#with">with</a></p>
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/828f462/vscode.d.ts#L451">vscode.d.ts:451</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Derived a new range from this range.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> start: <a href="vscode.Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A position that should be used as start. The default value is the <a href="vscode.Range.html#start">current start</a>.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> end: <a href="vscode.Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A position that should be used as end. The default value is the <a href="vscode.Range.html#end">current end</a>.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a></h4>
|
|
|
<p>A range derived from this range with the given start and end position.
|
|
|
If start and end are not different <code>this</code> range will be returned.</p>
|
|
|
</li>
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<p>Inherited from <a href="vscode.Range.html">Range</a>.<a href="vscode.Range.html#with">with</a></p>
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/828f462/vscode.d.ts#L460">vscode.d.ts:460</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Derived a new range from this range.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>change: <span class="tsd-signature-symbol">{ </span>start<span class="tsd-signature-symbol">?: </span><a href="vscode.Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a><span class="tsd-signature-symbol">; </span>end<span class="tsd-signature-symbol">?: </span><a href="vscode.Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a><span class="tsd-signature-symbol"> }</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>An object that describes a change to this range.</p>
|
|
|
</div>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li class="tsd-parameter">
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> start<span class="tsd-signature-symbol">?: </span><a href="vscode.Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a></h5>
|
|
|
</li>
|
|
|
<li class="tsd-parameter">
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> end<span class="tsd-signature-symbol">?: </span><a href="vscode.Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="vscode.Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a></h4>
|
|
|
<p>A range that reflects the given change. Will return <code>this</code> range if the change
|
|
|
is not changing anything.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
</section>
|
|
|
</div>
|
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
|
<nav class="tsd-navigation primary">
|
|
|
<ul>
|
|
|
<li class=" ">
|
|
|
<a href="../modules.html">Exports</a>
|
|
|
</li>
|
|
|
<li class="current tsd-kind-namespace">
|
|
|
<a href="../modules/vscode.html">vscode</a>
|
|
|
<ul>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.authentication.html">authentication</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.commands.html">commands</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.comments.html">comments</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.debug.html">debug</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.env.html">env</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.extensions.html">extensions</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.languages.html">languages</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.notebooks.html">notebooks</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.scm.html">scm</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.tasks.html">tasks</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.tests.html">tests</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.window.html">window</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.workspace.html">workspace</a>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</nav>
|
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
|
<div style="width: 200px">
|
|
|
<script type="text/javascript" id="clstr_globe" src="//clustrmaps.com/globe.js?d=cMnk-gSDNcAzNMMm67U8rWRaHnjUc0Xb0giSGndepK4"></script>
|
|
|
</div>
|
|
|
<ul class="before-current">
|
|
|
</ul>
|
|
|
<ul class="current">
|
|
|
<li class="current tsd-kind-class tsd-parent-kind-namespace">
|
|
|
<a href="vscode.Selection.html" class="tsd-kind-icon">Selection</a>
|
|
|
<ul>
|
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
|
|
|
<a href="vscode.Selection.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
|
|
<a href="vscode.Selection.html#start" class="tsd-kind-icon">start</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
|
|
<a href="vscode.Selection.html#end" class="tsd-kind-icon">end</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
|
|
<a href="vscode.Selection.html#isEmpty" class="tsd-kind-icon">is<wbr>Empty</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
|
|
<a href="vscode.Selection.html#isSingleLine" class="tsd-kind-icon">is<wbr>Single<wbr>Line</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
|
<a href="vscode.Selection.html#contains" class="tsd-kind-icon">contains</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
|
<a href="vscode.Selection.html#isEqual" class="tsd-kind-icon">is<wbr>Equal</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
|
<a href="vscode.Selection.html#intersection" class="tsd-kind-icon">intersection</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
|
<a href="vscode.Selection.html#union" class="tsd-kind-icon">union</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
|
|
<a href="vscode.Selection.html#with" class="tsd-kind-icon">with</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.Selection.html#anchor" class="tsd-kind-icon">anchor</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.Selection.html#active" class="tsd-kind-icon">active</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.Selection.html#isReversed" class="tsd-kind-icon">is<wbr>Reversed</a>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<ul class="after-current">
|
|
|
</ul>
|
|
|
</nav>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
<footer class="with-border-bottom">
|
|
|
<div class="container">
|
|
|
<h2>图例</h2>
|
|
|
<div class="tsd-legend-group">
|
|
|
<ul class="tsd-legend">
|
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-legend">
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
</div>
|
|
|
</footer>
|
|
|
<div class="container tsd-generator">
|
|
|
<p>友链：<a href="https://jeasonstudio.gitbooks.io/vscode-cn-doc/content/" target="_blank">VS Code 中文文档</a> | <a href="https://code.visualstudio.com/docs" target="_blank">VS Code 官网文档</a> | <a href="https://marketplace.visualstudio.com/" target="_blank">VS Code 扩展市场</a></p>
|
|
|
<p>Generated by <a href="https://typedoc.org/" target="_blank">TypeDoc</a>. Maintained by <a href="https://youngjuning.js.org" target="_blank">洛竹</a></p>
|
|
|
</div>
|
|
|
<div class="overlay"></div>
|
|
|
<script src="../assets/js/main.js"></script>
|
|
|
<script type='text/javascript' src='//harassinganticipation.com/49/55/54/495554c56caa1155c7e9c5609d16b472.js'></script>
|
|
|
</body>
|
|
|
</html> |
