description Method

Javascript (Usage)
Javascript (Specification)

var instance = new GC.Spread.CalcEngine.Functions.Function(name,
                                                          minArgs,
                                                          maxArgs,
                                                          functionDescription,
                                                          functionDescription.description,
                                                          functionDescription.parameter,
                                                          functionDescription.parameter.name,
                                                          functionDescription.parameter.repeatable,
                                                          functionDescription.parameter.optional);
var value; // Type: object
value = instance.description();

function description() : object;

Return Value

The description of the function.

This example uses the addCustomFunctionDescription method.

Javascript

<script type="text/javascript">
    function FactorialFunction() {
        this.name = "FACTORIAL";
        this.maxArgs = 1;
        this.minArgs = 1;
    }
    FactorialFunction.prototype = new GC.Spread.CalcEngine.Functions.Function();
    FactorialFunction.prototype.description = function () {
        return {
            description: "The function returns the factorial of the cells value",
            parameters: [{
                name: "value"
            }]
        }
    }
    FactorialFunction.prototype.evaluate = function () {
        var result = 1;
        var args = arguments;
        if (args.length === 1 && !isNaN(parseInt(args[0]))) {
            for (var i = 1; i <= args[0]; i++) {
                result = i * result;
            }
            return result;
        }
        return "#VALUE!";
    }
    $(document).ready(function () {
        var spread = new GC.Spread.Sheets.Workbook(document.getElementById('ss'), {sheetCount: 3});
        var factorial = new FactorialFunction();
        spread.addCustomFunction(factorial);

        $("button").click(function () {
            var fun = spread.getCustomFunction("FACTORIAL");
            fun.description = function () { };
            //or fun.description = null;
        });
    });
</script>

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

Function type