Ace API Reference
    Preparing search index...

    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.

    Index

    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?: number): void;
        isPending(): any;
        (timeout?: number): void;
    }
    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?: number): void;
        isPending(): any;
        (timeout?: number): void;
    }
    commands: {
        Backspace: (editor: any) => void;
        "Ctrl-Down|Ctrl-End": (editor: any) => void;
        "Ctrl-Up|Ctrl-Home": (editor: any) => void;
        Down: (editor: any) => void;
        Esc: (editor: any) => void;
        PageDown: (editor: any) => void;
        PageUp: (editor: any) => void;
        Return: (editor: any) => any;
        "Shift-Return": (editor: any) => void;
        Tab: (editor: any) => any;
        Up: (editor: any) => 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?: number): void;
        isPending(): any;
        (timeout?: number): void;
    }
    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?: number): void;
        isPending(): any;
        (timeout?: number): void;
    }
    tooltipNode: HTMLDivElement
    tooltipTimer: {
        schedule: { (timeout?: number): void; delay(timeout?: number): void; schedule: ...; call(): void; cancel(): void; isPending(): any; };
        call(): void;
        cancel(): void;
        delay(timeout?: number): void;
        isPending(): any;
        (timeout?: number): void;
    }
    startCommand: {
        bindKey: string;
        exec: (editor: any, options: any) => 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

    • Parameters

      • OptionalinitialPosition: { pos: Ace.Point; prefix: string }

      Returns CompletionProvider

    • Parameters

      • editor: Editor
      • prefix: string
      • OptionalkeepPopupPosition: boolean

      Returns void