GC.Spread.Sheets.CalcEngine

Namespace: CalcEngine

Spread.Sheets.CalcEngine

Enumerations

RangeReferenceRelative

Interfaces

Functions

evaluateFormula

▸ evaluateFormula(context, formula, baseRow?, baseColumn?, useR1C1?, preserveArrayResult?): any

计算指定公式。

example

var spread = new GC.Spread.Sheets.Workbook(document.getElementById('ss'), { sheetCount: 1 });
sheet = spread.getSheet(0);
sheet.setValue(0, 0, 1);
sheet.setValue(1, 0, 2);
// 使用EvaluateFormula()方法计算公式，无需在工作表单元格中设置公式
var result = GC.Spread.Sheets.CalcEngine.evaluateFormula(sheet, "SUM(A1:A2)", 0, 0);
console.log("SUM(A1:A2) = " + result);
result = GC.Spread.Sheets.CalcEngine.evaluateFormula(sheet, "A1:A2", 0, 0, false, true);
console.log("A1:A2 = ", result);

Parameters

Name	Type	Description
`context`	`Object`	计算上下文；通常应使用活动工作表对象。
`formula`	`string`	公式字符串。
`baseRow?`	`number`	公式的基准行索引。
`baseColumn?`	`number`	公式的基准列索引。
`useR1C1?`	`boolean`	是否使用r1c1引用样式。
`preserveArrayResult?`	`boolean`	当结果为数组时是否返回数组。如果为false或未定义则返回单个值。

Returns

any

计算后的公式结果。

evaluateFormulaAsync

▸ evaluateFormulaAsync(context, formula, baseRow?, baseColumn?): Promise<any>

计算指定的公式，并返回一个包含公式计算结果的 Promise。

example

var spread = new GC.Spread.Sheets.Workbook(document.getElementById('ss'), { sheetCount: 1 });
sheet = spread.getSheet(0);
sheet.setValue(0, 0, 1);
// 使用 evaluateFormulaAsync() 方法在不设置工作表单元格公式的情况下计算公式
GC.Spread.Sheets.CalcEngine.evaluateFormulaAsync(sheet, 'WEBSERVICE("http://*.com/name/"&A1)', 0, 0).then(function (result) {console.log(result)});

Parameters

Name	Type	Description
`context`	`Object`	计算上下文；一般情况下，您应该使用活动工作表对象。
`formula`	`string`	公式字符串。
`baseRow?`	`number`	公式的基准行索引。
`baseColumn?`	`number`	公式的基准列索引。

Returns

Promise<any>

包含公式计算结果的 Promise。

expressionToFormula

▸ expressionToFormula(context, expression, baseRow?, baseColumn?, useR1C1?): string

将指定的表达式树转换为公式字符串。

example

var spread = new GC.Spread.Sheets.Workbook(document.getElementById('ss'), { sheetCount: 1 });
sheet = spread.getSheet(0);
sheet.setValue(0, 0, 1);
sheet.setValue(0, 1, 2);
sheet.setValue(0, 2, 3);
sheet.addCustomName("customName1", "=12", 0, 0);
sheet.addCustomName("customName2", "Average(20,45)", 0, 0);
sheet.addCustomName("customName3", "=$A$1:$C$1");
sheet.setFormula(1, 0, "customName1");
sheet.setFormula(1, 1, "customName2");
sheet.setFormula(1, 2, "sum(customName3)");
var cname = sheet.getCustomName("customName2");
if (cname instanceof GC.Spread.Sheets.NameInfo) {
    // 获取自定义名称
    var name = cname.getName();
    // 获取表达式
    var expression = cname.getExpression();
    // 获取表达式字符串
    var expStr = GC.Spread.Sheets.CalcEngine.expressionToFormula(sheet, expression, 0, 0);
    console.log("Name: " + name + " ; Expression: " + expStr);
}

Parameters

Name	Type	Description
`context`	`Object`	上下文；通常应使用活动工作表对象。
`expression`	`Expression`	表达式树。
`baseRow?`	`number`	公式的基准行索引。
`baseColumn?`	`number`	公式的基准列索引。
`useR1C1?`	`boolean`	是否使用r1c1引用样式。

