SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface FunctionHint

    The caret-derived function context that drives the preview: which function the caret is inside (name), which argument it's on (argIndex), and that function's declared parameters (used to render the signature with the active argument emphasized). Derived synchronously in the editor from the caret token's context.

    interface FunctionHint {
        argIndex: number;
        argSeparator?: string;
        name: string;
        nameLocal?: string;
        params: readonly IParameterType[];
        warning?: { argIndex: number; value: string; values: string };
    }
    Index
    argIndex argSeparator? name nameLocal? params warning?
    argIndex: number

    The zero-based index of the argument the caret currently sits in.

    argSeparator?: string

    The workbook locale's argument separator (, or ;), for the displayed signature.

    name: string

    The function's canonical name (as reported by the SDK) — the identity used to match descriptors.

    nameLocal?: string

    The function's name in the user's language (SUMME), for DISPLAY; falls back to name.

    params: readonly IParameterType[]

    The function's declared parameters, in order (name / optional / rest).

    warning?: { argIndex: number; value: string; values: string }

    The argument the caret is in holds a literal outside the values its parameter is limited to (findEnumLints). Shown under that argument's description while it is the one lit.

    Type Declaration

    • argIndex: number

      The argument, as argIndex counts.

    • value: string

      The literal as written.

    • values: string

      The values it could be, as literals, joined for display.

    Settings
    Member Visibility

    On This Page
    Properties