SpreadJS 13
GC.Spread.Sheets.FormulaTextBox Namespace / FormulaTextBox class / add Method
The function description to add. This can be an array. See the Remarks for more information.
In This Topic
    add Method
    In This Topic
    Adds a custom function description.
    Syntax
    var instance = new GC.Spread.Sheets.FormulaTextBox.FormulaTextBox(host, options);
    var value; // Type: any
    value = instance.add(functionDescription);
    function add( 
       functionDescription : GC.Spread.CalcEngine.Functions.IFunctionDescription
    ) : any;

    Parameters

    functionDescription
    The function description to add. This can be an array. See the Remarks for more information.
    Remarks

    The parameter fnd is an object that describes the function being added. It can have the following parameters:

    Name Type Description
    name String The function name.
    shortDescription String The short description of the function.
    description String The description of the function.
    parameters Array The description of the function parameters.

    The function parameters can have the following parameters as well:

    Name Type Description
    parameters[i].name String The parameter name.
    parameters[i].description String The parameter description.
    parameters[i].repeatable Boolean The parameter is repeatable.
    parameters[i].optional Boolean The parameter is optional.

     

    See Also