This method embeds the Ace editor into the DOM, at the element provided by el.
| el | String | DOMElement | Required. Either the id of an element, or the element itself |
Fires whenever the anchor position changes. Events that can trigger this function include 'insertText', 'insertLines', 'removeText', and 'removeLines'.
Fires whenever the anchor position changes. Events that can trigger this function include 'insertText', 'insertLines', 'removeText', and 'removeLines'.
| e | Event | Required. Contains data about the event |
When called, the 'change' event listener is removed.
When called, the 'change' event listener is removed.
Returns the current document.
+Returns the current document.
+Returns an object identifying the row and column position of the current anchor.
Returns an object identifying the row and column position of the current anchor.
Sets the anchor position to the specified row and column. If noClip is true, the position is not clipped.
Sets the anchor position to the specified row and column. If noClip is true, the position is not clipped.
| row | Number | Required. The row index to move the anchor to |
| column | Number | Required. The column index to move the anchor to |
| noClip | Boolean | Required. Identifies if you want the position to be clipped |
Emits the 'update' event. firstRow and lastRow are used to define the boundaries of the region to be updated.
Stops tokenizing.
+Stops tokenizing.
+Applies all the changes previously accumulated. These can be either 'includeText', 'insertLines', 'removeText', and 'removeLines'.
Applies all the changes previously accumulated. These can be either 'includeText', 'insertLines', 'removeText', and 'removeLines'.
Returns all lines in the document as string array. Warning: The caller should not modify this array!
+Returns all lines in the document as string array. Warning: The caller should not modify this array!
+Returns the number of rows in the document.
+Returns the number of rows in the document.
+Returns an array of strings of the rows between firstRow and lastRow. This function is inclusive of lastRow.
Returns the newline character that's being used, depending on the value of newLineMode.
Returns the newline character that's being used, depending on the value of newLineMode.
Returns the type of newlines being used; either windows, unix, or auto
Returns the type of newlines being used; either windows, unix, or auto
Given a range within the document, this function returns all the text within that range as a single string.
+Given a range within the document, this function returns all the text within that range as a single string.
+| range | Range | Required. The range to work with |
Returns all the lines in the document as a single string, split by the new line character.
+Returns all the lines in the document as a single string, split by the new line character.
+Inserts the elements in lines into the document, starting at the row index given by row. This method also triggers the 'change' event.
Inserts a new line into the document at the current row's position. This method also triggers the 'change' event.
Inserts a new line into the document at the current row's position. This method also triggers the 'change' event.
| position | String | Required. The position to insert at |
Removes the specified columns from the row. This method also triggers the 'change' event.
Removes the new line between row and the row immediately following it. This method also triggers the 'change' event.
Removes the new line between row and the row immediately following it. This method also triggers the 'change' event.
| row | Number | Required. The row to check |
Reverts any changes previously applied. These can be either 'includeText', 'insertLines', 'removeText', and 'removeLines'.
Reverts any changes previously applied. These can be either 'includeText', 'insertLines', 'removeText', and 'removeLines'.
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.
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.
| markerId | Number | Required. A number representing a marker |
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.
+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.
+| screenRow | Number | Required. The screen row to check |
| screenColumn | Number | Required. The screen column to check |
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 a breakpoint on every row number given by rows. This function also emites the 'changeBreakpoint' event.
| rows | Array | Required. An array of row indicies |
Sets the EditSession to point to a new Document. If a BackgroundTokenizer exists, it also points to doc.
Sets the EditSession to point to a new Document. If a BackgroundTokenizer exists, it also points to doc.
| doc | Document | Required. The new Document to use |
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.
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.
| mode | TextMode | Required. Set a new text mode |
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.
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.
| overwrite | Boolean | Required. Defines wheter or not to set overwrites |
Sets the value of the distance between the left of the editor and the leftmost part of the visible content.
+Sets the value of the distance between the left of the editor and the leftmost part of the visible content.
+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.
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.
| tabSize | Number | Required. The new tab size |
Sets the undo manager.
+Pass true to enable the use of soft tabs. Soft tabs means you're using spaces instead of the tab character ('\t').
Pass true to enable the use of soft tabs. Soft tabs means you're using spaces instead of the tab character ('\t').
| useSoftTabs | Boolean | Required. Value indicating whether or not to use soft tabs |
Sets whether or not line wrapping is enabled. If useWrapMode is different than the current value, the 'changeWrapMode' event is emitted.
Sets whether or not line wrapping is enabled. If useWrapMode is different than the current value, the 'changeWrapMode' event is emitted.
| useWrapMode | Boolean | Required. Enable (or disable) wrap mode |
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 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.
| min | Number | Required. The minimum wrap value (the left side wrap) |
| max | Number | Required. The maximum wrap value (the right side wrap) |
Sets the value of overwrite to the opposite of whatever it currently is.
+Sets the value of overwrite to the opposite of whatever it currently is.
+Moves the cursor to the end of the current file. Note that this does de-select the current selection.
+Moves the cursor to the start of the current file. Note that this does de-select the current selection.
+Moves the cursor to the end of the current line. Note that this does de-select the current selection.
+Moves the cursor to the start of the current line. Note that this does de-select the current selection.
+Moves the cursor to the word immediately to the left of the current position. Note that this does de-select the current selection.
+Moves the cursor to the word immediately to the right of the current position. Note that this does de-select the current selection.
+Called whenever a text "copy" happens.
+Called whenever a text "copy" happens.
+called whenever a text "cut" happens.
+called whenever a text "cut" happens.
+called whenever a text "paste" happens.
+called whenever a text "paste" happens.
+Perform a redo operation on the document, reimplementing the last change.
+Perform a redo operation on the document, reimplementing the last change.
+Removes words of text from the editor. A "word" is defined as a string of characters bookended by whitespace.
+Removes words of text from the editor. A "word" is defined as a string of characters bookended by whitespace.
+| dir | String | Required. The direction of the deletion to occur, either "left" or "right" |
Removes all the lines in the current selection
+Removes all the lines in the current selection
+Removes the selection marker.
+Removes the selection marker.
+| range | Range | Required. The selection range added with addSelectionMarker. |
Removes all the words to the right of the current selection, until the end of the line.
+Removes all the words to the right of the current selection, until the end of the line.
+Removes all the words to the left of the current selection, until the start of the line.
+Removes all the words to the left of the current selection, until the start of the line.
+Removes the word directly to the left of the current selection.
+Removes the word directly to the left of the current selection.
+Removes the word directly to the right of the current selection.
+Removes the word directly to the right of the current selection.
+Triggers a resize of the editor.
+Triggers a resize of the editor.
+Scrolls the document to wherever "page down" is, without changing the cursor position.
+Scrolls the document to wherever "page down" is, without changing the cursor position.
+Scrolls the document to wherever "page up" is, without changing the cursor position.
+Scrolls the document to wherever "page up" is, without changing the cursor position.
+TODO scrolls a to line, if center == true, puts line in middle of screen or attempts to)
+Selects all the text in editor.
+Selects all the text in editor.
+Finds the next occurence of text in an active selection and adds it to the selections.
+Selects the text from the current position of the document until where a "page down" finishes.
+Selects the text from the current position of the document until where a "page down" finishes.
+Selects the text from the current position of the document until where a "page up" finishes.
+Selects the text from the current position of the document until where a "page up" finishes.
+Specifies whether to use behaviors or not. "Behaviors" in this case is the auto-pairing of special characters, like quotation marks, parenthesis, or brackets.
+Specifies whether to use behaviors or not. "Behaviors" in this case is the auto-pairing of special characters, like quotation marks, parenthesis, or brackets.
+| enabled | Boolean | Required. Enables or disables behaviors |
Sets a new keyboard handler.
+Sets a new keyboard handler.
+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.
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.
| overwrite | Boolean | Required. Defines wheter or not to set overwrites |
If readOnly is true, then the editor is set to read-only mode, and none of the content can change.
If readOnly is true, then the editor is set to read-only mode, and none of the content can change.
| readOnly | Boolean | Required. Specifies whether the editor can be modified or not |
Indicates how selections should occur. By default, selections are set to "line". This function also emits the 'changeSelectionStyle' event.
Indicates how selections should occur. By default, selections are set to "line". This function also emits the 'changeSelectionStyle' event.
| style | String | Required. The new selection style |
Sets a new editsession to use. This method also emits the 'changeSession' event.
Sets a new editsession to use. This method also emits the 'changeSession' event.
| session | EditSession | Required. The new session to use |
If showInvisibiles is set to true, invisible characters—like spaces or new lines—are show in the editor.
If showInvisibiles is set to true, invisible characters—like spaces or new lines—are show in the editor.
| showInvisibles | Boolean | Required. Specifies whether or not to show invisible characters |
Adds a new class, style, to the editor.
Adds a new class, style, to the editor.
Sets a new theme for the editor. theme should exist, and be a directory path, like ace/theme/textmate.
Sets a new theme for the editor. theme should exist, and be a directory path, like ace/theme/textmate.
Splits the line at the current selection (by inserting an '\n').
Splits the line at the current selection (by inserting an '\n').
Given the currently selected range, this function either comments all lines or uncomments all lines (depending on whether it's commented or not).
+Given the currently selected range, this function either comments all lines or uncomments all lines (depending on whether it's commented or not).
+Sets the value of overwrite to the opposite of whatever it currently is.
+Sets the value of overwrite to the opposite of whatever it currently is.
+Converts the current selection entirely into lowercase.
+Converts the current selection entirely into lowercase.
+Converts the current selection entirely into uppercase.
+Converts the current selection entirely into uppercase.
+Transposes current line.
+Transposes current line.
+Perform an undo operation on the document, reverting the last change. Returns the range of the undo.
+Perform an undo operation on the document, reverting the last change. Returns the range of the undo.
+Removes the class style from the editor.
Removes the class style from the editor.
Updates the cursor and marker layers.
+Updates the cursor and marker layers.
+Emitted when the cursor changes.
+Emitted when the cursor changes.
+Emitted when the place holder updates.
+Emitted when the place holder updates.
+TODO
+TODO
+TODO
+TODO
+Hides all over markers in the EditSession that are not the currently selected one.
+Hides all over markers in the EditSession that are not the currently selected one.
+TODO
+TODO
+TODO
+TODO
+Creates a new ScrollBar. parent is the owner of the scroll bar.
Creates a new ScrollBar. parent is the owner of the scroll bar.
| parent | DOMElement | Required. A DOM element |
Emitted when the scroll bar, well, scrolls.
+Emitted when the scroll bar, well, scrolls.
+Returns the width of the scroll bar.
+Returns the width of the scroll bar.
+| session | EditSession | Required. The session to search with |
Searches for options.needle. If found, this method returns the Range where the text first occurs. If options.backwards is true, the search goes backwards in the session.
Searches for options.needle. If found, this method returns the Range where the text first occurs. If options.backwards is true, the search goes backwards in the session.
| session | EditSession | Required. The session to search with |
Searches for all occurances options.needle. If found, this method returns an array of Range where the text first occurs. If options.backwards is true, the search goes backwards in the session.
Searches for all occurances options.needle. If found, this method returns an array of Range where the text first occurs. If options.backwards is true, the search goes backwards in the session.
| session | EditSession | Required. The session to search with |
Returns an object containing all the search options.
+Returns an object containing all the search options.
+Creates a new Selection object.
Empties the selection (by de-selecting it). This function also emits the 'changeSelection' event.
Empties the selection (by de-selecting it). This function also emits the 'changeSelection' event.
Gets the current position of the cursor.
+Gets the current position of the cursor.
+Returns an object containing the row and column of the calling selection anchor.
Returns an object containing the row and column of the calling selection anchor.
Returns an object containing the row and column of the calling selection lead.
Returns an object containing the row and column of the calling selection lead.
Returns true if the selection is going backwards in the document.
Returns true if the selection is going backwards in the document.
Returns true if the selection is empty.
Returns true if the selection is empty.
Returns true if the selection is a multi-line.
Returns true if the selection is a multi-line.
Merges overlapping ranges ensuring consistency after changes
+Merges overlapping ranges ensuring consistency after changes
+Moves the cursor to position indicated by the parameters. Negative numbers move the cursor backwards in the document.
+Moves the cursor down one row.
+Moves the cursor down one row.
+Moves the cursor to the end of the file.
+Moves the cursor to the end of the file.
+Moves the cursor to the start of the file.
+Moves the cursor to the start of the file.
+Moves the cursor left one column.
+Moves the cursor left one column.
+Moves the cursor to the end of the line.
+Moves the cursor to the end of the line.
+Moves the cursor to the start of the line.
+Moves the cursor to the start of the line.
+Moves the cursor to the word on the left.
+Moves the cursor to the word on the left.
+Moves the cursor to the word on the right.
+Moves the cursor to the word on the right.
+Moves the cursor right one column.
+Moves the cursor right one column.
+Moves the cursor to the row and column provided. If preventUpdateDesiredColumn is true, then the cursor stays in the same column position as its original point.
Moves the cursor to the row and column provided. If preventUpdateDesiredColumn is true, then the cursor stays in the same column position as its original point.
| row | Number | Required. The row to move to |
| column | Number | Required. The column to move to |
| keepDesiredColumn | Boolean | Required. If true, the cursor move does not respect the previous column |
Moves the cursor to the screen position indicated by row and column. If preventUpdateDesiredColumn is true, then the cursor stays in the same column position as its original point.
Moves the cursor to the screen position indicated by row and column. If preventUpdateDesiredColumn is true, then the cursor stays in the same column position as its original point.
| row | Number | Required. The row to move to |
| column | Number | Required. The column to move to |
| keepDesiredColumn | Boolean | Required. If true, the cursor move does not respect the previous column |
Moves the cursor up one row.
+Moves the cursor up one row.
+Gets list of ranges composing rectangular block on the screen
+Selects all the text in the document.
+Selects all the text in the document.
+Selects a word, including its right whitespace.
+Selects a word, including its right whitespace.
+Moves the selection down one row.
+Moves the selection down one row.
+Moves the selection to the end of the file.
+Moves the selection to the end of the file.
+Moves the selection to the start of the file.
+Moves the selection to the start of the file.
+Moves the selection left one column.
+Moves the selection left one column.
+Selects the entire line.
+Selects the entire line.
+Moves the selection to the end of the current line.
+Moves the selection to the end of the current line.
+Moves the selection to the beginning of the current line.
+Moves the selection to the beginning of the current line.
+Moves the selection right one column.
+Moves the selection right one column.
+Moves the selection up one row.
+Moves the selection up one row.
+Moves the selection to highlight the entire word.
+Moves the selection to highlight the entire word.
+Moves the selection to the first word on the left.
+Moves the selection to the first word on the left.
+Moves the selection to the first word on the right.
+Moves the selection to the first word on the right.
+Shifts the selection up (or down, if isBackwards is true) the given number of columns.
+Shifts the selection up (or down, if isBackwards is true) the given number of columns.
+| columns | Number | Required. The number of columns to shift by |
Creates a new token iterator object. The inital token index is set to the provided row and column coordinates.
+Creates a new token iterator object. The inital token index is set to the provided row and column coordinates.
+| session | EditSession | Required. The session to associate with |
| initialRow | Number | Required. The row to start the tokenizing at |
| initialColumn | Number | Required. The column to start the tokenizing at |
Returns the current tokenized string.
+Returns the current tokenized string.
+Returns the current column.
+Returns the current column.
+Returns the current row.
+Returns the current row.
+Tokenizes all the items from the current point to the row prior in the document.
+Tokenizes all the items from the current point to the row prior in the document.
+Tokenizes all the items from the current point until the next row in the document. If the current point is at the end of the file, this function returns null. Otherwise, it returns the tokenized string.
Tokenizes all the items from the current point until the next row in the document. If the current point is at the end of the file, this function returns null. Otherwise, it returns the tokenized string.
Returns an object containing two properties: tokens, which contains all the tokens; and state, the current state.
Returns an object containing two properties: tokens, which contains all the tokens; and state, the current state.
Returns true if there are redo operations left to perform.
Returns true if there are redo operations left to perform.
Returns true if there are undo operations left to perform.
Returns true if there are undo operations left to perform.
Destroys the stack of undo and redo redo operations.
+Destroys the stack of undo and redo redo operations.
+Perform an undo operation on the document, reverting the last change. Returns the range of the undo.
+Perform an undo operation on the document, reverting the last change. Returns the range of the undo.
+| dontSelect | Boolean | Required. If true, doesn't select the range of where the change occured |
Constructs a new VirtualRenderer within the container specified, applying the given theme.
Constructs a new VirtualRenderer within the container specified, applying the given theme.
| container | DOMElement | Required. The root element of the editor |
| theme | String | Required. The starting theme |
Deprecated (moved to EditSession)
+Deprecated (moved to EditSession)
+Adjusts the wrap limit, which is the number of characters that can fit within the width of the edit area on screen.
+Adjusts the wrap limit, which is the number of characters that can fit within the width of the edit area on screen.
+Destroys the text and cursor layers for this renderer.
+Destroys the text and cursor layers for this renderer.
+Returns whether an animated scroll happens or not.
+Returns whether an animated scroll happens or not.
+Returns the root element containing this renderer.
+Returns the root element containing this renderer.
+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 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 the index of the first visible row.
+Returns the index of the first visible row.
+Returns whether the horizontal scrollbar is set to be always visible.
+Returns whether the horizontal scrollbar is set to be always visible.
+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 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 the index of the last visible row.
+Returns the index of the last visible row.
+Returns the element that the mouse events are attached to
+Returns the element that the mouse events are attached to
+Returns whether the print margin column is being shown or not.
+Returns whether the print margin column is being shown or not.
+Returns the last visible row, regardless of whether it's fully visible or not.
+Returns the last visible row, regardless of whether it's fully visible or not.
+Returns the value of the distance between the left of the editor and the leftmost part of the visible content.
+Returns the value of the distance between the left of the editor and the leftmost part of the visible content.
+Returns the value of the distance between the top of the editor and the topmost part of the visible content.
+Returns the value of the distance between the top of the editor and the topmost part of the visible content.
+Returns the first visible row, regardless of whether it's fully visible or not.
+Returns the first visible row, regardless of whether it's fully visible or not.
+Returns true if the gutter is being shown.
Returns true if the gutter is being shown.
Returns whether invisible characters are being shown or not.
+Returns whether invisible characters are being shown or not.
+Returns whetherthe print margin is being shown or not.
+Returns whetherthe print margin is being shown or not.
+Returns the element to which the hidden text area is added.
+Returns the element to which the hidden text area is added.
+Returns the path of the current theme.
+Returns the path of the current theme.
+Hides the current composition.
+Hides the current composition.
+Hides the cursor icon.
+Hides the cursor icon.
+Returns true if you can still scroll by either parameter; in other words, you haven't reached the end of the file or line.
Deprecated (moved to EditSession)
+Deprecated (moved to EditSession)
+Scrolls the cursor into the first visibile area of the editor
+Scrolls the cursor into the first visibile area of the editor
+Gracefully scrolls the editor to the row indicated.
+Identifies whether you want to show the horizontal scrollbar or not.
+Identifies whether you want to show the horizontal scrollbar or not.
+| alwaysVisible | Boolean | Required. Set to true to make the horizontal scroll bar visible |
Sets a new theme for the editor. theme should exist, and be a directory path, like ace/theme/textmate.
Sets a new theme for the editor. theme should exist, and be a directory path, like ace/theme/textmate.
| theme | String | Required. The path to a theme |
Shows the cursor icon.
+Shows the cursor icon.
+Schedules an update to all the back markers in the document.
+Schedules an update to all the back markers in the document.
+Redraw breakpoints.
+Redraw breakpoints.
+Updates the cursor icon.
+Updates the cursor icon.
+Updates the font size.
+Updates the font size.
+Schedules an update to all the front markers in the document.
+Schedules an update to all the front markers in the document.
+Triggers a full update of all the layers, for all the rows.
+Triggers a full update of all the layers, for all the rows.
+Triggers a full update of the text, for all the rows.
+Triggers a full update of the text, for all the rows.
+Blurs the current container.
+Blurs the current container.
+Focuses the current container.
+Focuses the current container.
+