SheetXL - v0.3.20
    Preparing search index...

    Interface DescriptorJSON

    Contains user information about the function.

    This is locale specific.

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

    Properties

    category? hidden? links? name? parameters? summary?

    Properties

    category?: string

    A category or group to which the function belongs.

    'custom'
    hidden?: string | boolean

    If true is usable in calculation but not provided in the ui. If this is a string it can be used to provide a hidden label.

    'null'

    This is useful for functions that are unimplemented or deprecated.

    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.
    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