Ace API Reference
    Preparing search index...

    Interface BaseCompletion

    interface BaseCompletion {
        caption?: string;
        command?: any;
        completer?: Completer;
        completerId?: string;
        docHTML?: string;
        docText?: string;
        hideInlinePreview?: boolean;
        meta?: string;
        range?: Ace.IRange;
        score?: number;
        skipFilter?: boolean;
        snippet?: string;
        value?: string;
    }
    Index

    Properties

    caption? command? completer? completerId? docHTML? docText? hideInlinePreview? meta? range? score? skipFilter? snippet? value?

    Properties

    caption?: string

    the text that would be displayed in the completion list. If omitted, value or snippet would be shown instead.

    command?: any

    A command to be executed after the completion is inserted (experimental)

    completer?: Completer
    completerId?: string

    the identifier of the completer

    docHTML?: string

    an HTML string that would be displayed as an additional popup

    docText?: string

    a plain text that would be displayed as an additional popup. If docHTML exists, it would be used instead of docText.

    hideInlinePreview?: boolean
    meta?: string

    a short description of the completion

    range?: Ace.IRange

    An object specifying the range of text to be replaced with the new completion value (experimental)

    score?: number

    a numerical value that determines the order in which completions would be displayed. A lower score means that the completion would be displayed further from the start

    skipFilter?: boolean

    a boolean value to decide if the popup item is going to skip the filtering process done using prefix text.

    snippet?: string

    a text snippet that would be inserted when the completion is selected

    value?: string

    The text that would be inserted when selecting this completion.

    Settings

    Member Visibility

    On This Page

    Properties