Class VirtualRenderer

constructor

• new VirtualRenderer(container?, theme?): VirtualRenderer

• Constructs a new VirtualRenderer within the container specified, applying the given theme.

  Parameters

  • Optional container: HTMLElement

    The root element of the editor

  • Optional theme: string

    The starting theme

  Returns VirtualRenderer

CHANGE_CURSOR

CHANGE_FULL

CHANGE_GUTTER

CHANGE_H_SCROLL

CHANGE_LINES

CHANGE_MARKER

CHANGE_MARKER_BACK

CHANGE_MARKER_FRONT

CHANGE_SCROLL

CHANGE_SIZE

CHANGE_TEXT

STEPS

canvas

characterWidth

container

content

cursorPos

desiredHeight

Optional destroyed

Optional enableKeyboardAccessibility

gutterWidth

Optional keyboardFocusClassName

layerConfig

lineHeight

margin

resizing

scrollBar

scrollBarH

scrollBarV

scrollLeft

scrollMargin

scrollTop

scroller

session

Optional showInvisibles

textarea

Optional theme

addEventListener

• addEventListener<K>(name, callback, capturing?): VirtualRendererEvents[K]

• Type Parameters

  • K extends keyof VirtualRendererEvents

  Parameters

  • name: K

  • callback: VirtualRendererEvents[K]

  • Optional capturing: boolean

  Returns VirtualRendererEvents[K]

addGutterDecoration

• addGutterDecoration(row, className): void

• Deprecated; (moved to [[EditSession]])

  Parameters

  • row: any

  • className: any

  Returns void

  Deprecated

addToken

• addToken(text, type, row, column?): void

• Parameters

  • text: string

  • type: string

  • row: number

  • Optional column: number

  Returns void

adjustWrapLimit

• adjustWrapLimit(): boolean

• Adjusts the wrap limit, which is the number of characters that can fit within the width of the edit area on screen.

  Returns boolean

alignCursor

• alignCursor(cursor, alignment?): number

• Parameters

  • cursor: Ace.Point

  • Optional alignment: number

  Returns number

animateScrolling

• animateScrolling(fromValue, callback?): void

• Parameters

  • fromValue: any

  • Optional callback: any

  Returns void

attachToShadowRoot

• attachToShadowRoot(): void

• Returns void

destroy

• destroy(): void

• Destroys the text and cursor layers for this renderer.

  Returns void

freeze

• freeze(): void

• Returns void

getAnimatedScroll

• getAnimatedScroll(): boolean

• Returns whether an animated scroll happens or not.

  Returns boolean

getContainerElement

• getContainerElement(): HTMLElement

• Returns the root element containing this renderer.

  Returns HTMLElement

getDisplayIndentGuides

• getDisplayIndentGuides(): boolean

• Returns boolean

getFadeFoldWidgets

• getFadeFoldWidgets(): boolean

• Returns boolean

getFirstFullyVisibleRow

• getFirstFullyVisibleRow(): number

• Returns the index of the first fully visible row. "Fully" here means that the characters in the row are not truncated; that the top and the bottom of the row are on the screen.

  Returns number

getFirstVisibleRow

• getFirstVisibleRow(): number

