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/interfaces/DecorationRenderOptions.html

726 lines
44 KiB

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DecorationRenderOptions | 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="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</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="../index.html">VS Code API 中文文档</a>
</li>
<li>
<a href="DecorationRenderOptions.html">DecorationRenderOptions</a>
</li>
</ul>
<h1>Interface DecorationRenderOptions</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 rendering styles for a <a href="TextEditorDecorationType.html">text editor decoration</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="ThemableDecorationRenderOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ThemableDecorationRenderOptions</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">DecorationRenderOptions</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DecorationRenderOptions.html#backgroundColor" class="tsd-kind-icon">background<wbr>Color</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DecorationRenderOptions.html#outline" class="tsd-kind-icon">outline</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DecorationRenderOptions.html#outlineColor" class="tsd-kind-icon">outline<wbr>Color</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DecorationRenderOptions.html#outlineStyle" class="tsd-kind-icon">outline<wbr>Style</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DecorationRenderOptions.html#outlineWidth" class="tsd-kind-icon">outline<wbr>Width</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DecorationRenderOptions.html#border" class="tsd-kind-icon">border</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DecorationRenderOptions.html#borderColor" class="tsd-kind-icon">border<wbr>Color</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DecorationRenderOptions.html#borderRadius" class="tsd-kind-icon">border<wbr>Radius</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DecorationRenderOptions.html#borderSpacing" class="tsd-kind-icon">border<wbr>Spacing</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DecorationRenderOptions.html#borderStyle" class="tsd-kind-icon">border<wbr>Style</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DecorationRenderOptions.html#borderWidth" class="tsd-kind-icon">border<wbr>Width</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DecorationRenderOptions.html#fontStyle" class="tsd-kind-icon">font<wbr>Style</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DecorationRenderOptions.html#fontWeight" class="tsd-kind-icon">font<wbr>Weight</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DecorationRenderOptions.html#textDecoration" class="tsd-kind-icon">text<wbr>Decoration</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DecorationRenderOptions.html#cursor" class="tsd-kind-icon">cursor</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DecorationRenderOptions.html#color" class="tsd-kind-icon">color</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DecorationRenderOptions.html#opacity" class="tsd-kind-icon">opacity</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DecorationRenderOptions.html#letterSpacing" class="tsd-kind-icon">letter<wbr>Spacing</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DecorationRenderOptions.html#gutterIconPath" class="tsd-kind-icon">gutter<wbr>Icon<wbr>Path</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DecorationRenderOptions.html#gutterIconSize" class="tsd-kind-icon">gutter<wbr>Icon<wbr>Size</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DecorationRenderOptions.html#overviewRulerColor" class="tsd-kind-icon">overview<wbr>Ruler<wbr>Color</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DecorationRenderOptions.html#before" class="tsd-kind-icon">before</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="DecorationRenderOptions.html#after" class="tsd-kind-icon">after</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DecorationRenderOptions.html#isWholeLine" class="tsd-kind-icon">is<wbr>Whole<wbr>Line</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DecorationRenderOptions.html#rangeBehavior" class="tsd-kind-icon">range<wbr>Behavior</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DecorationRenderOptions.html#overviewRulerLane" class="tsd-kind-icon">overview<wbr>Ruler<wbr>Lane</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DecorationRenderOptions.html#light" class="tsd-kind-icon">light</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="DecorationRenderOptions.html#dark" class="tsd-kind-icon">dark</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="backgroundColor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> background<wbr>Color</h3>
<div class="tsd-signature tsd-kind-icon">background<wbr>Color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../classes/ThemeColor.html" class="tsd-signature-type" data-tsd-kind="Class">ThemeColor</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ThemableDecorationRenderOptions.html">ThemableDecorationRenderOptions</a>.<a href="ThemableDecorationRenderOptions.html#backgroundColor">backgroundColor</a></p>
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L837">vscode.d.ts:837</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Background color of the decoration. Use rgba() and define transparent background colors to play well with other decorations.
Alternatively a color from the color registry can be <a href="../classes/ThemeColor.html">referenced</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="outline" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> outline</h3>
<div class="tsd-signature tsd-kind-icon">outline<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ThemableDecorationRenderOptions.html">ThemableDecorationRenderOptions</a>.<a href="ThemableDecorationRenderOptions.html#outline">outline</a></p>
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L842">vscode.d.ts:842</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CSS styling property that will be applied to text enclosed by a decoration.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="outlineColor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> outline<wbr>Color</h3>
<div class="tsd-signature tsd-kind-icon">outline<wbr>Color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../classes/ThemeColor.html" class="tsd-signature-type" data-tsd-kind="Class">ThemeColor</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ThemableDecorationRenderOptions.html">ThemableDecorationRenderOptions</a>.<a href="ThemableDecorationRenderOptions.html#outlineColor">outlineColor</a></p>
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L848">vscode.d.ts:848</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CSS styling property that will be applied to text enclosed by a decoration.
Better use &#39;outline&#39; for setting one or more of the individual outline properties.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="outlineStyle" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> outline<wbr>Style</h3>
<div class="tsd-signature tsd-kind-icon">outline<wbr>Style<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ThemableDecorationRenderOptions.html">ThemableDecorationRenderOptions</a>.<a href="ThemableDecorationRenderOptions.html#outlineStyle">outlineStyle</a></p>
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L854">vscode.d.ts:854</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CSS styling property that will be applied to text enclosed by a decoration.
Better use &#39;outline&#39; for setting one or more of the individual outline properties.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="outlineWidth" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> outline<wbr>Width</h3>
<div class="tsd-signature tsd-kind-icon">outline<wbr>Width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ThemableDecorationRenderOptions.html">ThemableDecorationRenderOptions</a>.<a href="ThemableDecorationRenderOptions.html#outlineWidth">outlineWidth</a></p>
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L860">vscode.d.ts:860</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CSS styling property that will be applied to text enclosed by a decoration.
Better use &#39;outline&#39; for setting one or more of the individual outline properties.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="border" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> border</h3>
<div class="tsd-signature tsd-kind-icon">border<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ThemableDecorationRenderOptions.html">ThemableDecorationRenderOptions</a>.<a href="ThemableDecorationRenderOptions.html#border">border</a></p>
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L865">vscode.d.ts:865</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CSS styling property that will be applied to text enclosed by a decoration.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="borderColor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> border<wbr>Color</h3>
<div class="tsd-signature tsd-kind-icon">border<wbr>Color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../classes/ThemeColor.html" class="tsd-signature-type" data-tsd-kind="Class">ThemeColor</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ThemableDecorationRenderOptions.html">ThemableDecorationRenderOptions</a>.<a href="ThemableDecorationRenderOptions.html#borderColor">borderColor</a></p>
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L871">vscode.d.ts:871</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CSS styling property that will be applied to text enclosed by a decoration.
Better use &#39;border&#39; for setting one or more of the individual border properties.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="borderRadius" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> border<wbr>Radius</h3>
<div class="tsd-signature tsd-kind-icon">border<wbr>Radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ThemableDecorationRenderOptions.html">ThemableDecorationRenderOptions</a>.<a href="ThemableDecorationRenderOptions.html#borderRadius">borderRadius</a></p>
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L877">vscode.d.ts:877</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CSS styling property that will be applied to text enclosed by a decoration.
Better use &#39;border&#39; for setting one or more of the individual border properties.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="borderSpacing" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> border<wbr>Spacing</h3>
<div class="tsd-signature tsd-kind-icon">border<wbr>Spacing<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ThemableDecorationRenderOptions.html">ThemableDecorationRenderOptions</a>.<a href="ThemableDecorationRenderOptions.html#borderSpacing">borderSpacing</a></p>
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L883">vscode.d.ts:883</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CSS styling property that will be applied to text enclosed by a decoration.
Better use &#39;border&#39; for setting one or more of the individual border properties.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="borderStyle" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> border<wbr>Style</h3>
<div class="tsd-signature tsd-kind-icon">border<wbr>Style<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ThemableDecorationRenderOptions.html">ThemableDecorationRenderOptions</a>.<a href="ThemableDecorationRenderOptions.html#borderStyle">borderStyle</a></p>
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L889">vscode.d.ts:889</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CSS styling property that will be applied to text enclosed by a decoration.
Better use &#39;border&#39; for setting one or more of the individual border properties.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="borderWidth" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> border<wbr>Width</h3>
<div class="tsd-signature tsd-kind-icon">border<wbr>Width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ThemableDecorationRenderOptions.html">ThemableDecorationRenderOptions</a>.<a href="ThemableDecorationRenderOptions.html#borderWidth">borderWidth</a></p>
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L895">vscode.d.ts:895</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CSS styling property that will be applied to text enclosed by a decoration.
Better use &#39;border&#39; for setting one or more of the individual border properties.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="fontStyle" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> font<wbr>Style</h3>
<div class="tsd-signature tsd-kind-icon">font<wbr>Style<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ThemableDecorationRenderOptions.html">ThemableDecorationRenderOptions</a>.<a href="ThemableDecorationRenderOptions.html#fontStyle">fontStyle</a></p>
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L900">vscode.d.ts:900</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CSS styling property that will be applied to text enclosed by a decoration.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="fontWeight" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> font<wbr>Weight</h3>
<div class="tsd-signature tsd-kind-icon">font<wbr>Weight<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ThemableDecorationRenderOptions.html">ThemableDecorationRenderOptions</a>.<a href="ThemableDecorationRenderOptions.html#fontWeight">fontWeight</a></p>
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L905">vscode.d.ts:905</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CSS styling property that will be applied to text enclosed by a decoration.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="textDecoration" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> text<wbr>Decoration</h3>
<div class="tsd-signature tsd-kind-icon">text<wbr>Decoration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ThemableDecorationRenderOptions.html">ThemableDecorationRenderOptions</a>.<a href="ThemableDecorationRenderOptions.html#textDecoration">textDecoration</a></p>
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L910">vscode.d.ts:910</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CSS styling property that will be applied to text enclosed by a decoration.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="cursor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> cursor</h3>
<div class="tsd-signature tsd-kind-icon">cursor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ThemableDecorationRenderOptions.html">ThemableDecorationRenderOptions</a>.<a href="ThemableDecorationRenderOptions.html#cursor">cursor</a></p>
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L915">vscode.d.ts:915</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CSS styling property that will be applied to text enclosed by a decoration.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="color" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> color</h3>
<div class="tsd-signature tsd-kind-icon">color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../classes/ThemeColor.html" class="tsd-signature-type" data-tsd-kind="Class">ThemeColor</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ThemableDecorationRenderOptions.html">ThemableDecorationRenderOptions</a>.<a href="ThemableDecorationRenderOptions.html#color">color</a></p>
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L920">vscode.d.ts:920</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CSS styling property that will be applied to text enclosed by a decoration.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="opacity" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> opacity</h3>
<div class="tsd-signature tsd-kind-icon">opacity<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ThemableDecorationRenderOptions.html">ThemableDecorationRenderOptions</a>.<a href="ThemableDecorationRenderOptions.html#opacity">opacity</a></p>
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L925">vscode.d.ts:925</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CSS styling property that will be applied to text enclosed by a decoration.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="letterSpacing" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> letter<wbr>Spacing</h3>
<div class="tsd-signature tsd-kind-icon">letter<wbr>Spacing<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ThemableDecorationRenderOptions.html">ThemableDecorationRenderOptions</a>.<a href="ThemableDecorationRenderOptions.html#letterSpacing">letterSpacing</a></p>
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L930">vscode.d.ts:930</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>CSS styling property that will be applied to text enclosed by a decoration.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="gutterIconPath" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> gutter<wbr>Icon<wbr>Path</h3>
<div class="tsd-signature tsd-kind-icon">gutter<wbr>Icon<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../classes/Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ThemableDecorationRenderOptions.html">ThemableDecorationRenderOptions</a>.<a href="ThemableDecorationRenderOptions.html#gutterIconPath">gutterIconPath</a></p>
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L935">vscode.d.ts:935</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An <strong>absolute path</strong> or an URI to an image to be rendered in the gutter.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="gutterIconSize" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> gutter<wbr>Icon<wbr>Size</h3>
<div class="tsd-signature tsd-kind-icon">gutter<wbr>Icon<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ThemableDecorationRenderOptions.html">ThemableDecorationRenderOptions</a>.<a href="ThemableDecorationRenderOptions.html#gutterIconSize">gutterIconSize</a></p>
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L942">vscode.d.ts:942</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Specifies the size of the gutter icon.
Available values are &#39;auto&#39;, &#39;contain&#39;, &#39;cover&#39; and any percentage value.
For further information: <a href="https://msdn.microsoft.com/en-us/library/jj127316(v=vs.85).aspx">https://msdn.microsoft.com/en-us/library/jj127316(v=vs.85).aspx</a></p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="overviewRulerColor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> overview<wbr>Ruler<wbr>Color</h3>
<div class="tsd-signature tsd-kind-icon">overview<wbr>Ruler<wbr>Color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../classes/ThemeColor.html" class="tsd-signature-type" data-tsd-kind="Class">ThemeColor</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ThemableDecorationRenderOptions.html">ThemableDecorationRenderOptions</a>.<a href="ThemableDecorationRenderOptions.html#overviewRulerColor">overviewRulerColor</a></p>
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L947">vscode.d.ts:947</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The color of the decoration in the overview ruler. Use rgba() and define transparent colors to play well with other decorations.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="before" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> before</h3>
<div class="tsd-signature tsd-kind-icon">before<span class="tsd-signature-symbol">:</span> <a href="ThemableDecorationAttachmentRenderOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ThemableDecorationAttachmentRenderOptions</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ThemableDecorationRenderOptions.html">ThemableDecorationRenderOptions</a>.<a href="ThemableDecorationRenderOptions.html#before">before</a></p>
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L952">vscode.d.ts:952</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Defines the rendering options of the attachment that is inserted before the decorated text.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="after" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> after</h3>
<div class="tsd-signature tsd-kind-icon">after<span class="tsd-signature-symbol">:</span> <a href="ThemableDecorationAttachmentRenderOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ThemableDecorationAttachmentRenderOptions</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ThemableDecorationRenderOptions.html">ThemableDecorationRenderOptions</a>.<a href="ThemableDecorationRenderOptions.html#after">after</a></p>
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L957">vscode.d.ts:957</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Defines the rendering options of the attachment that is inserted after the decorated text.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="isWholeLine" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> is<wbr>Whole<wbr>Line</h3>
<div class="tsd-signature tsd-kind-icon">is<wbr>Whole<wbr>Line<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/blob/bea8f92/vscode.d.ts#L1020">vscode.d.ts:1020</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Should the decoration be rendered also on the whitespace after the line text.
Defaults to <code>false</code>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="rangeBehavior" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> range<wbr>Behavior</h3>
<div class="tsd-signature tsd-kind-icon">range<wbr>Behavior<span class="tsd-signature-symbol">:</span> <a href="../enums/DecorationRangeBehavior.html" class="tsd-signature-type" data-tsd-kind="Enumeration">DecorationRangeBehavior</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L1026">vscode.d.ts:1026</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Customize the growing behavior of the decoration when edits occur at the edges of the decoration&#39;s range.
Defaults to <code>DecorationRangeBehavior.OpenOpen</code>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="overviewRulerLane" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> overview<wbr>Ruler<wbr>Lane</h3>
<div class="tsd-signature tsd-kind-icon">overview<wbr>Ruler<wbr>Lane<span class="tsd-signature-symbol">:</span> <a href="../enums/OverviewRulerLane.html" class="tsd-signature-type" data-tsd-kind="Enumeration">OverviewRulerLane</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L1031">vscode.d.ts:1031</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The position in the overview ruler where the decoration should be rendered.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="light" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> light</h3>
<div class="tsd-signature tsd-kind-icon">light<span class="tsd-signature-symbol">:</span> <a href="ThemableDecorationRenderOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ThemableDecorationRenderOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L1036">vscode.d.ts:1036</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Overwrite options for light themes.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="dark" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> dark</h3>
<div class="tsd-signature tsd-kind-icon">dark<span class="tsd-signature-symbol">:</span> <a href="ThemableDecorationRenderOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ThemableDecorationRenderOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L1041">vscode.d.ts:1041</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Overwrite options for dark themes.</p>
</div>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.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-interface">
<a href="DecorationRenderOptions.html" class="tsd-kind-icon">Decoration<wbr>Render<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DecorationRenderOptions.html#backgroundColor" class="tsd-kind-icon">background<wbr>Color</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DecorationRenderOptions.html#outline" class="tsd-kind-icon">outline</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DecorationRenderOptions.html#outlineColor" class="tsd-kind-icon">outline<wbr>Color</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DecorationRenderOptions.html#outlineStyle" class="tsd-kind-icon">outline<wbr>Style</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DecorationRenderOptions.html#outlineWidth" class="tsd-kind-icon">outline<wbr>Width</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DecorationRenderOptions.html#border" class="tsd-kind-icon">border</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DecorationRenderOptions.html#borderColor" class="tsd-kind-icon">border<wbr>Color</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DecorationRenderOptions.html#borderRadius" class="tsd-kind-icon">border<wbr>Radius</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DecorationRenderOptions.html#borderSpacing" class="tsd-kind-icon">border<wbr>Spacing</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DecorationRenderOptions.html#borderStyle" class="tsd-kind-icon">border<wbr>Style</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DecorationRenderOptions.html#borderWidth" class="tsd-kind-icon">border<wbr>Width</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DecorationRenderOptions.html#fontStyle" class="tsd-kind-icon">font<wbr>Style</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DecorationRenderOptions.html#fontWeight" class="tsd-kind-icon">font<wbr>Weight</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DecorationRenderOptions.html#textDecoration" class="tsd-kind-icon">text<wbr>Decoration</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DecorationRenderOptions.html#cursor" class="tsd-kind-icon">cursor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DecorationRenderOptions.html#color" class="tsd-kind-icon">color</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DecorationRenderOptions.html#opacity" class="tsd-kind-icon">opacity</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DecorationRenderOptions.html#letterSpacing" class="tsd-kind-icon">letter<wbr>Spacing</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DecorationRenderOptions.html#gutterIconPath" class="tsd-kind-icon">gutter<wbr>Icon<wbr>Path</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DecorationRenderOptions.html#gutterIconSize" class="tsd-kind-icon">gutter<wbr>Icon<wbr>Size</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DecorationRenderOptions.html#overviewRulerColor" class="tsd-kind-icon">overview<wbr>Ruler<wbr>Color</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DecorationRenderOptions.html#before" class="tsd-kind-icon">before</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="DecorationRenderOptions.html#after" class="tsd-kind-icon">after</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DecorationRenderOptions.html#isWholeLine" class="tsd-kind-icon">is<wbr>Whole<wbr>Line</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DecorationRenderOptions.html#rangeBehavior" class="tsd-kind-icon">range<wbr>Behavior</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DecorationRenderOptions.html#overviewRulerLane" class="tsd-kind-icon">overview<wbr>Ruler<wbr>Lane</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DecorationRenderOptions.html#light" class="tsd-kind-icon">light</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="DecorationRenderOptions.html#dark" class="tsd-kind-icon">dark</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</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>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>