Class Selection

constructor

• new Selection(session: EditSession): Selection

• Creates a new Selection object.

  Parameters

  • session: EditSession

    The session to use

  Returns Selection

Optional_eventRegistry

anchor

cursor

doc

getSelectionAnchor

Optionalindex

inMultiSelectMode

lead

rangeCount

rangeList

ranges

session

setSelectionAnchor

setSelectionRange

_dispatchEvent

• _dispatchEvent<K extends keyof MultiSelectionEvents>(
      eventName: K,
      ...args: Parameters<MultiSelectionEvents[K]>,
  ): void

• Type Parameters

  • K extends keyof MultiSelectionEvents

  Parameters

  • eventName: K
  • ...args: Parameters<MultiSelectionEvents[K]>

  Returns void

_emit

• _emit<K extends keyof MultiSelectionEvents>(
      eventName: K,
      ...args: Parameters<MultiSelectionEvents[K]>,
  ): void

• Type Parameters

  • K extends keyof MultiSelectionEvents

  Parameters

  • eventName: K
  • ...args: Parameters<MultiSelectionEvents[K]>

  Returns void

_signal

• _signal<K extends keyof MultiSelectionEvents>(
      eventName: K,
      ...args: Parameters<MultiSelectionEvents[K]>,
  ): void

• Type Parameters

  • K extends keyof MultiSelectionEvents

  Parameters

  • eventName: K
  • ...args: Parameters<MultiSelectionEvents[K]>

  Returns void

$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

addEventListener

• addEventListener<K extends keyof MultiSelectionEvents>(
      name: K,
      callback: MultiSelectionEvents[K],
      capturing?: boolean,
  ): MultiSelectionEvents[K]

• Type Parameters

  • K extends keyof MultiSelectionEvents

  Parameters

  • name: K
  • callback: MultiSelectionEvents[K]
  • Optionalcapturing: boolean

  Returns MultiSelectionEvents[K]

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

clearSelection

• clearSelection(): void

• [Empties the selection (by de-selecting it). This function also emits the 'changeSelection' event.]{: #Selection.clearSelection}

  Returns void

detach

• detach(): void

• Returns void

fromJSON

• fromJSON(data: any): void

• Parameters

  • data: any

  Returns void

fromOrientedRange

• fromOrientedRange(range: Range & { desiredColumn?: number }): void

• Parameters

  • range: Range & { desiredColumn?: number }

  Returns void

getAllRanges

• getAllRanges(): Range[]

• Returns a concatenation of all the ranges.

  Returns Range[]

getAnchor

• getAnchor(): Point

• Returns an object containing the row and column of the calling selection anchor.

  Returns Point

  Related

  Anchor.getPosition

getCursor

• getCursor(): Point

• Returns an object containing the row and column current position of the cursor.

  Returns Point

getLineRange

• getLineRange(row: any, excludeLastChar: any): Range

• Parameters

  • row: any
  • excludeLastChar: any

  Returns Range

getRange

• getRange(): Range

• [Returns the [[Range]] for the selected text.]{: #Selection.getRange}

  Returns Range

getRangeOfMovements

• getRangeOfMovements(func: Function): Range

• Saves the current cursor position and calls func that can change the cursor postion. The result is the range of the starting and eventual cursor position. Will reset the cursor position.

  Parameters

  • func: Function

    The callback that should change the cursor position

  Returns Range

getSelectionLead

• getSelectionLead(): any

• Returns an object containing the row and column of the calling selection lead.

  Returns any

getWordRange

• getWordRange(row: any, column: any): Range

• Moves the selection to highlight the entire word.

  Parameters

  • row: any
  • column: any

  Returns Range

  Related

  EditSession.getWordRange

isBackwards

• isBackwards(): boolean

• Returns true if the selection is going backwards in the document.

  Returns boolean

isEmpty

• isEmpty(): boolean

• Returns true if the selection is empty.

  Returns boolean

isEqual

• isEqual(data: any): boolean

• Parameters

  • data: any

  Returns boolean

isMultiLine

• isMultiLine(): boolean

• Returns true if the selection is a multi-line.

  Returns boolean

joinSelections

• joinSelections(): void

• Returns void

mergeOverlappingRanges

• mergeOverlappingRanges(): void

• Merges overlapping ranges ensuring consistency after changes

  Returns void

moveCursorBy

• moveCursorBy(rows: number, chars: number): void

• Moves the cursor to position indicated by the parameters. Negative numbers move the cursor backwards in the document.

  Parameters

  • rows: number

    The number of rows to move by
  • chars: number

    The number of characters to move by

  Returns void

  Related

  EditSession.documentToScreenPosition

moveCursorDown

• moveCursorDown(): void

• Moves the cursor down one row.

  Returns void

moveCursorFileEnd

• moveCursorFileEnd(): void

• Moves the cursor to the end of the file.

  Returns void

moveCursorFileStart

• moveCursorFileStart(): void

• Moves the cursor to the start of the file.

  Returns void

moveCursorLeft

• moveCursorLeft(): void

• Moves the cursor left one column.

  Returns void

moveCursorLineEnd

• moveCursorLineEnd(): void

• Moves the cursor to the end of the line.

  Returns void

moveCursorLineStart

• moveCursorLineStart(): void

• Moves the cursor to the start of the line.

  Returns void

moveCursorLongWordLeft

• moveCursorLongWordLeft(): void

• Moves the cursor to the word on the left.

  Returns void

moveCursorLongWordRight

• moveCursorLongWordRight(): void

• Moves the cursor to the word on the right.

  Returns void

moveCursorRight

• moveCursorRight(): void

• Moves the cursor right one column.

  Returns void

moveCursorShortWordLeft

• moveCursorShortWordLeft(): void

• Returns void

moveCursorShortWordRight

• moveCursorShortWordRight(): void

• Returns void

moveCursorTo

• moveCursorTo(row: number, column: number, keepDesiredColumn?: boolean): void

• Moves the cursor to the row and column provided. [If preventUpdateDesiredColumn is true, then the cursor stays in the same column position as its original point.]{: #preventUpdateBoolDesc}

  Parameters

  • row: number

    The row to move to
  • column: number

    The column to move to
  • OptionalkeepDesiredColumn: boolean

  Returns void

moveCursorToPosition

• moveCursorToPosition(position: Point): void

• Moves the selection to the position indicated by its row and column.

  Parameters

  • position: Point

    The position to move to

  Returns void

moveCursorToScreen

• moveCursorToScreen(
      row: number,
      column: number,
      keepDesiredColumn: boolean,
  ): void

• Moves the cursor to the screen position indicated by row and column. {:preventUpdateBoolDesc}

  Parameters

  • row: number

    The row to move to
  • column: number

    The column to move to
  • keepDesiredColumn: boolean

  Returns void

moveCursorUp

• moveCursorUp(): void

• Moves the cursor up one row.

  Returns void

moveCursorWordLeft

• moveCursorWordLeft(): void

• Returns void

moveCursorWordRight

• moveCursorWordRight(): void

• Returns void

moveTo

• moveTo(row: number, column: number): void

• Moves the selection cursor to the indicated row and column.

  Parameters

  • row: number

    The row to select to
  • column: number

    The column to select to

  Returns void

moveToPosition

• moveToPosition(pos: any): void

• Moves the selection cursor to the row and column indicated by pos.

  Parameters

  • pos: any

    An object containing the row and column

  Returns void

off

• off<K extends keyof MultiSelectionEvents>(
      name: K,
      callback: MultiSelectionEvents[K],
  ): void

• Type Parameters

  • K extends keyof MultiSelectionEvents

  Parameters

  • name: K
  • callback: MultiSelectionEvents[K]

  Returns void

on

• on<K extends keyof MultiSelectionEvents>(
      name: K,
      callback: MultiSelectionEvents[K],
      capturing?: boolean,
  ): MultiSelectionEvents[K]

• Type Parameters

  • K extends keyof MultiSelectionEvents

  Parameters

  • name: K
  • callback: MultiSelectionEvents[K]
  • Optionalcapturing: boolean

  Returns MultiSelectionEvents[K]

once

• once<K extends keyof MultiSelectionEvents>(
      name: K,
      callback: MultiSelectionEvents[K],
  ): void

• Type Parameters

  • K extends keyof MultiSelectionEvents

  Parameters

  • name: K
  • callback: MultiSelectionEvents[K]

  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[]

removeAllListeners

• removeAllListeners(name?: string): void

• Parameters

  • Optionalname: string

  Returns void

removeDefaultHandler

• removeDefaultHandler(name: string, callback: Function): void

• Parameters

  • name: string
  • callback: Function

  Returns void

removeEventListener

• removeEventListener<K extends keyof MultiSelectionEvents>(
      name: K,
      callback: MultiSelectionEvents[K],
  ): void

• Type Parameters

  • K extends keyof MultiSelectionEvents

  Parameters

  • name: K
  • callback: MultiSelectionEvents[K]

  Returns void

removeListener

• removeListener<K extends keyof MultiSelectionEvents>(
      name: K,
      callback: MultiSelectionEvents[K],
  ): void

• Type Parameters

  • K extends keyof MultiSelectionEvents

  Parameters

  • name: K
  • callback: MultiSelectionEvents[K]

  Returns void

selectAll

• selectAll(): void

• Selects all the text in the document.

  Returns void

selectAWord

• selectAWord(): void

• Selects a word, including its right whitespace.

  Returns void

  Related

  EditSession.getAWordRange

selectDown

• selectDown(): void

• Moves the selection down one row.

  Returns void

selectFileEnd

• selectFileEnd(): void

• Moves the selection to the end of the file.

  Returns void

selectFileStart

• selectFileStart(): void

• Moves the selection to the start of the file.

  Returns void

selectLeft

• selectLeft(): void

• Moves the selection left one column.

  Returns void

selectLine

• selectLine(): void

• Selects the entire line.

  Returns void

selectLineEnd

• selectLineEnd(): void

• Moves the selection to the end of the current line.

  Returns void

selectLineStart

• selectLineStart(): void

• Moves the selection to the beginning of the current line.

  Returns void

selectRight

• selectRight(): void

• Moves the selection right one column.

  Returns void

selectTo

• selectTo(row: number, column: number): void

• Moves the selection cursor to the indicated row and column.

  Parameters

  • row: number

    The row to select to
  • column: number

    The column to select to

  Returns void

selectToPosition

• selectToPosition(pos: Point): void

• Moves the selection cursor to the row and column indicated by pos.

  Parameters

  • pos: Point

    An object containing the row and column

  Returns void

selectUp

• selectUp(): void

• Moves the selection up one row.

  Returns void

selectWord

• selectWord(): void

• Selects an entire word boundary.

  Returns void

selectWordLeft

• selectWordLeft(): void

• Moves the selection to the first word on the left.

  Returns void

selectWordRight

• selectWordRight(): void

• Moves the selection to the first word on the right.

  Returns void

setAnchor

• setAnchor(row: number, column: number): void

• Sets the row and column position of the anchor. This function also emits the 'changeSelection' event.

  Parameters

  • row: number

    The new row
  • column: number

    The new column

  Returns void

setDefaultHandler

• setDefaultHandler(name: string, callback: Function): void

• Parameters

  • name: string
  • callback: Function

  Returns void

setRange

• setRange(range: IRange, reverse?: boolean): void

• Sets the selection to the provided range.

  Parameters

  • range: IRange

    The range of text to select
  • Optionalreverse: boolean

    Indicates if the range should go backwards (true) or not

  Returns void

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

toJSON

• toJSON(): Range | Range[]

• Returns Range | Range[]

toOrientedRange

• toOrientedRange(
      range?: Range & { desiredColumn?: number },
  ): Range & { desiredColumn?: number }

• Parameters

  • Optionalrange: Range & { desiredColumn?: number }

  Returns Range & { desiredColumn?: number }

toSingleRange

• toSingleRange(range?: Range): void

• Parameters

  • Optionalrange: Range

  Returns void

wouldMoveIntoSoftTab

• wouldMoveIntoSoftTab(cursor: Point, tabSize: number, direction: number): boolean

• Returns true if moving the character next to the cursor in the specified direction is a soft tab.

  Parameters

  • cursor: Point

    the current cursor position
  • tabSize: number

    the tab size
  • direction: number

    1 for right, -1 for left

  Returns boolean