• [Returns the index of the first visible row.]{: #VirtualRenderer.getFirstVisibleRow}

  Returns number

getHScrollBarAlwaysVisible

• getHScrollBarAlwaysVisible(): boolean

• Returns whether the horizontal scrollbar is set to be always visible.

  Returns boolean

getHighlightGutterLine

• getHighlightGutterLine(): boolean

• Returns boolean

getHighlightIndentGuides

• getHighlightIndentGuides(): boolean

• Returns boolean

getLastFullyVisibleRow

• getLastFullyVisibleRow(): number

• Returns the index of the last fully visible row. "Fully" here means that the characters in the row are not truncated; that the top and the bottom of the row are on the screen.

  Returns number

getLastVisibleRow

• getLastVisibleRow(): number

• [Returns the index of the last visible row.]{: #VirtualRenderer.getLastVisibleRow}

  Returns number

getMouseEventTarget

• getMouseEventTarget(): HTMLElement

• Returns the element that the mouse events are attached to

  Returns HTMLElement

getOption

• getOption<K>(name): VirtualRendererOptions[K]

• Type Parameters

  • K extends keyof VirtualRendererOptions

  Parameters

  • name: K

  Returns VirtualRendererOptions[K]

getOptions

• getOptions(optionNames?): Partial<VirtualRendererOptions>

• Parameters

  • Optional optionNames: Partial<VirtualRendererOptions> | (keyof VirtualRendererOptions)[]

  Returns Partial<VirtualRendererOptions>

getPrintMarginColumn

• getPrintMarginColumn(): number

• Returns whether the print margin column is being shown or not.

  Returns number

getScrollBottomRow

• getScrollBottomRow(): number

• Returns the last visible row, regardless of whether it's fully visible or not.

  Returns number

getScrollLeft

• getScrollLeft(): number

• {:EditSession.getScrollLeft}

  Returns number

  Related

  EditSession.getScrollLeft

getScrollTop

• getScrollTop(): number

• {:EditSession.getScrollTop}

  Returns number

  Related

  EditSession.getScrollTop

getScrollTopRow

• getScrollTopRow(): number

• Returns the first visible row, regardless of whether it's fully visible or not.

  Returns number

getShowGutter

• getShowGutter(): boolean

• Returns true if the gutter is being shown.

  Returns boolean

getShowInvisibles

• getShowInvisibles(): boolean

• Returns whether invisible characters are being shown or not.

  Returns boolean

getShowPrintMargin

• getShowPrintMargin(): boolean

• Returns whether the print margin is being shown or not.

  Returns boolean

getTextAreaContainer

• getTextAreaContainer(): HTMLElement

• Returns the element to which the hidden text area is added.

  Returns HTMLElement

getTheme

• getTheme(): string

• [Returns the path of the current theme.]{: #VirtualRenderer.getTheme}

  Returns string

getVScrollBarAlwaysVisible

• getVScrollBarAlwaysVisible(): boolean

• Returns whether the horizontal scrollbar is set to be always visible.

  Returns boolean

hideComposition

• hideComposition(): void

• Hides the current composition.

  Returns void

hideCursor

• hideCursor(): void

• Hides the cursor icon.

  Returns void

hideTokensAfterPosition

• hideTokensAfterPosition(row, column): {
      type: string;
      value: string;
  }[]

• Parameters

  • row: any

  • column: any

  Returns {
      type: string;
      value: string;
  }[]

isScrollableBy

• isScrollableBy(deltaX, deltaY): boolean

• Returns true if you can still scroll by either parameter; in other words, you haven't reached the end of the file or line.

  Parameters

  • deltaX: number

    The x value to scroll by

  • deltaY: number

    The y value to scroll by

  Returns boolean

off

• off<K>(name, callback): void

• Type Parameters

  • K extends keyof VirtualRendererEvents

  Parameters

  • name: K

  • callback: VirtualRendererEvents[K]

  Returns void

on

• on<K>(name, callback, capturing?): VirtualRendererEvents[K]

• Type Parameters

  • K extends keyof VirtualRendererEvents

  Parameters

  • name: K

  • callback: VirtualRendererEvents[K]

  • Optional capturing: boolean

  Returns VirtualRendererEvents[K]

once

• once<K>(name, callback): void

• Type Parameters

  • K extends keyof VirtualRendererEvents

  Parameters

  • name: K

  • callback: VirtualRendererEvents[K]

  Returns void

pixelToScreenCoordinates

• pixelToScreenCoordinates(x, y): Ace.ScreenCoordinates

• Parameters

  • x: number

  • y: number

  Returns Ace.ScreenCoordinates

removeAllListeners

• removeAllListeners(name?): void

• Parameters

  • Optional name: string

  Returns void

removeDefaultHandler

• removeDefaultHandler(name, callback): void

• Parameters

  • name: string

  • callback: Function

  Returns void

removeEventListener

• removeEventListener<K>(name, callback): void

• Type Parameters

  • K extends keyof VirtualRendererEvents

  Parameters

  • name: K

  • callback: VirtualRendererEvents[K]

  Returns void

removeExtraToken

• removeExtraToken(row, column): void

• Parameters

  • row: any

  • column: any

  Returns void

removeGhostText

• removeGhostText(): void

• Returns void

removeGutterDecoration

• removeGutterDecoration(row, className): void

• Deprecated; (moved to [[EditSession]])

  Parameters

  • row: any

  • className: any

  Returns void

  Deprecated

removeListener

• removeListener<K>(name, callback): void

• Type Parameters

  • K extends keyof VirtualRendererEvents

  Parameters

  • name: K

  • callback: VirtualRendererEvents[K]

  Returns void

screenToTextCoordinates

• screenToTextCoordinates(x, y): Ace.Point

• Parameters

  • x: number

  • y: number

  Returns Ace.Point

scrollBy

• scrollBy(deltaX, deltaY): void

• Scrolls the editor across both x- and y-axes.

  Parameters

  • deltaX: number

    The x value to scroll by

  • deltaY: number

    The y value to scroll by

  Returns void

scrollCursorIntoView

• scrollCursorIntoView(cursor?, offset?, $viewMargin?): void

• Scrolls the cursor into the first visibile area of the editor

  Parameters

  • Optional cursor: Ace.Point

  • Optional offset: number

  • Optional $viewMargin: {
        bottom?: any;
        top?: any;
    }

    • Optional bottom?: any

    • Optional top?: any

  Returns void

scrollSelectionIntoView

• scrollSelectionIntoView(anchor, lead, offset?): void

• Parameters

  • anchor: Ace.Point

  • lead: Ace.Point

  • Optional offset: number

  Returns void

scrollTo

• scrollTo(x, y): void

• Scrolls the editor across both x- and y-axes.

  Parameters

  • x: number

    The x value to scroll to

  • y: number

    The y value to scroll to

  Returns void

scrollToLine

• scrollToLine(line, center, animate, callback?): void

• Gracefully scrolls the editor to the row indicated.

  Parameters

  • line: number

    A line number

  • center: boolean

    If true, centers the editor the to indicated line

  • animate: boolean

    If true animates scrolling

  • Optional callback: (() => void)

    Function to be called after the animation has finished

    • • (): void

      • Returns void

  Returns void

scrollToRow

• scrollToRow(row): void

• Gracefully scrolls from the top of the editor to the row indicated.

  Parameters

  • row: number

    A row id

  Returns void

  Related

  EditSession.setScrollTop

scrollToX

• scrollToX(scrollLeft): void

• Scrolls the editor across the x-axis to the pixel indicated.

  Parameters

  • scrollLeft: number

    The position to scroll to

  Returns void

scrollToY

• scrollToY(scrollTop): void

• Scrolls the editor to the y pixel indicated.

  Parameters

  • scrollTop: number

    The position to scroll to

  Returns void

setAnimatedScroll

• setAnimatedScroll(shouldAnimate): void

• Identifies whether you want to have an animated scroll or not.

  Parameters

  • shouldAnimate: boolean

    Set to true to show animated scrolls

  Returns void

setAnnotations

• setAnnotations(annotations): void

• Sets annotations for the gutter.

  Parameters

  • annotations: Annotation[]

    An array containing annotations

  Returns void

setCompositionText

• setCompositionText(text): void

• Parameters

  • text: string

    A string of text to use

    Sets the inner text of the current composition to text.

  Returns void

setCursorStyle

• setCursorStyle(style): void

• Parameters

  • style: string

  Returns void

setDefaultHandler

• setDefaultHandler(name, callback): void

• Parameters

  • name: string

  • callback: Function

  Returns void

setDisplayIndentGuides

• setDisplayIndentGuides(display): void

• Parameters

  • display: boolean

  Returns void

setFadeFoldWidgets

• setFadeFoldWidgets(show): void

• Parameters

  • show: boolean

  Returns void

setGhostText

• setGhostText(text, position?): void

• Parameters

  • text: string

  • Optional position: Ace.Point

  Returns void

setHScrollBarAlwaysVisible

• setHScrollBarAlwaysVisible(alwaysVisible): void

• Identifies whether you want to show the horizontal scrollbar or not.

  Parameters

  • alwaysVisible: boolean

    Set to true to make the horizontal scroll bar visible

  Returns void

setHighlightGutterLine

• setHighlightGutterLine(shouldHighlight): void

• Parameters

  • shouldHighlight: boolean

  Returns void

setHighlightIndentGuides

• setHighlightIndentGuides(highlight): void

• Parameters

  • highlight: boolean

  Returns void

setMargin

• setMargin(top?, bottom?, left?, right?): void

• Parameters

  • Optional top: number

  • Optional bottom: number

  • Optional left: number

  • Optional right: number

  Returns void

setMouseCursor

• setMouseCursor(cursorStyle): void

• Parameters

  • cursorStyle: string

    A css cursor style

  Returns void

setOption

• setOption<K>(name, value): void

• Type Parameters

  • K extends keyof VirtualRendererOptions

  Parameters

  • name: K

  • value: VirtualRendererOptions[K]

  Returns void

setOptions

• setOptions(optList): void

• Parameters

  • optList: Partial<VirtualRendererOptions>

  Returns void

setPadding

• setPadding(padding): void

• Sets the padding for all the layers.

  Parameters

  • padding: number

    A new padding value (in pixels)

  Returns void

setPrintMarginColumn

• setPrintMarginColumn(printMarginColumn): void

• Identifies whether you want to show the print margin column or not.

  Parameters

  • printMarginColumn: number

    Set to true to show the print margin column

  Returns void

setScrollMargin

• setScrollMargin(top?, bottom?, left?, right?): void

• Parameters

  • Optional top: number

  • Optional bottom: number

  • Optional left: number

  • Optional right: number

  Returns void

setSession

• setSession(session): void

• Associates the renderer with an [[EditSession EditSession]].

  Parameters

  • session: EditSession

    The session to associate with

  Returns void

setShowGutter

• setShowGutter(show): void

• Identifies whether you want to show the gutter or not.

  Parameters

  • show: boolean

    Set to true to show the gutter

  Returns void

setShowInvisibles

• setShowInvisibles(showInvisibles): void

• Identifies whether you want to show invisible characters or not.

  Parameters

  • showInvisibles: boolean

    Set to true to show invisibles

  Returns void

setShowPrintMargin

• setShowPrintMargin(showPrintMargin): void

• Identifies whether you want to show the print margin or not.

  Parameters

  • showPrintMargin: boolean

    Set to true to show the print margin

  Returns void

setStyle

• setStyle(style, include?): void

• [Adds a new class, style, to the editor.]{: #VirtualRenderer.setStyle}

  Parameters

  • style: string

    A class name

  • Optional include: boolean

  Returns void

setTheme

• setTheme(theme?, cb?): void

• [Sets a new theme for the editor. theme should exist, and be a directory path, like ace/theme/textmate.]{: #VirtualRenderer.setTheme}

  Parameters

  • Optional theme: string | Ace.Theme

    The path to a theme

  • Optional cb: (() => void)

    optional callback

    • • (): void

      • Returns void

  Returns void

setVScrollBarAlwaysVisible

• setVScrollBarAlwaysVisible(alwaysVisible): void

• Identifies whether you want to show the horizontal scrollbar or not.

  Parameters

  • alwaysVisible: boolean

    Set to true to make the horizontal scroll bar visible

  Returns void

showComposition

• showComposition(composition): void

• Parameters

  • composition: any

  Returns void

showCursor

• showCursor(): void

• Shows the cursor icon.

  Returns void

textToScreenCoordinates

• textToScreenCoordinates(row, column): {
      pageX: number;
      pageY: number;
  }

• Returns an object containing the pageX and pageY coordinates of the document position.

  Parameters

  • row: number

    The document row position

  • column: number

    The document column position

  Returns {
      pageX: number;
      pageY: number;
  }

  • pageX: number

  • pageY: number

unfreeze

• unfreeze(): void

• Returns void

unsetStyle

• unsetStyle(style): void

• [Removes the class style from the editor.]{: #VirtualRenderer.unsetStyle}

  Parameters

  • style: string

    A class name

  Returns void

updateBackMarkers

• updateBackMarkers(): void

• Schedules an update to all the back markers in the document.

  Returns void

updateBreakpoints

• updateBreakpoints(rows?): void

• Redraw breakpoints.

  Parameters

  • Optional rows: any

  Returns void

updateCharacterSize

• updateCharacterSize(): void

• Returns void

updateCursor

• updateCursor(): void

• Updates the cursor icon.

  Returns void

updateFontSize

• updateFontSize(): void

• Updates the font size.

  Returns void

updateFrontMarkers

• updateFrontMarkers(): void

• Schedules an update to all the front markers in the document.

  Returns void

updateFull

• updateFull(force?): void

• Triggers a full update of all the layers, for all the rows.

  Parameters

  • Optional force: boolean

    If true, forces the changes through

  Returns void

updateLines

• updateLines(firstRow, lastRow, force?): void

• Triggers a partial update of the text, from the range given by the two parameters.

  Parameters

  • firstRow: number

    The first row to update

  • lastRow: number

    The last row to update

  • Optional force: boolean

  Returns void

updateText

• updateText(): void

• Triggers a full update of the text, for all the rows.

  Returns void

visualizeBlur

• visualizeBlur(): void

• Blurs the current container.

  Returns void

visualizeFocus

• visualizeFocus(): void

• Focuses the current container.

  Returns void