@syncfusion/ej2-calculate 35.1.37

package/src/formulas/text.d.ts

@@ -0,0 +1,125 @@
+import { IBasicFormula } from '../common/index';
+import { FormulaOwner } from './formula-owner';
+import { FormulaModuleBase } from './formula-module-base';
+/**
+ * Core text manipulation: concatenation, case conversion, trimming, and substring extraction.
+ *
+ * Registers 10 functions including FIND, CONCATENATE, CONCAT, T, EXACT, and others.
+ *
+ * @hidden
+ */
+export declare class TextFormulas extends FormulaModuleBase {
+    private isConcat;
+    /** Formula definitions registered with {@link BasicFormulas}. */
+    formulas: IBasicFormula[];
+    /**
+     * @hidden
+     * @param {FormulaOwner} owner - Formula registration owner ({@link BasicFormulas}).
+     */
+    constructor(owner: FormulaOwner);
+    /**
+     * Returns the position of a string of text within another string.
+     *
+     * Excel: `FIND(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed Excel-compatible numeric or text result, or an error token such as `#VALUE!`, `#NUM!`, `#N/A`.
+     *
+     * @example
+     * ```ts
+     * engine.computeFormula('=FIND(1)');
+     * ```
+     */
+    ComputeFIND(...args: string[]): string | number;
+    /**
+     *  Used to join two or more strings together.
+     *
+     * Excel: `CONCATENATE(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed text result or an Excel error token such as `#VALUE!`.
+     */
+    ComputeCONCATENATE(...args: string[]): string;
+    /**
+     * Concatenates a list or range of text strings.
+     *
+     * Excel: `CONCAT(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed text result or an Excel error token such as `#VALUE!`.
+     */
+    ComputeCONCAT(...args: string[]): string;
+    /**
+     * Checks whether a value is text or not and returns the text.
+     *
+     * Excel: `T(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed text result or an Excel error token such as `#VALUE!`.
+     */
+    ComputeT(...args: string[]): string;
+    /**
+     * Checks whether a two text strings are exactly same and returns TRUE or FALSE.
+     *
+     * Excel: `EXACT(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {boolean} - Boolean result, nested-formula numeric string (`"0"`/`"1"`), or an Excel error token.
+     */
+    ComputeEXACT(...args: string[]): string | boolean;
+    /**
+     * Returns a number of characters in a given string.
+     *
+     * Excel: `LEN(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed Excel-compatible numeric or text result, or an error token such as `#VALUE!`, `#NUM!`, `#N/A`.
+     */
+    ComputeLEN(...args: string[]): string | number;
+    /**
+     * Returns the character from the specified number.
+     *
+     * Excel: `CHAR(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed Excel-compatible numeric or text result, or an error token such as `#VALUE!`, `#NUM!`, `#N/A`.
+     */
+    ComputeCHAR(...args: string[]): string | number;
+    /**
+     * Returns the numeric code for the first character in a given string.
+     *
+     * Excel: `CODE(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed Excel-compatible numeric or text result, or an error token such as `#VALUE!`, `#NUM!`, `#N/A`.
+     */
+    ComputeCODE(...args: string[]): string | number;
+    /**
+     * Converts the number to currency formatted text.
+     *
+     * Excel: `DOLLAR(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed Excel-compatible numeric or text result, or an error token such as `#VALUE!`, `#NUM!`, `#N/A`.
+     */
+    ComputeDOLLAR(...args: string[]): string | number;
+    /**
+     * Converts a text to proper case; first letter to uppercase and other letters to lowercase.
+     *
+     * Excel: `PROPER(...)`.
+     *
+     * @hidden
+     * @param {string[]} args - Formula argument tokens from the Calculate engine.
+     * @returns {string | number} - Computed text result or an Excel error token such as `#VALUE!`.
+     */
+    ComputePROPER(...args: string[]): string;
+}