Interface EditorMultiSelectProperties

interface EditorMultiSelectProperties {
    $blockSelectEnabled?: boolean;
    $checkMultiselectChange: (e: any, anchor: Anchor) => void;
    $multiselectOnSessionChange?: any;
    $onAddRange: (e: any) => void;
    $onMultiSelect: (e: any) => void;
    $onMultiSelectExec: (e: any) => void;
    $onRemoveRange: (e: any) => void;
    $onSingleSelect: (e: any) => void;
    $reAlignText: (lines: string[], forceLeft: boolean) => string[];
    addSelectionMarker: (
        orientedRange: Range & { marker?: any },
    ) => Range & { marker?: any };
    alignCursors: () => void;
    exitMultiSelectMode: () => void;
    findAll: (
        needle?: string,
        options?: Partial<SearchOptions>,
        additive?: boolean,
    ) => number;
    forEachSelection: (cmd: Object, args?: string, options?: Object) => void;
    getSelectedText: () => string;
    inMultiSelectMode?: boolean;
    multiSelect?: any;
    removeSelectionMarker: (range: Range & { marker?: any }) => void;
    removeSelectionMarkers: (ranges: (Range & { marker?: any })[]) => void;
    selectMore: (dir: number, skip?: boolean, stopAtFirst?: boolean) => void;
    selectMoreLines: (dir: number, skip?: boolean) => void;
    transposeSelections: (dir: number) => void;
    updateSelectionMarkers: () => void;
}

Hierarchy (View Summary)

  • EditorMultiSelectProperties

Properties

$blockSelectEnabled? $checkMultiselectChange $multiselectOnSessionChange? $onAddRange $onMultiSelect $onMultiSelectExec $onRemoveRange $onSingleSelect $reAlignText addSelectionMarker alignCursors exitMultiSelectMode findAll forEachSelection getSelectedText inMultiSelectMode? multiSelect? removeSelectionMarker removeSelectionMarkers selectMore selectMoreLines transposeSelections updateSelectionMarkers

Properties

Optional$blockSelectEnabled

$blockSelectEnabled?: boolean

$checkMultiselectChange

$checkMultiselectChange: (e: any, anchor: Anchor) => void

Optional$multiselectOnSessionChange

$multiselectOnSessionChange?: any

$onAddRange

$onAddRange: (e: any) => void

$onMultiSelect

$onMultiSelect: (e: any) => void

$onMultiSelectExec

$onMultiSelectExec: (e: any) => void

$onRemoveRange

$onRemoveRange: (e: any) => void

$onSingleSelect

$onSingleSelect: (e: any) => void

$reAlignText

$reAlignText: (lines: string[], forceLeft: boolean) => string[]

addSelectionMarker

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

Adds the selection and cursor.

Type declaration

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

    • Parameters

      • orientedRange: Range & { marker?: any }

        A range containing a cursor

      Returns Range & { marker?: any }

alignCursors

alignCursors: () => void

Aligns the cursors or selected text.

exitMultiSelectMode

exitMultiSelectMode: () => void

Removes all the selections except the last added one.

findAll

findAll: (
    needle?: string,
    options?: Partial<SearchOptions>,
    additive?: boolean,
) => number

Finds and selects all the occurrences of needle.

Type declaration

    • (needle?: string, options?: Partial<SearchOptions>, additive?: boolean): number

    • Parameters

      • Optionalneedle: string

        The text to find

      • Optionaloptions: Partial<SearchOptions>

        The search options

      • Optionaladditive: boolean

        keeps

      Returns number

      The cumulative count of all found matches

forEachSelection

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

Executes a command for each selection range.

Type declaration

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

    • Parameters

      • cmd: Object

        The command to execute

      • Optionalargs: string

        Any arguments for the command

      • Optionaloptions: Object

      Returns void

getSelectedText

getSelectedText: () => string

OptionalinMultiSelectMode

inMultiSelectMode?: boolean

OptionalmultiSelect

multiSelect?: any

removeSelectionMarker

removeSelectionMarker: (range: Range & { marker?: any }) => void

Removes the selection marker.

Type declaration

    • (range: Range & { marker?: any }): void

    • Parameters

      • range: Range & { marker?: any }

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

      Returns void

removeSelectionMarkers

removeSelectionMarkers: (ranges: (Range & { marker?: any })[]) => void

selectMore

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

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

Type declaration

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

    • Parameters

      • dir: number

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

      • Optionalskip: boolean

        If true, removes the active selection range

      • OptionalstopAtFirst: boolean

      Returns void

selectMoreLines

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

Adds a cursor above or below the active cursor.

Type declaration

    • (dir: number, skip?: boolean): void

    • Parameters

      • dir: number

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

      • Optionalskip: boolean

        If true, removes the active selection range

      Returns void

transposeSelections

transposeSelections: (dir: number) => void

Transposes the selected ranges.

Type declaration

    • (dir: number): void

    • Parameters

      • dir: number

        The direction to rotate selections

      Returns void

updateSelectionMarkers

updateSelectionMarkers: () => void

Updates the cursor and marker layers.

Settings

Member Visibility

On This Page

Properties