This object controls the autocompletion components and their lifecycle. There is an autocompletion popup, an optional inline ghost text renderer and a docuent tooltip popup inside.

Constructors

Properties

$elements: ParentNode[]
$firstOpenTimer: {
    schedule: { (timeout?: number): void; delay(timeout?: number): void; schedule: ...; call(): void; cancel(): void; isPending(): any; };
    call(): void;
    cancel(): void;
    delay(timeout?): void;
    isPending(): any;
    (timeout?): void;
}

Type declaration

    • (timeout?): void
    • Parameters

      • Optional timeout: number

      Returns void

  • schedule: { (timeout?: number): void; delay(timeout?: number): void; schedule: ...; call(): void; cancel(): void; isPending(): any; }
  • call:function
  • cancel:function
  • delay:function
    • Parameters

      • Optional timeout: number

      Returns void

  • isPending:function
activated: boolean
autoInsert: boolean
autoSelect: boolean
autoShown: boolean
base: Anchor
changeTimer: {
    schedule: { (timeout?: number): void; delay(timeout?: number): void; schedule: ...; call(): void; cancel(): void; isPending(): any; };
    call(): void;
    cancel(): void;
    delay(timeout?): void;
    isPending(): any;
    (timeout?): void;
}

Type declaration

    • (timeout?): void
    • Parameters

      • Optional timeout: number

      Returns void

  • schedule: { (timeout?: number): void; delay(timeout?: number): void; schedule: ...; call(): void; cancel(): void; isPending(): any; }
  • call:function
  • cancel:function
  • delay:function
    • Parameters

      • Optional timeout: number

      Returns void

  • isPending:function
commands: {
    Backspace: ((editor) => void);
    Ctrl-Down|Ctrl-End: ((editor) => void);
    Ctrl-Up|Ctrl-Home: ((editor) => void);
    Down: ((editor) => void);
    Esc: ((editor) => void);
    PageDown: ((editor) => void);
    PageUp: ((editor) => void);
    Return: ((editor) => any);
    Shift-Return: ((editor) => void);
    Tab: ((editor) => any);
    Up: ((editor) => void);
}

Type declaration

  • Backspace: ((editor) => void)
      • (editor): void
      • Parameters

        • editor: any

        Returns void

  • Ctrl-Down|Ctrl-End: ((editor) => void)
      • (editor): void
      • Parameters

        • editor: any

        Returns void

  • Ctrl-Up|Ctrl-Home: ((editor) => void)
      • (editor): void
      • Parameters

        • editor: any

        Returns void

  • Down: ((editor) => void)
      • (editor): void
      • Parameters

        • editor: any

        Returns void

  • Esc: ((editor) => void)
      • (editor): void
      • Parameters

        • editor: any

        Returns void

  • PageDown: ((editor) => void)
      • (editor): void
      • Parameters

        • editor: any

        Returns void

  • PageUp: ((editor) => void)
      • (editor): void
      • Parameters

        • editor: any

        Returns void

  • Return: ((editor) => any)
      • (editor): any
      • Parameters

        • editor: any

        Returns any

  • Shift-Return: ((editor) => void)
      • (editor): void
      • Parameters

        • editor: any

        Returns void

  • Tab: ((editor) => any)
      • (editor): any
      • Parameters

        • editor: any

        Returns any

  • Up: ((editor) => void)
      • (editor): void
      • Parameters

        • editor: any

        Returns void

completionProvider: CompletionProvider
completions: FilteredList
editor: Editor
exactMatch: boolean
inlineEnabled: boolean
inlineRenderer: AceInline
keyboardHandler: HashHandler
parentNode: any
popup: AcePopup
popupTimer: {
    schedule: { (timeout?: number): void; delay(timeout?: number): void; schedule: ...; call(): void; cancel(): void; isPending(): any; };
    call(): void;
    cancel(): void;
    delay(timeout?): void;
    isPending(): any;
    (timeout?): void;
}

Type declaration

    • (timeout?): void
    • Parameters

      • Optional timeout: number

      Returns void

  • schedule: { (timeout?: number): void; delay(timeout?: number): void; schedule: ...; call(): void; cancel(): void; isPending(): any; }
  • call:function
  • cancel:function
  • delay:function
    • Parameters

      • Optional timeout: number

      Returns void

  • isPending:function
setSelectOnHover: boolean
showLoadingState: boolean
stickySelection: boolean
stickySelectionDelay: number
stickySelectionTimer: {
    schedule: { (timeout?: number): void; delay(timeout?: number): void; schedule: ...; call(): void; cancel(): void; isPending(): any; };
    call(): void;
    cancel(): void;
    delay(timeout?): void;
    isPending(): any;
    (timeout?): void;
}

Type declaration

    • (timeout?): void
    • Parameters

      • Optional timeout: number

      Returns void

  • schedule: { (timeout?: number): void; delay(timeout?: number): void; schedule: ...; call(): void; cancel(): void; isPending(): any; }
  • call:function
  • cancel:function
  • delay:function
    • Parameters

      • Optional timeout: number

      Returns void

  • isPending:function
tooltipNode: HTMLDivElement
tooltipTimer: {
    schedule: { (timeout?: number): void; delay(timeout?: number): void; schedule: ...; call(): void; cancel(): void; isPending(): any; };
    call(): void;
    cancel(): void;
    delay(timeout?): void;
    isPending(): any;
    (timeout?): void;
}

Type declaration

    • (timeout?): void
    • Parameters

      • Optional timeout: number

      Returns void

  • schedule: { (timeout?: number): void; delay(timeout?: number): void; schedule: ...; call(): void; cancel(): void; isPending(): any; }
  • call:function
  • cancel:function
  • delay:function
    • Parameters

      • Optional timeout: number

      Returns void

  • isPending:function
startCommand: {
    bindKey: string;
    exec: ((editor, options) => void);
    name: string;
}

Type declaration

  • bindKey: string
  • exec: ((editor, options) => void)
      • (editor, options): void
      • Parameters

        • editor: any
        • options: any

        Returns void

  • name: string

Accessors

  • get completionsForLoading(): {
        caption: any;
        value: string;
    }[]
  • Returns {
        caption: any;
        value: string;
    }[]

Methods

  • Detaches all elements from the editor, and cleans up the data for the session

    Returns void

  • This method is deprecated, it is only kept for backwards compatibility. Use the same method include CompletionProvider instead for the same functionality.

    Parameters

    • editor: any
    • callback: any

    Returns boolean

    Deprecated

  • Parameters

    • Optional initialPosition: {
          pos: Point;
          prefix: string;
      }
      • pos: Point
      • prefix: string

    Returns CompletionProvider

  • Parameters

    • editor: Editor
    • prefix: string
    • Optional keepPopupPosition: boolean

    Returns void

  • This is the entry point for the autocompletion class, triggers the actions which collect and display suggestions

    Parameters

    • editor: Editor
    • Optional options: CompletionOptions

    Returns void

  • Parameters

    • keepPopupPosition: boolean
    • Optional options: CompletionOptions

    Returns void

Generated using TypeDoc