Returns

string

公式字符串。

formulaToExpression

▸ formulaToExpression(context, formula, baseRow?, baseColumn?, useR1C1?): Expression

将指定的公式解析为表达式树。

example

var spread = new GC.Spread.Sheets.Workbook(document.getElementById('ss'), { sheetCount: 1 });
sheet = spread.getSheet(0);
sheet.setValue(0, 0, 1);
sheet.setValue(0, 1, 2);
sheet.setValue(0, 2, 3);
sheet.getCell(4, 4).formula("=SUM(A1:C1)");
var formula = sheet.getFormula(4, 4);
var expression = GC.Spread.Sheets.CalcEngine.formulaToExpression(sheet, formula, 0, 0);
console.log("Function Name is: " + expression.functionName);

Parameters

Name	Type	Description
`context`	`Object`	上下文；通常应使用活动工作表对象。
`formula`	`string`	公式字符串。
`baseRow?`	`number`	公式的基准行索引。
`baseColumn?`	`number`	公式的基准列索引。
`useR1C1?`	`boolean`	是否使用r1c1引用样式。

Returns

Expression

表达式树。

formulaToRanges

▸ formulaToRanges(sheet, formula, baseRow?, baseCol?): Object[]

将公式字符串转换为指定的单元格范围。

Parameters

Name	Type	Description
`sheet`	`Worksheet`	基础工作表。
`formula`	`string`	公式。
`baseRow?`	`number`	公式的基准行索引。
`baseCol?`	`number`	公式的基准列索引。

Returns

Object[]

引用公式字符串的单元格范围。

goalSeek

▸ goalSeek(changingSheet, changingRow, changingColumn, formulaSheet, formulaRow, formulaColumn, desiredResult, options?): boolean | Promise<boolean>

尝试找到一个单元格的值，使其在另一个单元格中产生所需的公式结果。

example

// 此示例展示如何使用目标查找。
// 贷款金额为10000，期限为18个月，每月支付600，评估您需要获得什么利率才能实现贷款目标。
sheet.setValue(0, 1, 10000); // 贷款金额
sheet.setValue(1, 1, 18); // 期限（月）
sheet.setFormatter(2, 1, "0%"); // 利率
sheet.setFormatter(3, 1, "0.00");
sheet.setFormula(3, 1, "PMT(B3/12,B2,B1)"); // 付款
GC.Spread.Sheets.CalcEngine.goalSeek(sheet, 2, 1, sheet, 3, 1, -600); // B3中的结果是10%

example

// 此示例展示如何使用带自定义选项的目标查找。
sheet.setValue(0, 1, 10000);
sheet.setValue(1, 1, 18);
sheet.setFormatter(2, 1, "0%");
sheet.setFormatter(3, 1, "0.00");
sheet.setFormula(3, 1, "PMT(B3/12,B2,B1)");
GC.Spread.Sheets.CalcEngine.goalSeek(sheet, 2, 1, sheet, 3, 1, -600, {
    maximumIterations: 200,
    tolerance: 0.0001
});

example

// 此示例展示如何使用带回调的目标查找，以便观察并提前停止。
GC.Spread.Sheets.CalcEngine.goalSeek(sheet, 2, 1, sheet, 3, 1, -600, {
    maximumIterations: 200,
    tolerance: 0,
    callback: (info) => {
        console.log(`iter=${info.currentIteration}, x=${info.currentValue}, f(x)=${info.currentFormulaResult}, succeeded=${info.succeeded}`);
        if (Math.abs(info.currentFormulaResult / -600 - 1) < 1e-10) { // special tolerance
            return true; // stop goal seek
        }
        return false; // continue
    }
});

Parameters

Name	Type	Description
`changingSheet`	`Worksheet`	包含要调整的单元格的工作表。
`changingRow`	`number`	包含要调整的值的单元格的行索引。
`changingColumn`	`number`	包含要调整的值的单元格的列索引。
`formulaSheet`	`Worksheet`	包含要解析的公式的工作表。
`formulaRow`	`number`	包含要解析的公式的单元格的行索引。
`formulaColumn`	`number`	包含要解析的公式的单元格的列索引。
`desiredResult`	`number`	所需的公式结果。
`options?`	`IGoalSeekOptions`	-

