description メソッド

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;

戻り値の型

関数の記述。

次のサンプルコードは、addCustomFunctionDescriptionメソッドを使用します。

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>

以下のオプションを使用して、カスタム関数の記述を提供します。

fnd.name	string型	関数名。
fnd.shortDescription	string型	関数の簡単な説明。
fnd.description	string型	関数の説明。
fnd.parameters	array型	関数パラメーターの説明。
fnd.parameters[i].name	string型	パラメーター名。
fndparameters[i].description	string型	パラメーターの説明。
fnd.parameters[i].repeatable	boolean型	パラメーターが繰り返し可能かどうか。
fnd.parameters[i].optional	boolean型	パラメーターが任意かどうか。

参照

Function タイプ