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

    Interface FormulaFunction

    The function-discovery context the insertFunction command carries — everything a picker (the category menus, and the Insert Function dialog) needs to browse the workbook's functions, built-in and custom alike, without reaching for the workbook itself.

    Each call reads descriptors, which load lazily per language — cheap after the first, but not something to call per keystroke without debouncing.

    interface FormulaFunction {
        getCategories: () => Promise<Category[]>;
        searchByCategory: (category?: string) => Promise<IFunction[]>;
        searchByText: (
            text: string,
            options?: SearchTextOptions,
        ) => Promise<IFunction[]>;
    }
    Index
    getCategories searchByCategory searchByText
    getCategories: () => Promise<Category[]>

    The categories that actually have functions in them, ordered by name, each with its population.

    The list is derived from what is REGISTERED (a module's custom functions included), which is why a picker builds its category strip from this rather than from a fixed table — the two drift. The name is the identity searchByCategory takes and the fallback label; a picker maps the ones it knows to its own translated label and icon.

    searchByCategory: (category?: string) => Promise<IFunction[]>

    Every function in category, ordered by name. Excludes deprecated/hidden ones.

    Type Declaration

      • (category?: string): Promise<IFunction[]>

      • Parameters

        • Optionalcategory: string

          Omit (or pass an empty string) for every category — the picker's "All".

        Returns Promise<IFunction[]>

    searchByText: (
        text: string,
        options?: SearchTextOptions,
    ) => Promise<IFunction[]>

    The functions matching text, best match first — an exact name, then name prefixes, then name substrings, then a mention in the summary. Empty text yields nothing (not everything).

    Type Declaration

    Settings
    Member Visibility

    On This Page
    Properties