Ace API Reference
    Preparing search index...

    Class Occur

    Finds all lines matching a search term in the current [[Document Document]] and displays them instead of the original Document. Keeps track of the mapping between the occur doc and the original doc.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    $options: Partial<Ace.SearchOptions>
    $originalSession: EditSession
    $useEmacsStyleLineStart: boolean

    Methods

    • Parameters

      • session: EditSession
      • options: any

      Returns false | { forEach: (callback: any) => void }

    • Parameters

      • session: any
      • re: any
      • endIndex: any
      • start: any
      • first: any

      Returns { endCol: any; endRow: number; startCol: any; startRow: any }

    • Parameters

      • session: any
      • re: any
      • start: any
      • last: any

      Returns { endCol: any; endRow: number; startCol: any; startRow: number }

    • Parameters

      • editor: Editor

      Returns void

    • 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.

      Parameters

      • editor: Editor
      • options: any

        options.needle should be a String

      Returns boolean

      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.

      Parameters

      • editor: Editor
      • options: any

        options.translatePosition

      Returns boolean

      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.

      Parameters

      • session: EditSession

        The session to search with

      Returns false | Range

    • Searches for all occurrances options.needle. If found, this method returns an array of [[Range Ranges]] where the text first occurs. If options.backwards is true, the search goes backwards in the session.

      Parameters

      • session: EditSession

        The session to search with

      Returns Range[]

    • Parameters

      • sess: EditSession
      • regexp: RegExp

      Returns void

    • Translates the position from the occur document to the original document or pos if not found.

      Parameters

      • session: EditSession

        The occur session

      • pos: Ace.Point

        The position in the occur session document

      Returns Ace.Point

      position

    • 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.

      Parameters

      • session: EditSession

        The occur session

      • pos: Ace.Point

        The position in the original document

      Returns Ace.Point

      position in occur doc

    • Searches for options.needle in input, and, if found, replaces it with replacement.

      Parameters

      • input: string

        The text to search in

      • replacement: any

        The replacing text

        • (String): If options.regExp is true, this function returns input with the replacement already made. Otherwise, this function just returns replacement.
          If options.needle was not found, this function returns null.

      Returns string