VirtualizedTextView
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new VirtualizedTextView(
container,options?):VirtualizedTextView
Parameters
Section titled “Parameters”container
Section titled “container”HTMLElement
options?
Section titled “options?”VirtualizedTextViewOptions
Returns
Section titled “Returns”VirtualizedTextView
Properties
Section titled “Properties”contentElement
Section titled “contentElement”
readonlycontentElement:HTMLDivElement
editContext
Section titled “editContext”
readonlyeditContext:EditorEditContext|null
Set when typed text arrives through EditContext rather than the textarea.
inputElement
Section titled “inputElement”
readonlyinputElement:HTMLElement
scrollElement
Section titled “scrollElement”
readonlyscrollElement:HTMLDivElement
Accessors
Section titled “Accessors”hasPendingReveal
Section titled “hasPendingReveal”Get Signature
Section titled “Get Signature”get hasPendingReveal():
boolean
Returns
Section titled “Returns”boolean
isProvisional
Section titled “isProvisional”Get Signature
Section titled “Get Signature”get isProvisional():
boolean
Returns
Section titled “Returns”boolean
isRenderingAtomically
Section titled “isRenderingAtomically”Get Signature
Section titled “Get Signature”get isRenderingAtomically():
boolean
Returns
Section titled “Returns”boolean
provisionalScrollPosition
Section titled “provisionalScrollPosition”Get Signature
Section titled “Get Signature”get provisionalScrollPosition(): {
left:number;top:number; } |null
Returns
Section titled “Returns”{ left: number; top: number; } | null
savedPaint
Section titled “savedPaint”Get Signature
Section titled “Get Signature”get savedPaint():
PaintSnapshot|null
Returns
Section titled “Returns”PaintSnapshot | null
scrollMode
Section titled “scrollMode”Get Signature
Section titled “Get Signature”get scrollMode():
VirtualizedTextViewScrollMode
Returns
Section titled “Returns”VirtualizedTextViewScrollMode
Methods
Section titled “Methods”adoptTokens()
Section titled “adoptTokens()”adoptTokens(
tokens):void
Parameters
Section titled “Parameters”tokens
Section titled “tokens”Returns
Section titled “Returns”void
applyEdit()
Section titled “applyEdit()”applyEdit(
edit,nextText,updateFoldState?):void
Parameters
Section titled “Parameters”nextText
Section titled “nextText”string | TextSnapshot
updateFoldState?
Section titled “updateFoldState?”() => void
Returns
Section titled “Returns”void
applyEditBatch()
Section titled “applyEditBatch()”applyEditBatch(
batch):void
Parameters
Section titled “Parameters”TextEditBatch
Returns
Section titled “Returns”void
assertContentSnapshot()
Section titled “assertContentSnapshot()”assertContentSnapshot(
text,replacement?):void
Parameters
Section titled “Parameters”string | TextSnapshot
replacement?
Section titled “replacement?”boolean
Returns
Section titled “Returns”void
atomicRanges()
Section titled “atomicRanges()”atomicRanges():
AtomicRanges
The rendered replacements a caret steps over whole and a delete takes whole.
Returns
Section titled “Returns”AtomicRanges
captureDeferredFoldMarkerSource()
Section titled “captureDeferredFoldMarkerSource()”captureDeferredFoldMarkerSource():
FoldMarkerSource|null
Returns
Section titled “Returns”FoldMarkerSource | null
captureDocumentPaint()
Section titled “captureDocumentPaint()”captureDocumentPaint(
appearance):DocumentPaintCapture
Parameters
Section titled “Parameters”appearance
Section titled “appearance”string
Returns
Section titled “Returns”captureGutterPaint()
Section titled “captureGutterPaint()”captureGutterPaint(): readonly readonly
object[][] |null
Returns
Section titled “Returns”readonly readonly object[][] | null
captureRowBackgrounds()
Section titled “captureRowBackgrounds()”captureRowBackgrounds():
object[]
Returns
Section titled “Returns”object[]
captureSelectionPaint()
Section titled “captureSelectionPaint()”captureSelectionPaint():
object
Returns
Section titled “Returns”object
id:
string
rectangles
Section titled “rectangles”rectangles:
object[]
caretXForOffset()
Section titled “caretXForOffset()”caretXForOffset(
offset,affinity):number
Parameters
Section titled “Parameters”offset
Section titled “offset”number
affinity
Section titled “affinity”Returns
Section titled “Returns”number
clearRangeHighlight()
Section titled “clearRangeHighlight()”clearRangeHighlight(
name):void
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
clearSelection()
Section titled “clearSelection()”clearSelection():
void
Returns
Section titled “Returns”void
commitProvisionalPaint()
Section titled “commitProvisionalPaint()”commitProvisionalPaint():
void
Returns
Section titled “Returns”void
compositionCharacterRects()
Section titled “compositionCharacterRects()”compositionCharacterRects():
DOMRect[]
Where each character of the drawn composition candidate sits.
Returns
Section titled “Returns”DOMRect[]
createBidiSelectionAnchor()
Section titled “createBidiSelectionAnchor()”createBidiSelectionAnchor(
position):VirtualizedBidiSelectionAnchor|null
Parameters
Section titled “Parameters”position
Section titled “position”VirtualizedTextHitPosition
Returns
Section titled “Returns”VirtualizedBidiSelectionAnchor | null
createRange()
Section titled “createRange()”createRange(
startOffset,endOffset,options?):Range|null
Parameters
Section titled “Parameters”startOffset
Section titled “startOffset”number
endOffset
Section titled “endOffset”number
options?
Section titled “options?”CreateRangeOptions
Returns
Section titled “Returns”Range | null
dispose()
Section titled “dispose()”dispose():
void
Returns
Section titled “Returns”void
focusInput()
Section titled “focusInput()”focusInput():
void
Returns
Section titled “Returns”void
getContentHeight()
Section titled “getContentHeight()”getContentHeight():
number
The rows’ own height, wrapped rows included, so a host can size itself to its text.
Returns
Section titled “Returns”number
getLineCount()
Section titled “getLineCount()”getLineCount():
number
Returns
Section titled “Returns”number
getLineStarts()
Section titled “getLineStarts()”getLineStarts(): readonly
number[]
Returns
Section titled “Returns”readonly number[]
getLineStartsView()
Section titled “getLineStartsView()”getLineStartsView():
LineStartsView
Returns
Section titled “Returns”LineStartsView
getProjectionDiagnostics()
Section titled “getProjectionDiagnostics()”getProjectionDiagnostics():
object
Returns
Section titled “Returns”object
cachedRows
Section titled “cachedRows”cachedRows:
number
cachedTextBytes
Section titled “cachedTextBytes”cachedTextBytes:
number
indexEntriesTouched
Section titled “indexEntriesTouched”indexEntriesTouched:
number
indexNodes
Section titled “indexNodes”indexNodes:
number
materializedRows
Section titled “materializedRows”materializedRows:
number
materializedTextBytes
Section titled “materializedTextBytes”materializedTextBytes:
number
sourceBytesRead
Section titled “sourceBytesRead”sourceBytesRead:
number
summaryBytes
Section titled “summaryBytes”summaryBytes:
number
summaryLinesMeasured
Section titled “summaryLinesMeasured”summaryLinesMeasured:
number
getRowPresentation()
Section titled “getRowPresentation()”getRowPresentation(
displayRow):EditorRowPresentation|null
Parameters
Section titled “Parameters”displayRow
Section titled “displayRow”number
Returns
Section titled “Returns”EditorRowPresentation | null
getState()
Section titled “getState()”getState():
VirtualizedTextViewState
Returns
Section titled “Returns”VirtualizedTextViewState
getViewport()
Section titled “getViewport()”getViewport():
EditorViewportSnapshot
Returns
Section titled “Returns”inlineReplacementRanges()
Section titled “inlineReplacementRanges()”inlineReplacementRanges(): readonly
TextOffsetRange[]
Spans of source the painted map stands something else in for; insertions cover none.
Returns
Section titled “Returns”readonly TextOffsetRange[]
isWrapEnabled()
Section titled “isWrapEnabled()”isWrapEnabled():
boolean
Returns
Section titled “Returns”boolean
markerAtPoint()
Section titled “markerAtPoint()”markerAtPoint(
clientX,clientY):EditorMarkerHit|null
Parameters
Section titled “Parameters”clientX
Section titled “clientX”number
clientY
Section titled “clientY”number
Returns
Section titled “Returns”EditorMarkerHit | null
measureInitialViewport()
Section titled “measureInitialViewport()”measureInitialViewport():
void
Returns
Section titled “Returns”void
offsetAtLineBoundary()
Section titled “offsetAtLineBoundary()”offsetAtLineBoundary(
offset,boundary):number
Parameters
Section titled “Parameters”offset
Section titled “offset”number
boundary
Section titled “boundary”"end" | "start"
Returns
Section titled “Returns”number
offsetByDisplayRows()
Section titled “offsetByDisplayRows()”offsetByDisplayRows(
offset,rowDelta,visualColumn):number
Parameters
Section titled “Parameters”offset
Section titled “offset”number
rowDelta
Section titled “rowDelta”number
visualColumn
Section titled “visualColumn”number
Returns
Section titled “Returns”number
onReservedOverlayWidthChange()
Section titled “onReservedOverlayWidthChange()”onReservedOverlayWidthChange(
listener):void
Parameters
Section titled “Parameters”listener
Section titled “listener”((side) => void) | null
Returns
Section titled “Returns”void
pageRowDelta()
Section titled “pageRowDelta()”pageRowDelta():
number
Returns
Section titled “Returns”number
paintConfiguration()
Section titled “paintConfiguration()”paintConfiguration():
string
Returns
Section titled “Returns”string
preparedVisibleRange()
Section titled “preparedVisibleRange()”preparedVisibleRange():
object
Returns
Section titled “Returns”object
endIndex
Section titled “endIndex”endIndex:
number
startIndex
Section titled “startIndex”startIndex:
number
refreshGutterWidth()
Section titled “refreshGutterWidth()”refreshGutterWidth():
void
Returns
Section titled “Returns”void
refreshMetrics()
Section titled “refreshMetrics()”refreshMetrics():
BrowserTextMetrics
Returns
Section titled “Returns”remeasureMetrics()
Section titled “remeasureMetrics()”remeasureMetrics():
BrowserTextMetrics|null
Re-measures and applies a reading that differs from the one in use; null when none does.
Returns
Section titled “Returns”BrowserTextMetrics | null
requestScrollTop()
Section titled “requestScrollTop()”requestScrollTop(
value):void
The offset the next text replacement should render at, so a restore costs one pass, not two.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
reservedOverlayWidth()
Section titled “reservedOverlayWidth()”reservedOverlayWidth(
side):number
Parameters
Section titled “Parameters”"left" | "right"
Returns
Section titled “Returns”number
reserveOverlayWidth()
Section titled “reserveOverlayWidth()”reserveOverlayWidth(
side,width):boolean
Parameters
Section titled “Parameters”"left" | "right"
number
Returns
Section titled “Returns”boolean
resolveBidiSelectionAnchor()
Section titled “resolveBidiSelectionAnchor()”resolveBidiSelectionAnchor(
anchor,head):number
Parameters
Section titled “Parameters”anchor
Section titled “anchor”VirtualizedBidiSelectionAnchor
VirtualizedTextHitPosition
Returns
Section titled “Returns”number
restorePaint()
Section titled “restorePaint()”restorePaint(
paint):boolean
Parameters
Section titled “Parameters”Returns
Section titled “Returns”boolean
restorePresentationHighlights()
Section titled “restorePresentationHighlights()”restorePresentationHighlights():
void
Returns
Section titled “Returns”void
revealCaret()
Section titled “revealCaret()”revealCaret(
offset,affinity,block?):void
Parameters
Section titled “Parameters”offset
Section titled “offset”number
affinity
Section titled “affinity”block?
Section titled “block?”RevealBlock
Returns
Section titled “Returns”void
revealOffset()
Section titled “revealOffset()”revealOffset(
offset,block?):void
Parameters
Section titled “Parameters”offset
Section titled “offset”number
block?
Section titled “block?”RevealBlock
Returns
Section titled “Returns”void
rowAtPoint()
Section titled “rowAtPoint()”rowAtPoint(
clientX,clientY):EditorPointHit|null
Parameters
Section titled “Parameters”clientX
Section titled “clientX”number
clientY
Section titled “clientY”number
Returns
Section titled “Returns”EditorPointHit | null
runAtomicRender()
Section titled “runAtomicRender()”runAtomicRender<
T>(update):T
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”update
Section titled “update”() => T
Returns
Section titled “Returns”T
scrollToRow()
Section titled “scrollToRow()”scrollToRow(
row):void
Scroll a zero-based document line to the top through the display projection.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
setCompositionPreedit()
Section titled “setCompositionPreedit()”setCompositionPreedit(
text):void
The text an IME is still assembling, drawn at the caret; empty text takes it back down.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
setEditable()
Section titled “setEditable()”setEditable(
editable):void
Parameters
Section titled “Parameters”editable
Section titled “editable”boolean
Returns
Section titled “Returns”void
setFoldMap()
Section titled “setFoldMap()”setFoldMap(
foldMap):void
Parameters
Section titled “Parameters”foldMap
Section titled “foldMap”FoldMap | null
Returns
Section titled “Returns”void
setFoldMarkers()
Section titled “setFoldMarkers()”setFoldMarkers(
markers):void
Parameters
Section titled “Parameters”markers
Section titled “markers”readonly VirtualizedFoldMarker[]
Returns
Section titled “Returns”void
setFoldState()
Section titled “setFoldState()”setFoldState(
markers,foldMap):void
Parameters
Section titled “Parameters”markers
Section titled “markers”readonly VirtualizedFoldMarker[]
foldMap
Section titled “foldMap”FoldMap | null
Returns
Section titled “Returns”void
setFontFamily()
Section titled “setFontFamily()”setFontFamily(
fontFamily):BrowserTextMetrics|null
Parameters
Section titled “Parameters”fontFamily
Section titled “fontFamily”string | undefined
Returns
Section titled “Returns”BrowserTextMetrics | null
setFontSize()
Section titled “setFontSize()”setFontSize(
fontSize):BrowserTextMetrics|null
Measures in the same call, so nothing between the write and the next frame positions a caret or a row with the old face’s widths. Null when the metrics in use did not change.
Parameters
Section titled “Parameters”fontSize
Section titled “fontSize”number | undefined
Returns
Section titled “Returns”BrowserTextMetrics | null
setGutterContributions()
Section titled “setGutterContributions()”setGutterContributions(
contributions):boolean
Parameters
Section titled “Parameters”contributions
Section titled “contributions”readonly EditorGutterContribution[]
Returns
Section titled “Returns”boolean
setGutterLeadingInset()
Section titled “setGutterLeadingInset()”setGutterLeadingInset(
inset):boolean
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”boolean
setGutterScroll()
Section titled “setGutterScroll()”setGutterScroll(
mode):boolean
Parameters
Section titled “Parameters”NonNullable<"fixed" | "content" | undefined>
Returns
Section titled “Returns”boolean
setHiddenCharacters()
Section titled “setHiddenCharacters()”setHiddenCharacters(
mode):void
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
setIndexedFoldState()
Section titled “setIndexedFoldState()”setIndexedFoldState(
source,foldMap):void
Parameters
Section titled “Parameters”source
Section titled “source”FoldMarkerSource
foldMap
Section titled “foldMap”FoldMap | null
Returns
Section titled “Returns”void
setInjectedTextRows()
Section titled “setInjectedTextRows()”setInjectedTextRows(
injectedTextRows):void
Parameters
Section titled “Parameters”injectedTextRows
Section titled “injectedTextRows”readonly InjectedTextRow[]
Returns
Section titled “Returns”void
setInlineMap()
Section titled “setInlineMap()”setInlineMap(
inlineMap):void
Parameters
Section titled “Parameters”inlineMap
Section titled “inlineMap”InlineMap | null
Returns
Section titled “Returns”void
setLineHeight()
Section titled “setLineHeight()”setLineHeight(
lineHeight):boolean
Parameters
Section titled “Parameters”lineHeight
Section titled “lineHeight”number
Returns
Section titled “Returns”boolean
setRangeHighlight()
Section titled “setRangeHighlight()”setRangeHighlight(
name,ranges,style):void
Parameters
Section titled “Parameters”string
ranges
Section titled “ranges”readonly VirtualizedTextHighlightRange[]
Returns
Section titled “Returns”void
setRowDecorations()
Section titled “setRowDecorations()”setRowDecorations(
decorations):void
Parameters
Section titled “Parameters”decorations
Section titled “decorations”ReadonlyMap<number, VirtualizedTextRowDecoration>
Returns
Section titled “Returns”void
setRowGap()
Section titled “setRowGap()”setRowGap(
rowGap):boolean
Parameters
Section titled “Parameters”rowGap
Section titled “rowGap”number
Returns
Section titled “Returns”boolean
setRowHeight()
Section titled “setRowHeight()”setRowHeight(
rowHeight):boolean
Parameters
Section titled “Parameters”rowHeight
Section titled “rowHeight”number
Returns
Section titled “Returns”boolean
setScrollMetrics()
Section titled “setScrollMetrics()”setScrollMetrics(
scrollTop,viewportHeight,viewportWidth?,scrollLeft?):void
Parameters
Section titled “Parameters”scrollTop
Section titled “scrollTop”number
viewportHeight
Section titled “viewportHeight”number
viewportWidth?
Section titled “viewportWidth?”number
scrollLeft?
Section titled “scrollLeft?”number
Returns
Section titled “Returns”void
setScrollMode()
Section titled “setScrollMode()”setScrollMode(
scrollMode):boolean
Parameters
Section titled “Parameters”scrollMode
Section titled “scrollMode”VirtualizedTextViewScrollMode | undefined
Returns
Section titled “Returns”boolean
setSelection()
Section titled “setSelection()”setSelection(
anchorOffset,headOffset,affinity?):void
Parameters
Section titled “Parameters”anchorOffset
Section titled “anchorOffset”number
headOffset
Section titled “headOffset”number
affinity?
Section titled “affinity?”Returns
Section titled “Returns”void
setSelections()
Section titled “setSelections()”setSelections(
selections):void
Parameters
Section titled “Parameters”selections
Section titled “selections”readonly VirtualizedTextSelection[]
Returns
Section titled “Returns”void
setSuspiciousCharacters()
Section titled “setSuspiciousCharacters()”setSuspiciousCharacters(
options):boolean
Parameters
Section titled “Parameters”options
Section titled “options”ResolvedSuspiciousCharactersOptions
Returns
Section titled “Returns”boolean
setTabSize()
Section titled “setTabSize()”setTabSize(
tabSize):boolean
Parameters
Section titled “Parameters”tabSize
Section titled “tabSize”number | undefined
Returns
Section titled “Returns”boolean
setText()
Section titled “setText()”setText(
text,preparedLineStarts?,preparedTokens?):void
Parameters
Section titled “Parameters”string | TextSnapshot
preparedLineStarts?
Section titled “preparedLineStarts?”readonly number[]
preparedTokens?
Section titled “preparedTokens?”Returns
Section titled “Returns”void
setTextMetrics()
Section titled “setTextMetrics()”setTextMetrics(
metrics):boolean
Adopts metrics measured elsewhere, for a view that mirrors another view’s rows.
Parameters
Section titled “Parameters”metrics
Section titled “metrics”Returns
Section titled “Returns”boolean
setTheme()
Section titled “setTheme()”setTheme(
theme):void
Parameters
Section titled “Parameters”EditorTheme | null | undefined
Returns
Section titled “Returns”void
setTokens()
Section titled “setTokens()”setTokens(
tokens):void
Parameters
Section titled “Parameters”tokens
Section titled “tokens”Returns
Section titled “Returns”void
setWrapEnabled()
Section titled “setWrapEnabled()”setWrapEnabled(
enabled):void
Parameters
Section titled “Parameters”enabled
Section titled “enabled”boolean
Returns
Section titled “Returns”void
textOffsetFromDomBoundary()
Section titled “textOffsetFromDomBoundary()”textOffsetFromDomBoundary(
node,offset):number|null
Parameters
Section titled “Parameters”Node
offset
Section titled “offset”number
Returns
Section titled “Returns”number | null
textOffsetFromPoint()
Section titled “textOffsetFromPoint()”textOffsetFromPoint(
clientX,clientY):number|null
Parameters
Section titled “Parameters”clientX
Section titled “clientX”number
clientY
Section titled “clientY”number
Returns
Section titled “Returns”number | null
textOffsetFromViewportPoint()
Section titled “textOffsetFromViewportPoint()”textOffsetFromViewportPoint(
clientX,clientY):number|null
Parameters
Section titled “Parameters”clientX
Section titled “clientX”number
clientY
Section titled “clientY”number
Returns
Section titled “Returns”number | null
textPositionFromPoint()
Section titled “textPositionFromPoint()”textPositionFromPoint(
clientX,clientY):VirtualizedTextHitPosition|null
Parameters
Section titled “Parameters”clientX
Section titled “clientX”number
clientY
Section titled “clientY”number
Returns
Section titled “Returns”VirtualizedTextHitPosition | null
textPositionFromViewportPoint()
Section titled “textPositionFromViewportPoint()”textPositionFromViewportPoint(
clientX,clientY):VirtualizedTextHitPosition|null
Parameters
Section titled “Parameters”clientX
Section titled “clientX”number
clientY
Section titled “clientY”number
Returns
Section titled “Returns”VirtualizedTextHitPosition | null
textViewportInsets()
Section titled “textViewportInsets()”textViewportInsets():
object
Overlay padding and the visible gutter inside the native scroll viewport.
Returns
Section titled “Returns”object
readonlyleft:number
readonlyright:number
topForOffset()
Section titled “topForOffset()”topForOffset(
offset):number
Return the projected row top for a document offset.
Parameters
Section titled “Parameters”offset
Section titled “offset”number
Returns
Section titled “Returns”number
validateMountedNativeGeometry()
Section titled “validateMountedNativeGeometry()”validateMountedNativeGeometry():
NativeGeometryValidation
Returns
Section titled “Returns”NativeGeometryValidation
verticalCaretTarget()
Section titled “verticalCaretTarget()”verticalCaretTarget(
offset,affinity,rowDelta,goal):VisualCaretTarget
Parameters
Section titled “Parameters”offset
Section titled “offset”number
affinity
Section titled “affinity”rowDelta
Section titled “rowDelta”number
VerticalSelectionGoal
Returns
Section titled “Returns”VisualCaretTarget
visualColumnForOffset()
Section titled “visualColumnForOffset()”visualColumnForOffset(
offset):number
Parameters
Section titled “Parameters”offset
Section titled “offset”number
Returns
Section titled “Returns”number
visualHorizontalTarget()
Section titled “visualHorizontalTarget()”visualHorizontalTarget(
offset,affinity,direction):VisualCaretTarget|null
Parameters
Section titled “Parameters”offset
Section titled “offset”number
affinity
Section titled “affinity”direction
Section titled “direction”"left" | "right"
Returns
Section titled “Returns”VisualCaretTarget | null