Class Anchor

constructor

• new Anchor(doc: Document, row: number | Point, column?: number): Anchor

• Creates a new Anchor and associates it with a document.

  Parameters

  • doc: Document

    The document to associate with the anchor
  • row: number | Point

    The starting row position
  • Optionalcolumn: number

    The starting column position

  Returns Anchor

column

document

OptionalmarkerId

row

_dispatchEvent

• _dispatchEvent<K extends "change">(
      eventName: K,
      ...args: Parameters<AnchorEvents[K]>,
  ): void

• Type Parameters

  • K extends "change"

  Parameters

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

  Returns void

_emit

• _emit<K extends "change">(
      eventName: K,
      ...args: Parameters<AnchorEvents[K]>,
  ): void

• Type Parameters

  • K extends "change"

  Parameters

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

  Returns void

_signal

• _signal<K extends "change">(
      eventName: K,
      ...args: Parameters<AnchorEvents[K]>,
  ): void

• Type Parameters

  • K extends "change"

  Parameters

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

  Returns void

addEventListener

• addEventListener<K extends "change">(
      name: K,
      callback: AnchorEvents[K],
      capturing?: boolean,
  ): AnchorEvents[K]

• Type Parameters

  • K extends "change"

  Parameters

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

  Returns AnchorEvents[K]

attach

• attach(doc: Document): void

• When called, the "change" event listener is appended.

  Parameters

  • doc: Document

    The document to associate with

  Returns void

detach

• detach(): void

• When called, the "change" event listener is removed.

  Returns void

getDocument

• getDocument(): Document

• Returns the current document.

  Returns Document

getPosition

• getPosition(): Point

• Returns an object identifying the row and column position of the current anchor.

  Returns Point

off

• off<K extends "change">(name: K, callback: AnchorEvents[K]): void

• Type Parameters

  • K extends "change"

  Parameters

  • name: K
  • callback: AnchorEvents[K]

  Returns void

on

• on<K extends "change">(
      name: K,
      callback: AnchorEvents[K],
      capturing?: boolean,
  ): AnchorEvents[K]

• Type Parameters

  • K extends "change"

  Parameters

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

  Returns AnchorEvents[K]

once

• once<K extends "change">(name: K, callback: AnchorEvents[K]): void

• Type Parameters

  • K extends "change"

  Parameters

  • name: K
  • callback: AnchorEvents[K]

  Returns void

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 "change">(
      name: K,
      callback: AnchorEvents[K],
  ): void

• Type Parameters

  • K extends "change"

  Parameters

  • name: K
  • callback: AnchorEvents[K]

  Returns void

removeListener

• removeListener<K extends "change">(name: K, callback: AnchorEvents[K]): void

• Type Parameters

  • K extends "change"

  Parameters

  • name: K
  • callback: AnchorEvents[K]

  Returns void

setDefaultHandler

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

• Parameters

  • name: string
  • callback: Function

  Returns void

setPosition

• setPosition(row: number, column: number, noClip?: boolean): void

• Sets the anchor position to the specified row and column. If noClip is true, the position is not clipped.

  Parameters

  • row: number

    The row index to move the anchor to
  • column: number

    The column index to move the anchor to
  • OptionalnoClip: boolean

    Identifies if you want the position to be clipped

  Returns void