EditSession[edit]

Sets up a new EditSession and associates it with the given Document and TextMode.

Emitted when the document changes.

Emitted when a code fold added or removed.

Emitted when the scroll left changes.

Emitted when the scroll top changes.

Emitted when a background tokenizer asynchronousely processes new rows.

Adds a dynamic marker to the session.

Adds className to the row, to be used for CSS stylings and whatnot.

Adds a new marker to the given Range. If inFront is true, a front marker is defined, and the 'changeFrontMarker' event fires; otherwise, the 'changeBackMarker' event fires.

Clears all the annotations for this session. This function also triggers the 'changeAnnotation' event.

Removes a breakpoint on the row number given by rows. This function also emites the 'changeBreakpoint' event.

Removes all breakpoints on the rows. This function also emites the 'changeBreakpoint' event.

Converts document coordinates to screen coordinates. {:conversionConsiderations}

Duplicates all the text between firstRow and lastRow.

Returns the annotations for the EditSession.

Gets the range of a word, including its right whitespace.

Returns an array of numbers, indicating which rows have breakpoints.

Returns the Document associated with this session.

Returns the number of rows in the document.

Returns a verbatim copy of the given line as it is in the document

Returns an array of strings of the rows between firstRow and lastRow. This function is inclusive of lastRow.

Returns an array containing the IDs of all the markers, either front or back.

Returns the current text mode.

Returns the current new line mode.

Returns true if overwrites are enabled; false otherwise.

Returns number of screenrows in a wrapped line.

Returns the length of the screen.

The distance to the next tab stop at the specified screen column.

Returns the width of the screen.

[Returns the value of the distance between the left of the editor and the leftmost part of the visible content.]{: #EditSession.getScrollLeft}

[Returns the value of the distance between the top of the editor and the topmost part of the visible content.]{: #EditSession.getScrollTop}

Returns the string of the current selection.

{:BackgroundTokenizer.getState}

Returns the current tab size.

Returns the current value for tabs. If the user is using soft tabs, this will be a series of spaces (defined by getTabSize); otherwise it's simply '\t'.

{:Document.getTextRange.desc}

Returns an array of tokens at the indicated row and column.

Starts tokenizing at the row indicated. Returns a list of objects of the tokenized rows.

Returns the current undo manager.

Returns true if soft tabs are being used, false otherwise.

Returns true if workers are being used.

Returns true if wrap mode is being used; false otherwise.

Returns the current Document as a string.

Given a starting row and column, this method returns the Range of the first word boundary it finds.

Returns the value of wrap limit.

Returns an object that defines the minimum and maximum of the wrap limit; it looks something like this:

{ min: wrapLimitRange_min, max: wrapLimitRange_max }

Indents all the rows, from startRow to endRow (inclusive), by prefixing each row with the token in indentString.

If indentString contains the '\t' character, it's replaced by whatever is defined by getTabString.

Inserts a block of text and the indicated position.

Returns true if the character at the position is a soft tab.

Shifts all the lines in the document up one, starting from firstRow and ending at lastRow.

{ row: newRowLocation, column: newColumnLocation }

Reloads all the tokens on the current session. This function calls start to all the rows; it also emits the 'tokenizerUpdate' event.

Outdents all the rows defined by the start and end properties of range.

Re-implements a previously undone change to your document.

Removes the range from the document.

Removes className from the row.

Removes the marker with the specified ID. If this marker was in front, the 'changeFrontMarker' event is emitted. If the marker was in the back, the 'changeBackMarker' event is emitted.

Replaces a range in the document with the new text.

Converts characters coordinates on the screen to characters coordinates within the document. [This takes into account code folding, word wrap, tab size, and any other visual modifications.]{: #conversionConsiderations}

Sets annotations for the EditSession. This functions emits the 'changeAnnotation' event.

Sets a breakpoint on the row number given by rows. This function also emites the 'changeBreakpoint' event.

Sets a breakpoint on every row number given by rows. This function also emites the 'changeBreakpoint' event.

Sets the EditSession to point to a new Document. If a BackgroundTokenizer exists, it also points to doc.

Sets a new text mode for the EditSession. This method also emits the 'changeMode' event. If a BackgroundTokenizer is set, the 'tokenizerUpdate' event is also emitted.

{:Document.setNewLineMode.desc}

Pass in true to enable overwrites in your session, or false to disable. If overwrites is enabled, any text you enter will type over any text after it. If the value of overwrite changes, this function also emites the changeOverwrite event.

[Sets the value of the distance between the left of the editor and the leftmost part of the visible content.]{: #EditSession.setScrollLeft}

This function sets the scroll top value. It also emits the 'changeScrollTop' event.

Set the number of spaces that define a soft tab; for example, passing in 4 transforms the soft tabs to be equivalent to four spaces. This function also emits the changeTabSize event.

Sets the undo manager.

ENables or disables highlighting of the range where an undo occured.

Pass true to enable the use of soft tabs. Soft tabs means you're using spaces instead of the tab character ('\t').

Identifies if you want to use a worker for the EditSession.

Sets whether or not line wrapping is enabled. If useWrapMode is different than the current value, the 'changeWrapMode' event is emitted.

Sets the session text.

Sets the boundaries of wrap. Either value can be null to have an unconstrained wrap, or, they can be the same number to pin the limit. If the wrap limits for min or max are different, this method also emits the 'changeWrapMode' event.

Sets the value of overwrite to the opposite of whatever it currently is.

Returns the current Document as a string.

Reverts previous changes to your document.