You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
vscode-api-cn.js/classes/Selection.html

661 lines
36 KiB

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Selection | VS Code API 中文文档</title>
<meta name="description" content="Documentation for VS Code API 中文文档">
<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="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
<style>
a[title="站长统计"] {
display: none;
}
.github-corner svg {
z-index: 1;
}
.github-corner:hover .octo-arm {
animation:octocat-wave 560ms ease-in-out
}
@keyframes octocat-wave {
0%,100%{transform:rotate(0)}
20%,60%{transform:rotate(-25deg)}
40%,80%{transform:rotate(10deg)}
}
@media (max-width:500px) {
.github-corner:hover
.octo-arm{animation:none}
.github-corner .octo-arm{
animation:octocat-wave 560ms ease-in-out
}
}
.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="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="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>Constructors1</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="Selection.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties7</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="Selection.html#start" class="tsd-kind-icon">start</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="Selection.html#end" class="tsd-kind-icon">end</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="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="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="Selection.html#anchor" class="tsd-kind-icon">anchor</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Selection.html#active" class="tsd-kind-icon">active</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Selection.html#isReversed" class="tsd-kind-icon">is<wbr>Reversed</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods5</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="Selection.html#contains" class="tsd-kind-icon">contains</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="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="Selection.html#intersection" class="tsd-kind-icon">intersection</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="Selection.html#union" class="tsd-kind-icon">union</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="Selection.html#with" class="tsd-kind-icon">with</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors1</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="Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a>, active<span class="tsd-signature-symbol">: </span><a href="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="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="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="Range.html">Range</a>.<a href="Range.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/79a38a3/vscode.d.ts#L490">vscode.d.ts:490</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="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="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="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="Range.html">Range</a>.<a href="Range.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/79a38a3/vscode.d.ts#L500">vscode.d.ts:500</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="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>Properties7</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="Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="Range.html">Range</a>.<a href="Range.html#start">start</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/79a38a3/vscode.d.ts#L374">vscode.d.ts:374</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="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="Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="Range.html">Range</a>.<a href="Range.html#end">end</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/79a38a3/vscode.d.ts#L379">vscode.d.ts:379</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="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="Range.html">Range</a>.<a href="Range.html#isEmpty">isEmpty</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/79a38a3/vscode.d.ts#L404">vscode.d.ts:404</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="Range.html">Range</a>.<a href="Range.html#isSingleLine">isSingleLine</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/79a38a3/vscode.d.ts#L409">vscode.d.ts:409</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="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/vscode-cn/vscode-api-cn/blob/79a38a3/vscode.d.ts#L476">vscode.d.ts:476</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="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="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/vscode-cn/vscode-api-cn/blob/79a38a3/vscode.d.ts#L482">vscode.d.ts:482</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="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/vscode-cn/vscode-api-cn/blob/79a38a3/vscode.d.ts#L505">vscode.d.ts:505</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A selection is reversed if <a href="Selection.html#active">active</a>.isBefore(<a href="Selection.html#anchor">anchor</a>).</p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods5</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="Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a><span class="tsd-signature-symbol"> | </span><a href="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="Range.html">Range</a>.<a href="Range.html#contains">contains</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/79a38a3/vscode.d.ts#L418">vscode.d.ts:418</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="Range.html" class="tsd-signature-type" data-tsd-kind="Class">Range</a><span class="tsd-signature-symbol"> | </span><a href="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="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="Range.html">Range</a>.<a href="Range.html#isEqual">isEqual</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/79a38a3/vscode.d.ts#L427">vscode.d.ts:427</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="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="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="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="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="Range.html">Range</a>.<a href="Range.html#intersection">intersection</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/79a38a3/vscode.d.ts#L437">vscode.d.ts:437</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="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="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="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="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="Range.html">Range</a>.<a href="Range.html#union">union</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/79a38a3/vscode.d.ts#L445">vscode.d.ts:445</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="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="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="Position.html" class="tsd-signature-type" data-tsd-kind="Class">Position</a>, end<span class="tsd-signature-symbol">?: </span><a href="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="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="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="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="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="Range.html">Range</a>.<a href="Range.html#with">with</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/79a38a3/vscode.d.ts#L455">vscode.d.ts:455</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="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="Range.html#start">current start</a>.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> end: <a href="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="Range.html#end">current end</a>.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="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="Range.html">Range</a>.<a href="Range.html#with">with</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/79a38a3/vscode.d.ts#L464">vscode.d.ts:464</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="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="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="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="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="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>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="Selection.html" class="tsd-kind-icon">Selection</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="Selection.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="Selection.html#start" class="tsd-kind-icon">start</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="Selection.html#end" class="tsd-kind-icon">end</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="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="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="Selection.html#contains" class="tsd-kind-icon">contains</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="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="Selection.html#intersection" class="tsd-kind-icon">intersection</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="Selection.html#union" class="tsd-kind-icon">union</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="Selection.html#with" class="tsd-kind-icon">with</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="Selection.html#anchor" class="tsd-kind-icon">anchor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="Selection.html#active" class="tsd-kind-icon">active</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="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>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</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>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p><a href="https://liiked.github.io/VS-Code-Extension-Doc-ZH/" target="_blank">VS Code 插件开发中文文档</a> | <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> | <a href="https://www.cnzz.com/stat/website.php?web_id=1280241129" target="_blank" title="VS Code 官网文档站长统计">站长统计</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script type="text/javascript">document.write(unescape("%3Cspan id='cnzz_stat_icon_1280241129'%3E%3C/span%3E%3Cscript src='https://s9.cnzz.com/z_stat.php%3Fid%3D1280241129' type='text/javascript'%3E%3C/script%3E"));</script>
<a href="https://github.com/youngjuning/vscode-api-cn" target="_blank" class="github-corner" aria-label="View source on GitHub"><svg width="80" height="80" viewBox="0 0 250 250" style="fill:#151513; color:#fff; position: fixed; top: 0; border: 0; right: 0;" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a>
</body>
</html>