Returns

boolean | Promise<boolean>

指示是否已找到解决方案。

rangeToFormula

▸ rangeToFormula(range, baseRow?, baseCol?, rangeReferenceRelative?, useR1C1?): string

将指定的单元格范围转换为公式字符串。

example

var spread = new GC.Spread.Sheets.Workbook(document.getElementById('ss'), { sheetCount: 1 });
sheet = spread.getSheet(0);
// 设置值
sheet.setValue(0, 0, 1, 3);
sheet.setValue(1, 0, 50, 3);
sheet.setValue(2, 0, 100, 3);
sheet.setValue(3, 0, 2, 3);
sheet.setValue(4, 0, 60, 3);
sheet.setValue(5, 0, 90, 3);
sheet.clearSelection();
// 添加选择
sheet.addSelection(2, 0, 3, 1);
var range = sheet.getSelections();
// 获取范围字符串
var rangeStr = GC.Spread.Sheets.CalcEngine.rangeToFormula(range[0]);
// 使用选定的范围创建公式
var formula = "Sum(" + rangeStr + ")";
// 在工作表单元格中设置公式
sheet.setFormula(5, 5, formula, GC.Spread.Sheets.SheetArea.viewport);

Parameters

Name	Type	Description
`range`	`Range`	工作表中的单元格范围。
`baseRow?`	`number`	公式的基准行索引。
`baseCol?`	`number`	公式的基准列索引。
`rangeReferenceRelative?`	`RangeReferenceRelative`	范围引用是相对还是绝对。
`useR1C1?`	`boolean`	是否使用r1c1引用样式。

Returns

string

引用指定单元格范围的公式字符串。

rangesToFormula

▸ rangesToFormula(ranges, baseRow?, baseCol?, rangeReferenceRelative?, useR1C1?): string

将指定的单元格范围转换为公式字符串。

example

spread = new GC.Spread.Sheets.Workbook(document.getElementById('ss'), { sheetCount: 1 });
sheet = spread.getSheet(0);
// 设置值
sheet.setValue(0, 0, 1, 3);
sheet.setValue(1, 0, 50, 3);
sheet.setValue(2, 0, 100, 3);
sheet.setValue(3, 0, 2, 3);
sheet.setValue(4, 0, 60, 3);
sheet.setValue(5, 0, 90, 3);
sheet.setValue(6, 0, 3, 3);
sheet.setValue(7, 0, 40, 3);
sheet.clearSelection();
// 添加选择
sheet.addSelection(0, 0, 3, 1);
sheet.addSelection(5, 0, 2, 1);
var ranges = sheet.getSelections();
// 获取范围字符串
var rangesStr = GC.Spread.Sheets.CalcEngine.rangesToFormula(ranges);
// 使用选定的范围创建公式
var formula = "Sum(" + rangesStr + ")";
// 在工作表单元格中设置公式
sheet.setFormula(5, 5, formula, GC.Spread.Sheets.SheetArea.viewport);

Parameters

Name	Type	Description
`ranges`	`Range`[]	工作表中的单元格范围。
`baseRow?`	`number`	公式的基准行索引。
`baseCol?`	`number`	公式的基准列索引。
`rangeReferenceRelative?`	`RangeReferenceRelative`	范围引用是相对还是绝对。
`useR1C1?`	`boolean`	是否使用r1c1引用样式。

Returns

string

引用指定单元格范围的公式字符串。

SpreadJS 中文文档

GC.Spread.Sheets.CalcEngine

Namespace: CalcEngine

Table of contents

Enumerations

Interfaces

Functions

Functions

evaluateFormula

Parameters

Returns

evaluateFormulaAsync

Parameters

Returns

expressionToFormula

Parameters

Returns

formulaToExpression

Parameters

Returns

formulaToRanges

Parameters

Returns

goalSeek

Parameters

Returns

rangeToFormula

Parameters

Returns

rangesToFormula

Parameters

Returns