addCustomFunctionDescription Method

Javascript (Usage)
Javascript (Specification)

var instance = new GcSpread.Sheets.Sheet(name);
var value; // Type: any
value = instance.addCustomFunctionDescription(fnd);

function addCustomFunctionDescription( 
   fnd : Object
) : any;

Parameters

fnd: The function description to add.

This example uses the addCustomFunctionDescription method.

Javascript

function FactorialFunction() {
    this.name = "FACTORIAL";
    this.maxArgs = 1;
    this.minArgs = 1;
}
FactorialFunction.prototype = new GcSpread.Sheets.Calc.Functions.Function();
FactorialFunction.prototype.evaluate = function (args) {
    var result = 1;
    if (args.length === 1 && !isNaN(parseInt(args[0]))) {
        for (var i = 1; i < args[0]; i++) {
            result = i * result;
        }
        return result;
    }
    return "#VALUE!";
}

var factorial = new FactorialFunction();
    spread.addCustomFunction(factorial);
    var functionDes = {
        name:"FACTORIAL",
        description: "The function returns the factorial of the cells value",
        parameters:[{ name: "value" }]
    };
    activeSheet.addCustomFunctionDescription(functionDes);

var cname = activeSheet.getCustomFunctionDescription("FACTORIAL");
alert(cname.description);
//alert(JSON.stringify(cname));

Provide a description for the custom function, using the following options.

fnd.name	string type	The function name.
fnd.shortDescription	string type	The short description of the function.
fnd.description	string type	The description of the function.
fnd.parameters	array type	The description of the function parameters.
fnd.parameters[i].name	string type	The parameter name.
fndparameters[i].description	string type	The parameter description.
fnd.parameters[i].repeatable	boolean type	The parameter is repeatable.
fnd.parameters[i].optional	boolean type	The parameter is optional.

Reference

Sheet type