Enables occur mode. expects that options.needle
is a search term.
This search term is used to filter out all the lines that include it
and these are then used as the content of a new [[Document
Document
]]. The current cursor position of editor will be translated
so that the cursor is on the matching row/column as it was before.
options.needle should be a String
Whether occur activation was successful
Disables occur mode. Resets the [[Sessions EditSession
]] [[Document
Document
]] back to the original doc. If options.translatePosition is
truthy also maps the [[Editors Editor
]] cursor position accordingly.
options.translatePosition
Whether occur deactivation was successful
Searches for options.needle
. If found, this method returns the [[Range Range
]] where the text first occurs. If options.backwards
is true
, the search goes backwards in the session.
The session to search with
Searches for all occurrances options.needle
. If found, this method returns an array of [[Range Range
s]] where the text first occurs. If options.backwards
is true
, the search goes backwards in the session.
The session to search with
[Returns an object containing all the search options.]{: #Search.getOptions}
Translates the position from the occur document to the original document
or pos
if not found.
The occur session
The position in the occur session document
Translates the position from the original document to the occur lines in the document or the beginning if the doc {row: 0, column: 0} if not found.
The occur session
The position in the original document
position in occur doc
Searches for options.needle
in input
, and, if found, replaces it with replacement
.
The text to search in
The replacing text
options.regExp
is true
, this function returns input
with the replacement already made. Otherwise, this function just returns replacement
.options.needle
was not found, this function returns null
.Sets the search options via the options
parameter.
An object containing all the new search properties
Sets the search options via the options
parameter.
object containing all the search propertie
Finds all lines matching a search term in the current [[Document
Document
]] and displays them instead of the originalDocument
. Keeps track of the mapping between the occur doc and the original doc.