Interface MultiSelectProperties

interface MultiSelectProperties {
    index?: number;
    inMultiSelectMode: boolean;
    rangeCount: number;
    rangeList: RangeList;
    ranges: Range[];
    addRange(range: Range, $blockChangeEvents?: boolean): any;
    getAllRanges(): Range[];
    joinSelections(): void;
    mergeOverlappingRanges(): void;
    rectangularRangeBlock(
        screenCursor: Ace.ScreenCoordinates,
        screenAnchor: Ace.ScreenCoordinates,
        includeEmptyLines?: boolean,
    ): Range[];
    splitIntoLines(): void;
    substractPoint(pos: Ace.Point): any;
    toggleBlockSelection(): void;
    toSingleRange(range?: Range): void;
}

Index

Properties

index? inMultiSelectMode rangeCount rangeList ranges

Methods

addRange getAllRanges joinSelections mergeOverlappingRanges rectangularRangeBlock splitIntoLines substractPoint toggleBlockSelection toSingleRange

Properties

`Optional`index

index?: number

inMultiSelectMode

inMultiSelectMode: boolean

rangeCount

rangeCount: number

rangeList

rangeList: RangeList

ranges

ranges: Range[]

Methods

addRange

addRange(range: Range, $blockChangeEvents?: boolean): any
Adds a range to a selection by entering multiselect mode, if necessary.
Parameters
- range: Range
  The new range to add
- Optional$blockChangeEvents: boolean
  Whether or not to block changing events
Returns any
- Defined in ace.d.ts:954

getAllRanges

getAllRanges(): Range[]
Returns a concatenation of all the ranges.

Returns Range[]
- Defined in ace.d.ts:970

joinSelections

joinSelections(): void
Returns void
- Defined in ace.d.ts:975

mergeOverlappingRanges

mergeOverlappingRanges(): void
Merges overlapping ranges ensuring consistency after changes

Returns void
- Defined in ace.d.ts:965

rectangularRangeBlock

rectangularRangeBlock(
    screenCursor: Ace.ScreenCoordinates,
    screenAnchor: Ace.ScreenCoordinates,
    includeEmptyLines?: boolean,
): Range[]
Gets list of ranges composing rectangular block on the screen
Parameters
- screenCursor: Ace.ScreenCoordinates
  The cursor to use
- screenAnchor: Ace.ScreenCoordinates
  The anchor to use
- OptionalincludeEmptyLines: boolean
  If true, this includes ranges inside the block which are empty due to clipping
Returns Range[]
- Defined in ace.d.ts:985

splitIntoLines

splitIntoLines(): void
Splits all the ranges into lines.

Returns void
- Defined in ace.d.ts:974

substractPoint

substractPoint(pos: Ace.Point): any
Removes a Range containing pos (if it exists).
Parameters
- pos: Ace.Point
  The position to remove, as a {row, column} object
Returns any
- Defined in ace.d.ts:961

toggleBlockSelection

toggleBlockSelection(): void
Returns void
- Defined in ace.d.ts:976

toSingleRange

toSingleRange(range?: Range): void
Parameters
- Optionalrange: Range
Returns void
- Defined in ace.d.ts:956