Interface MultiSelectProperties

Optional_eventRegistry

Optionalindex

inMultiSelectMode

rangeCount

rangeList

ranges

$initRangeList

• $initRangeList(): void

• adds multicursor support to selection

  Returns void

$onAddRange

• $onAddRange(range: Range): void

• Parameters

  • range: Range

  Returns void

$onRemoveRange

• $onRemoveRange(removed: Range[]): void

• Parameters

  • removed: Range[]

  Returns void

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

getAllRanges

• getAllRanges(): Range[]

• Returns a concatenation of all the ranges.

  Returns Range[]

joinSelections

• joinSelections(): void

• Returns void

mergeOverlappingRanges

• mergeOverlappingRanges(): void

• Merges overlapping ranges ensuring consistency after changes

  Returns void

rectangularRangeBlock

• rectangularRangeBlock(
      screenCursor: ScreenCoordinates,
      screenAnchor: ScreenCoordinates,
      includeEmptyLines?: boolean,
  ): Range[]

• Gets list of ranges composing rectangular block on the screen

  Parameters

  • screenCursor: ScreenCoordinates

    The cursor to use
  • screenAnchor: ScreenCoordinates

    The anchor to use
  • OptionalincludeEmptyLines: boolean

    If true, this includes ranges inside the block which are empty due to clipping

  Returns Range[]

splitIntoLines

• splitIntoLines(): void

• Splits all the ranges into lines.

  Returns void

substractPoint

• substractPoint(pos: Point): any

• Removes a Range containing pos (if it exists).

  Parameters

  • pos: Point

    The position to remove, as a {row, column} object

  Returns any

toggleBlockSelection

• toggleBlockSelection(): void

• Returns void

toSingleRange

• toSingleRange(range?: Range): void

• Parameters

  • Optionalrange: Range

  Returns void