SpreadJS Documentation
getCustomFunctionDescription Method
The custom function description name.
Gets a custom function description.
Syntax
var instance = new GcSpread.Sheets.Spread(host, options);
var value; // Type: Object
value = instance.getCustomFunctionDescription(name);
function getCustomFunctionDescription( 
   name : string
) : Object;

Parameters

name
The custom function description name.

Return Value

The custom function description. See Remarks for additional information.
Example
This example uses the getCustomFunctionDescription method.
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" }]
    };
    spread.addCustomFunctionDescription(functionDes);

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

The object returned by this method includes the following options:

obj.name string type The function name.
obj.shortDescription string type The short description of the function.
obj.description string type The description of the function.
obj.parameters array type The item returned is an object; the description of the function parameters.
obj.parameters[i].name string type The parameter name.
obj.parameters[i].description string type The parameter description.
obj.parameters[i].repeatable boolean type The parameter is repeatable.
obj.parameters[i].optional boolean type The parameter is optional.

 

See Also

Reference

Spread type

 

 


Copyright © GrapeCity, inc. All rights reserved.

Send comments on this topic.