Class Anchor

constructor

• new Anchor(doc, row, column?): 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

  • Optional column: number

    The starting column position

  Returns Anchor

$insertRight

$onChange

column

document

row

$clipPositionToDocument

• $clipPositionToDocument(row, column): Point

• Clips the anchor position to the specified row and column.

  Parameters

  • row: number

    The row index to clip the anchor to

  • column: number

    The column index to clip the anchor to

  Returns Point

attach

• attach(doc): 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

onChange

• onChange(delta): void
• Internal

  Internal function called when "change" event fired.

  Parameters

  • delta: Delta

  Returns void

setPosition

• setPosition(row, column, noClip?): 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

  • Optional noClip: boolean

    Identifies if you want the position to be clipped

  Returns void