<!doctype html>
< html class = "default no-js" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< title > TextLine | 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 = "../modules.html" > VS Code API< / a >
< / li >
< li >
< a href = "TextLine.html" > TextLine< / a >
< / li >
< / ul >
< h1 > Interface TextLine< / 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 line of text, such as a line of source code.< / p >
< / div >
< p > TextLine objects are < strong > immutable< / strong > . When a < a href = "TextDocument.html" > document< / a > changes,
previously retrieved lines will not represent the latest state.< / p >
< / div >
< / section >
< section class = "tsd-panel tsd-hierarchy" >
< h3 > Hierarchy< / h3 >
< ul class = "tsd-hierarchy" >
< li >
< span class = "target" > TextLine< / span >
< / 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" > < a href = "TextLine.html#lineNumber" class = "tsd-kind-icon" > line< wbr > Number< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "TextLine.html#text" class = "tsd-kind-icon" > text< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "TextLine.html#range" class = "tsd-kind-icon" > range< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "TextLine.html#rangeIncludingLineBreak" class = "tsd-kind-icon" > range< wbr > Including< wbr > Line< wbr > Break< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "TextLine.html#firstNonWhitespaceCharacterIndex" class = "tsd-kind-icon" > first< wbr > Non< wbr > Whitespace< wbr > Character< wbr > Index< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < a href = "TextLine.html#isEmptyOrWhitespace" class = "tsd-kind-icon" > is< wbr > Empty< wbr > OrWhitespace< / 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" >
< a name = "lineNumber" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > line< wbr > Number< / h3 >
< div class = "tsd-signature tsd-kind-icon" > line< wbr > Number< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > number< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/98bc825/vscode.d.ts#L52" > vscode.d.ts:52< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The zero-based line number.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "text" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > text< / h3 >
< div class = "tsd-signature tsd-kind-icon" > text< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/98bc825/vscode.d.ts#L57" > vscode.d.ts:57< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The text of this line without the line separator characters.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "range" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > range< / h3 >
< div class = "tsd-signature tsd-kind-icon" > range< span class = "tsd-signature-symbol" > :< / span > < a href = "../classes/Range.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Range< / a > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/98bc825/vscode.d.ts#L62" > vscode.d.ts:62< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The range this line covers without the line separator characters.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "rangeIncludingLineBreak" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > range< wbr > Including< wbr > Line< wbr > Break< / h3 >
< div class = "tsd-signature tsd-kind-icon" > range< wbr > Including< wbr > Line< wbr > Break< span class = "tsd-signature-symbol" > :< / span > < a href = "../classes/Range.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Range< / a > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/98bc825/vscode.d.ts#L67" > vscode.d.ts:67< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The range this line covers with the line separator characters.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "firstNonWhitespaceCharacterIndex" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > first< wbr > Non< wbr > Whitespace< wbr > Character< wbr > Index< / h3 >
< div class = "tsd-signature tsd-kind-icon" > first< wbr > Non< wbr > Whitespace< wbr > Character< wbr > Index< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > number< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/98bc825/vscode.d.ts#L73" > vscode.d.ts:73< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The offset of the first character which is not a whitespace character as defined
by < code > /\s/< / code > . < strong > Note< / strong > that if a line is all whitespace the length of the line is returned.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface" >
< a name = "isEmptyOrWhitespace" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagReadonly" > Readonly< / span > is< wbr > Empty< wbr > OrWhitespace< / h3 >
< div class = "tsd-signature tsd-kind-icon" > is< wbr > Empty< wbr > OrWhitespace< 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/98bc825/vscode.d.ts#L79" > vscode.d.ts:79< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Whether this line is whitespace only, shorthand
for < a href = "TextLine.html#firstNonWhitespaceCharacterIndex" > TextLine.firstNonWhitespaceCharacterIndex< / a > === < a href = "TextLine.html#text" > TextLine.text.length< / a > .< / 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 = "../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-interface" >
< a href = "TextLine.html" class = "tsd-kind-icon" > Text< wbr > Line< / a >
< ul >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "TextLine.html#lineNumber" class = "tsd-kind-icon" > line< wbr > Number< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "TextLine.html#text" class = "tsd-kind-icon" > text< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "TextLine.html#range" class = "tsd-kind-icon" > range< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "TextLine.html#rangeIncludingLineBreak" class = "tsd-kind-icon" > range< wbr > Including< wbr > Line< wbr > Break< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "TextLine.html#firstNonWhitespaceCharacterIndex" class = "tsd-kind-icon" > first< wbr > Non< wbr > Whitespace< wbr > Character< wbr > Index< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-interface" >
< a href = "TextLine.html#isEmptyOrWhitespace" class = "tsd-kind-icon" > is< wbr > Empty< wbr > OrWhitespace< / 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 >
