Interface EditorMultiSelectProperties

interface EditorMultiSelectProperties {
    addSelectionMarker: ((orientedRange) => Range & {
        marker?: any;
    });
    alignCursors: (() => void);
    exitMultiSelectMode: (() => void);
    findAll: ((needle?, options?, additive?) => number);
    forEachSelection: ((cmd, args?, options?) => void);
    getSelectedText: (() => string);
    inMultiSelectMode?: boolean;
    multiSelect?: any;
    removeSelectionMarker: ((range) => void);
    removeSelectionMarkers: ((ranges) => void);
    selectMore: ((dir, skip?, stopAtFirst?) => void);
    selectMoreLines: ((dir, skip?) => void);
    transposeSelections: ((dir) => void);
    updateSelectionMarkers: (() => void);
}

Properties

addSelectionMarker alignCursors exitMultiSelectMode findAll forEachSelection getSelectedText inMultiSelectMode? multiSelect? removeSelectionMarker removeSelectionMarkers selectMore selectMoreLines transposeSelections updateSelectionMarkers

Properties

addSelectionMarker

addSelectionMarker: ((orientedRange) => Range & {
    marker?: any;
})

Adds the selection and cursor.

Type declaration

    • (orientedRange): Range & {
          marker?: any;
      }

    • Adds the selection and cursor.

      Parameters

      • orientedRange: Range & {
            marker?: any;
        }

        A range containing a cursor

      Returns Range & {
          marker?: any;
      }

Param: orientedRange

A range containing a cursor

alignCursors

alignCursors: (() => void)

Aligns the cursors or selected text.

Type declaration

    • (): void

    • Aligns the cursors or selected text.

      Returns void

exitMultiSelectMode

exitMultiSelectMode: (() => void)

Removes all the selections except the last added one.

Type declaration

    • (): void

    • Removes all the selections except the last added one.

      Returns void

findAll

findAll: ((needle?, options?, additive?) => number)

Finds and selects all the occurrences of needle.

Type declaration

    • (needle?, options?, additive?): number

    • Finds and selects all the occurrences of needle.

      Parameters

      • Optional needle: string

        The text to find

      • Optional options: Partial<Ace.SearchOptions>

        The search options

      • Optional additive: boolean

        keeps

      Returns number

      The cumulative count of all found matches

Param: needle

The text to find

Param: options

The search options

Param: additive

keeps

Returns

The cumulative count of all found matches

forEachSelection

forEachSelection: ((cmd, args?, options?) => void)

Executes a command for each selection range.

Type declaration

    • (cmd, args?, options?): void

    • Executes a command for each selection range.

      Parameters

      • cmd: Object

        The command to execute

      • Optional args: string

        Any arguments for the command

      • Optional options: Object

      Returns void

Param: cmd

The command to execute

Param: args

Any arguments for the command

getSelectedText

getSelectedText: (() => string)

Type declaration

    • (): string

    • Returns string

Optional inMultiSelectMode

inMultiSelectMode?: boolean

Optional multiSelect

multiSelect?: any

removeSelectionMarker

removeSelectionMarker: ((range) => void)

Removes the selection marker.

Type declaration

    • (range): void

    • Removes the selection marker.

      Parameters

      • range: Range & {
            marker?: any;
        }

        The selection range added with [[Editor.addSelectionMarker addSelectionMarker()]].

      Returns void

Param: range

The selection range added with [[Editor.addSelectionMarker addSelectionMarker()]].

removeSelectionMarkers

removeSelectionMarkers: ((ranges) => void)

Type declaration

    • (ranges): void

    • Parameters

      • ranges: (Range & {
            marker?: any;
        })[]

      Returns void

selectMore

selectMore: ((dir, skip?, stopAtFirst?) => void)

Finds the next occurrence of text in an active selection and adds it to the selections.

Type declaration

    • (dir, skip?, stopAtFirst?): void

    • Finds the next occurrence of text in an active selection and adds it to the selections.

      Parameters

      • dir: number

        The direction of lines to select: -1 for up, 1 for down

      • Optional skip: boolean

        If true, removes the active selection range

      • Optional stopAtFirst: boolean

      Returns void

Param: dir

The direction of lines to select: -1 for up, 1 for down

Param: skip

If true, removes the active selection range

selectMoreLines

selectMoreLines: ((dir, skip?) => void)

Adds a cursor above or below the active cursor.

Type declaration

    • (dir, skip?): void

    • Adds a cursor above or below the active cursor.

      Parameters

      • dir: number

        The direction of lines to select: -1 for up, 1 for down

      • Optional skip: boolean

        If true, removes the active selection range

      Returns void

Param: dir

The direction of lines to select: -1 for up, 1 for down

Param: skip

If true, removes the active selection range

transposeSelections

transposeSelections: ((dir) => void)

Transposes the selected ranges.

Type declaration

    • (dir): void

    • Transposes the selected ranges.

      Parameters

      • dir: number

        The direction to rotate selections

      Returns void

Param: dir

The direction to rotate selections

updateSelectionMarkers

updateSelectionMarkers: (() => void)

Updates the cursor and marker layers.

Type declaration

    • (): void

    • Updates the cursor and marker layers.

      Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc