Class EditorSelection

ReadonlymainIndex

Readonlyranges

main

• get main(): SelectionRange

  Get the primary selection range. Usually, you should make sure your code applies to all ranges, by using methods like changeByRange.

  Returns SelectionRange

addRange

• addRange(range: SelectionRange, main?: boolean): EditorSelection

  Extend this selection with an extra range.

  Parameters

  • range: SelectionRange
  • Optionalmain: boolean

  Returns EditorSelection

asSingle

• asSingle(): EditorSelection

  Make sure the selection only has one range. Returns a selection holding only the main range from this selection.

  Returns EditorSelection

eq

• eq(other: EditorSelection, includeAssoc?: boolean): boolean

  Compare this selection to another selection. By default, ranges are compared only by position. When includeAssoc is true, cursor ranges must also have the same assoc value.

  Parameters

  • other: EditorSelection
  • OptionalincludeAssoc: boolean

  Returns boolean

map

• map(change: ChangeDesc, assoc?: number): EditorSelection

  Map a selection through a change. Used to adjust the selection position for changes.

  Parameters

  • change: ChangeDesc
  • Optionalassoc: number

  Returns EditorSelection

replaceRange

• replaceRange(range: SelectionRange, which?: number): EditorSelection

  Replace a given range with another range, and then normalize the selection to merge and sort ranges if necessary.

  Parameters

  • range: SelectionRange
  • Optionalwhich: number

  Returns EditorSelection

toJSON

• toJSON(): any

  Convert this selection to an object that can be serialized to JSON.

  Returns any

Staticcreate

• create(ranges: readonly SelectionRange[], mainIndex?: number): EditorSelection

  Sort and merge the given set of ranges, creating a valid selection.

  Parameters

  • ranges: readonly SelectionRange[]
  • OptionalmainIndex: number

  Returns EditorSelection

Staticcursor

• cursor(
      pos: number,
      assoc?: number,
      bidiLevel?: number,
      goalColumn?: number,
  ): SelectionRange

  Create a cursor selection range at the given position. You can safely ignore the optional arguments in most situations.

  Parameters

  • pos: number
  • Optionalassoc: number
  • OptionalbidiLevel: number
  • OptionalgoalColumn: number

  Returns SelectionRange

StaticfromJSON

• fromJSON(json: any): EditorSelection

  Create a selection from a JSON representation.

  Parameters

  • json: any

  Returns EditorSelection

Staticrange

• range(
      anchor: number,
      head: number,
      goalColumn?: number,
      bidiLevel?: number,
      assoc?: number,
  ): SelectionRange

  Create a selection range.

  Parameters

  • anchor: number
  • head: number
  • OptionalgoalColumn: number
  • OptionalbidiLevel: number
  • Optionalassoc: number

  Returns SelectionRange

Staticsingle

• single(anchor: number, head?: number): EditorSelection

  Create a selection holding a single range.

  Parameters

  • anchor: number
  • Optionalhead: number

  Returns EditorSelection