SheetXL - v1.0.2
    Preparing search index...

    Interface SearchOptions

    Options for searching a function in the collection.

    interface SearchOptions {
        category?: string;
        includeHidden?: boolean;
        limit?: number;
        name?: string;
        text?: string;
        type?: string;
    }

    Hierarchy (View Summary)

    Index
    category? includeHidden? limit? name? text? type?
    category?: string

    Only functions in this category (IFunction.IDescriptor.getCategory). Case insensitive.

    includeHidden?: boolean

    Include hidden functions (IFunction.IDeclaration.isHidden).

    false

    limit?: number

    Return at most this many functions.

    Applied AFTER ordering, so a limited search is the top N by relevance — not an arbitrary N. A search box wanting "the best 50 of 400" should use this rather than slicing the result, so the caller never pays to materialize the rest.

    name?: string

    Only the function with this name. Case insensitive.

    Optionaltext

    text?: string

    Search all function descriptors for the given text. This is case insensitive.

    If this is specified this will also search the name.

    type?: string

    Only functions of this type: 'formula', 'macro' or 'autoRun'.

    Compared against IFunction.getContext, which is what search filters on too, so the two agree on what a type means.

    Settings
    Member Visibility

    On This Page
    Properties