Class: FFormula

get lexerTreeBuilder(): LexerTreeBuilder

calculationEnd(callback): IDisposable

calculationProcessing(callback): IDisposable

calculationStart(callback): IDisposable

executeCalculation(): void

moveFormulaRefOffset(
   formulaString, 
   refOffsetX, 
   refOffsetY, 
   ignoreAbsolute?): string

const result = moveFormulaRefOffset('sum(a1,b2)',1,1)
// result  is 'sum(b2,c3)'

onCalculationEnd(): Promise<void>

registerAsyncFunction(
   name, 
   func, 
   description?): IDisposable

univerAPI.getFormula().registerAsyncFunction('RANDOM_DELAYED',
  async () => {
    await new Promise(resolve => setTimeout(resolve, 500));
    return Math.random();
  },
  'Mock a random number generation function'
);
 
// Use in cell
univerAPI.getActiveWorkbook().getActiveSheet().getRange('A1').setValue({ f: '=RANDOM_DELAYED()' });
// After 0.5 second, A1 will display a random number

registerAsyncFunction(
   name, 
   func, 
   options): IDisposable

// Mock a user score fetching function
univerAPI.getFormula().registerAsyncFunction('FETCH_USER_SCORE',
  async (userId) => {
    await new Promise(resolve => setTimeout(resolve, 1000));
    // Mock fetching user score from database
    return userId * 10 + Math.floor(Math.random() * 20);
  },
  {
    description: 'customFunction.description.FETCH_USER_SCORE',
    locales: {
      'zhCN': {
         'customFunction': {
             'description': {
                 'FETCH_USER_SCORE': '从数据库中获取用户分数'
             }
         }
      },
      'enUS': {
         'customFunction': {
             'description': {
                 'FETCH_USER_SCORE': 'Mock fetching user score from database'
             }
         }
      }
    }
  }
);
 
// Use in cell
univerAPI.getActiveWorkbook().getActiveSheet().getRange('A1').setValue({ f: '=FETCH_USER_SCORE(42)' });
// After 1 second, A1 will display a score

registerFunction(
   name, 
   func, 
   description?): IDisposable

univerAPI.getFormula().registerFunction('HELLO', (name) => `Hello, ${name}!`, 'A simple greeting function');
 
// Use the function in a cell
univerAPI.getActiveWorkbook().getActiveSheet().getRange('A1').setValue('World');
univerAPI.getActiveWorkbook().getActiveSheet().getRange('A2').setValue({ f: '=HELLO(A1)' });
// A2 will display: "Hello, World!"

univerAPI.getFormula().registerFunction(
  'DISCOUNT',
  (price, discountPercent) => price * (1 - discountPercent / 100),
  'Calculates final price after discount'
);
 
// Use in cell
univerAPI.getActiveWorkbook().getActiveSheet().getRange('A1').setValue(100);
univerAPI.getActiveWorkbook().getActiveSheet().getRange('A2').setValue({ f: '=DISCOUNT(A1, 20)' });
// A2 will display: 80

// Registered formulas support lambda functions
univerAPI.getFormula().registerFunction('CUSTOMSUM', (...variants) => {
     let sum = 0;
 
     const last = variants[variants.length - 1];
     if (last.isLambda && last.isLambda()) {
         variants.pop();
 
         const variantsList = variants.map((variant) => Array.isArray(variant) ? variant[0][0]: variant);
 
         sum += last.executeCustom(...variantsList).getValue();
     }
 
     for (const variant of variants) {
         sum += Number(variant) || 0;
     }
 
     return sum;
}, 'Adds its arguments');

registerFunction(
   name, 
   func, 
   options): IDisposable

univerAPI.getFormula().registerFunction('HELLO',
  (name) => {
    return `Hello, ${name}!`;
  },
  {
    description: 'customFunction.HELLO.description',
    locales: {
      'zhCN': {
        'customFunction' : {
          'HELLO' : {
            'description': '一个简单的问候函数'
          }
        }
      },
      'enUS': {
        'customFunction' : {
          'HELLO' : {
            'description': 'A simple greeting function'
          }
        }
      }
    }
  }
);
 
// Use in cell
univerAPI.getActiveWorkbook().getActiveSheet().getRange('A1').setValue({ f: '=HELLO("John")' });
// A1 will display: "Hello, John!"

sequenceNodesBuilder(formulaString): any[]

setInitialFormulaComputing(calculationMode): void

setMaxIteration(maxIteration): void

// Set the maximum number of iterations for the formula calculation to 5.
// The default value is 1.
const formulaEngine = univerAPI.getFormula();
formulaEngine.setMaxIteration(5);

stopCalculation(): void