Interface sync_document

Optionalfirst_page_left

pages

apply_remote_changes

• apply_remote_changes(
      spread_uuid: string,
      changes: element_change[],
      spread_props?: { [key: string]: unknown },
  ): unknown

  Parameters

  • spread_uuid: string
  • changes: element_change[]
  • Optionalspread_props: { [key: string]: unknown }

  Returns unknown

Optionalapply_remote_structure

• apply_remote_structure?(spreads: any[], first_page_left?: boolean): unknown

  The spread list as it should be, serialised and in order (canvas TYP-919).

  Parameters

  • spreads: any[]
  • Optionalfirst_page_left: boolean

  Returns unknown

Optionalapply_remote_text

• apply_remote_text?(uuid: string, delta: delta_op[]): unknown

  Apply another window's change to a frame's story, in place.

  Parameters

  • uuid: string
  • delta: delta_op[]

  Returns unknown

Optionalend_typing_run

• end_typing_run?(): void

  Close an open typing run, so what was typed becomes an edit that is sent.

  Returns void

Optionalis_pointer_down

• is_pointer_down?(): boolean

  A drag or resize is under way: the others' changes wait until it ends.

  Returns boolean

Optionalserialise_spread

• serialise_spread?(spread: any): any

  A spread as plain JSON without its text layouts, which are costly and never compared.

  Parameters

  • spread: any

  Returns any

set_element_change_events

• set_element_change_events(on: boolean): void

  Parameters

  • on: boolean

  Returns void

Optionalset_text_change_events

• set_text_change_events?(on: boolean): void

  Report what each frame's text changed, per keystroke (canvas TYP-919, typograph_text_changes).

  Parameters

  • on: boolean

  Returns void