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

    Interface DescriptorJSON

    Contains user information about the function.

    This is locale specific.

    interface DescriptorJSON {
        category?: string;
        deprecated?: string | boolean;
        enums?: Record<string, EnumDescriptorJSON>;
        links?: [url: string, text?: string][];
        name?: string;
        nameLocal?: string;
        parameters?: Record<
            string,
            { defaultValue?: Scalar; description: string; example?: string },
        >;
        summary?: string;
    }
    Index
    category? deprecated? enums? links? name? nameLocal? parameters? summary?
    category?: string

    A category or group to which the function belongs.

    'custom'
    deprecated?: string | boolean

    If true or has a string value then is usable in calculation but not provided in the ui.

    'null'
    • If this is a string it can be used to provide a deprecated label.
    • This is useful for functions that are in beta or deprecated.
    enums?: Record<string, EnumDescriptorJSON>

    Describe each enum the function's parameters are limited to, by enum id.

    links?: [url: string, text?: string][]

    An array of links associated with the value.

    name?: string

    A overwritten name for the function.

    The name of the function in code.
    nameLocal?: string

    The function name in the user's language (spreadsheet-language pack), e.g. SUMME. Snapshot for the language the descriptor was resolved for; absent ⇒ falls back to name.

    parameters?: Record<
        string,
        { defaultValue?: Scalar; description: string; example?: string },
    >

    Describe each parameter in the function.

    summary?: string

    A more detailed explanation of the function's purpose and usage.

    Settings
    Member Visibility

    On This Page
    Properties