@univerjs/sheets-formula 0.2.5 → 0.2.7

package/lib/locale/en-US.json

@@ -2182,7 +2182,7 @@
       },
       "FLOOR_PRECISE": {
         "description": "Rounds a number down to the nearest integer or to the nearest multiple of significance. Regardless of the sign of the number, the number is rounded down.",
-        "abstract": "Rounds a number down to the nearest integer or to the nearest multiple of significance. Regardless of the sign of the number, the number is rounded down.",
+        "abstract": "Rounds a number down to the nearest integer or to the nearest multiple of significance.",
         "links": [
           {
             "title": "Instruction",
@@ -2608,7 +2608,7 @@
       },
       "RANDARRAY": {
         "description": "Returns an array of random numbers between 0 and 1. However, you can specify the number of rows and columns to fill, minimum and maximum values, and whether to return whole numbers or decimal values.",
-        "abstract": "Returns an array of random numbers between 0 and 1. However, you can specify the number of rows and columns to fill, minimum and maximum values, and whether to return whole numbers or decimal values.",
+        "abstract": "Returns an array of random numbers between 0 and 1.",
         "links": [
           {
             "title": "Instruction",
@@ -2963,8 +2963,8 @@
         }
       },
       "SUMIFS": {
-        "description": "Adds the cells in a range that meet multiple criteria",
-        "abstract": "Adds the cells in a range that meet multiple criteria",
+        "description": "Adds all of its arguments that meet multiple criteria.",
+        "abstract": "Adds all of its arguments that meet multiple criteria.",
         "links": [
           {
             "title": "Instruction",
@@ -3136,13 +3136,13 @@
           }
         ],
         "functionParameter": {
-          "number1": {
-            "name": "number1",
-            "detail": "first"
+          "number": {
+            "name": "number",
+            "detail": "The number you want to truncate."
           },
-          "number2": {
-            "name": "number2",
-            "detail": "second"
+          "numDigits": {
+            "name": "num_digits",
+            "detail": "A number specifying the precision of the truncation. The default value for num_digits is 0 (zero)."
           }
         }
       },
@@ -3533,11 +3533,11 @@
         ],
         "functionParameter": {
           "value1": {
-            "name": "Value 1",
+            "name": "value 1",
             "detail": "The first item, cell reference, or range within which you want to count numbers."
           },
           "value2": {
-            "name": "Value 2",
+            "name": "value 2",
             "detail": "Up to 255 additional items, cell references, or ranges within which you want to count numbers."
           }
         }
@@ -5452,13 +5452,9 @@
           }
         ],
         "functionParameter": {
-          "number1": {
-            "name": "number1",
-            "detail": "first"
-          },
-          "number2": {
-            "name": "number2",
-            "detail": "second"
+          "reference": {
+            "name": "reference",
+            "detail": "A reference to a cell or range of cells and can refer to multiple areas."
           }
         }
       },
@@ -5496,13 +5492,17 @@
           }
         ],
         "functionParameter": {
-          "number1": {
-            "name": "number1",
-            "detail": "first"
+          "array": {
+            "name": "array",
+            "detail": "The array containing the columns to be returned in the new array."
           },
-          "number2": {
-            "name": "number2",
-            "detail": "second"
+          "colNum1": {
+            "name": "col_num1",
+            "detail": "The first column to be returned."
+          },
+          "colNum2": {
+            "name": "col_num2",
+            "detail": "Additional columns to be returned."
           }
         }
       },
@@ -5516,13 +5516,17 @@
           }
         ],
         "functionParameter": {
-          "number1": {
-            "name": "number1",
-            "detail": "first"
+          "array": {
+            "name": "array",
+            "detail": "The array containing the rows to be returned in the new array."
           },
-          "number2": {
-            "name": "number2",
-            "detail": "second"
+          "rowNum1": {
+            "name": "row_num1",
+            "detail": "The first row number to be returned."
+          },
+          "rowNum2": {
+            "name": "row_num2",
+            "detail": "Additional row numbers to be returned."
           }
         }
       },
@@ -5608,13 +5612,17 @@
           }
         ],
         "functionParameter": {
-          "number1": {
-            "name": "number1",
-            "detail": "first"
+          "array": {
+            "name": "array",
+            "detail": "The range or array to filter."
           },
-          "number2": {
-            "name": "number2",
-            "detail": "second"
+          "include": {
+            "name": "include",
+            "detail": "An array of Boolean values ​​where TRUE indicates that a row or column is to be retained."
+          },
+          "ifEmpty": {
+            "name": "if_empty",
+            "detail": "If no items are reserved, return."
           }
         }
       },
@@ -5696,13 +5704,13 @@
           }
         ],
         "functionParameter": {
-          "number1": {
-            "name": "number1",
-            "detail": "first"
+          "array1": {
+            "name": "array",
+            "detail": "The arrays to append."
           },
-          "number2": {
-            "name": "number2",
-            "detail": "second"
+          "array2": {
+            "name": "array",
+            "detail": "The arrays to append."
           }
         }
       },
@@ -5758,7 +5766,7 @@
         "functionParameter": {
           "reference": {
             "name": "reference",
-            "detail": "A reference to one or more cell ranges.\nIf you are entering a non-adjacent range for the reference, enclose reference in parentheses.\nIf each area in reference contains only one row or column, the row_num or column_num argument, respectively, is optional. For example, for a single row reference, use INDEX(reference,,column_num).\nIf array has more than one row and more than one column, and only row_num or column_num is used, INDEX returns an array of the entire row or column in array."
+            "detail": "A reference to one or more cell ranges."
           },
           "rowNum": {
             "name": "row_num",
@@ -5770,7 +5778,7 @@
           },
           "areaNum": {
             "name": "area_num",
-            "detail": "Selects a range in reference from which to return the intersection of row_num and column_num. The first area selected or entered is numbered 1, the second is 2, and so on. If area_num is omitted, INDEX uses area 1.  The areas listed here must all be located on one sheet.  If you specify areas that are not on the same sheet as each other, it will cause a #VALUE! error.  If you need to use ranges that are located on different sheets from each other, it is recommended that you use the array form of the INDEX function, and use another function to calculate the range that makes up the array.  For example, you could use the CHOOSE function to calculate which range will be used."
+            "detail": "Selects a range in reference from which to return the intersection of row_num and column_num."
           }
         }
       },
@@ -5786,11 +5794,11 @@
         "functionParameter": {
           "refText": {
             "name": "ref_text",
-            "detail": "A reference to a cell that contains an A1-style reference, an R1C1-style reference, a name defined as a reference, or a reference to a cell as a text string. If ref_text is not a valid cell reference, INDIRECT returns the #REF! error value.\nIf ref_text refers to a cell range outside the row limit of 1,048,576 or the column limit of 16,384 (XFD), INDIRECT returns a #REF! error."
+            "detail": "A reference to a cell that contains an A1-style reference, an R1C1-style reference, a name defined as a reference, or a reference to a cell as a text string. "
           },
           "a1": {
             "name": "a1",
-            "detail": "A logical value that specifies what type of reference is contained in the cell ref_text.\nIf a1 is TRUE or omitted, ref_text is interpreted as an A1-style reference.\nIf a1 is FALSE, ref_text is interpreted as an R1C1-style reference."
+            "detail": "A logical value that specifies what type of reference is contained in the cell ref_text."
           }
         }
       },
@@ -5819,7 +5827,7 @@
         }
       },
       "MATCH": {
-        "description": "The MATCH function searches for a specified item in a range of cells, and then returns the relative position of that item in the range. For example, if the range A1:A3 contains the values 5, 25, and 38, then the formula =MATCH(25,A1:A3,0) returns the number 2, because 25 is the second item in the range.",
+        "description": "The MATCH function searches for a specified item in a range of cells, and then returns the relative position of that item in the range.",
         "abstract": "Looks up values in a reference or array",
         "links": [
           {
@@ -5830,7 +5838,7 @@
         "functionParameter": {
           "lookupValue": {
             "name": "lookup_value",
-            "detail": "The value that you want to match in lookup_array. For example, when you look up someone's number in a telephone book, you are using the person's name as the lookup value, but the telephone number is the value you want. The lookup_value argument can be a value (number, text, or logical value) or a cell reference to a number, text, or logical value."
+            "detail": "The value that you want to match in lookup_array."
           },
           "lookupArray": {
             "name": "lookup_array",
@@ -5838,7 +5846,7 @@
           },
           "matchType": {
             "name": "match_type",
-            "detail": "The number -1, 0, or 1. The match_type argument specifies how Excel matches lookup_value with values in lookup_array. The default value for this argument is 1."
+            "detail": "The number -1, 0, or 1."
           }
         }
       },
@@ -5854,15 +5862,15 @@
         "functionParameter": {
           "reference": {
             "name": "reference",
-            "detail": "The reference from which you want to base the offset. Reference must refer to a cell or range of adjacent cells; otherwise, OFFSET returns the #VALUE! error value."
+            "detail": "The reference from which you want to base the offset."
           },
           "rows": {
             "name": "rows",
-            "detail": "The number of rows, up or down, that you want the upper-left cell to refer to. Using 5 as the rows argument specifies that the upper-left cell in the reference is five rows below reference. Rows can be positive (which means below the starting reference) or negative (which means above the starting reference)."
+            "detail": "The number of rows, up or down, that you want the upper-left cell to refer to."
           },
           "cols": {
             "name": "columns",
-            "detail": "The number of columns, to the left or right, that you want the upper-left cell of the result to refer to. Using 5 as the cols argument specifies that the upper-left cell in the reference is five columns to the right of reference. Cols can be positive (which means to the right of the starting reference) or negative (which means to the left of the starting reference)."
+            "detail": "The number of columns, to the left or right, that you want the upper-left cell of the result to refer to."
           },
           "height": {
             "name": "height",
@@ -5936,13 +5944,21 @@
           }
         ],
         "functionParameter": {
-          "number1": {
-            "name": "number1",
-            "detail": "first"
+          "array": {
+            "name": "array",
+            "detail": "The range or array to be sorted."
           },
-          "number2": {
-            "name": "number2",
-            "detail": "second"
+          "sortIndex": {
+            "name": "sort_index",
+            "detail": "A number indicating the sort order (by row or by column)."
+          },
+          "sortOrder": {
+            "name": "sort_order",
+            "detail": "A number representing the desired sort order; 1 for ascending (default), -1 for descending."
+          },
+          "byCol": {
+            "name": "by_col",
+            "detail": "Logical value indicating the desired sort direction; FALSE sorts by rows (default), TRUE sorts by columns."
           }
         }
       },
@@ -5956,13 +5972,25 @@
           }
         ],
         "functionParameter": {
-          "number1": {
-            "name": "number1",
-            "detail": "first"
+          "array": {
+            "name": "array",
+            "detail": "The range or array to be sorted."
           },
-          "number2": {
-            "name": "number2",
-            "detail": "second"
+          "byArray1": {
+            "name": "by_array1",
+            "detail": "The range or array to sort based on."
+          },
+          "sortOrder1": {
+            "name": "sort_order1",
+            "detail": "A number representing the desired sort order; 1 for ascending (default), -1 for descending."
+          },
+          "byArray2": {
+            "name": "by_array2",
+            "detail": "The range or array to sort based on."
+          },
+          "sortOrder2": {
+            "name": "sort_order2",
+            "detail": "A number representing the desired sort order; 1 for ascending (default), -1 for descending."
           }
         }
       },
@@ -6036,13 +6064,9 @@
           }
         ],
         "functionParameter": {
-          "number1": {
-            "name": "number1",
-            "detail": "first"
-          },
-          "number2": {
-            "name": "number2",
-            "detail": "second"
+          "array": {
+            "name": "array",
+            "detail": "A range of cells or an array in a worksheet."
           }
         }
       },
@@ -6056,13 +6080,17 @@
           }
         ],
         "functionParameter": {
-          "number1": {
-            "name": "number1",
-            "detail": "first"
+          "array": {
+            "name": "array",
+            "detail": "The range or array from which unique rows or columns are returned."
           },
-          "number2": {
-            "name": "number2",
-            "detail": "second"
+          "byCol": {
+            "name": "by_col",
+            "detail": "Is a logical value: compares rows to each other and returns unique values ​​= FALSE, or is omitted; compares columns to each other and returns unique values ​​= TRUE."
+          },
+          "exactlyOnce": {
+            "name": "exactly_once",
+            "detail": "Is a logical value: returns rows or columns from the array that appear only once = TRUE; returns all distinct rows or columns from the array = FALSE, or has been omitted."
           }
         }
       },
@@ -6104,13 +6132,13 @@
           }
         ],
         "functionParameter": {
-          "number1": {
-            "name": "number1",
-            "detail": "first"
+          "array1": {
+            "name": "array",
+            "detail": "The arrays to append."
           },
-          "number2": {
-            "name": "number2",
-            "detail": "second"
+          "array2": {
+            "name": "array",
+            "detail": "The arrays to append."
           }
         }
       },
@@ -6177,15 +6205,15 @@
             "detail": "The array or range to return"
           },
           "ifNotFound": {
-            "name": "[if_not_found]",
+            "name": "if_not_found",
             "detail": "Where a valid match is not found, return the [if_not_found] text you supply. If a valid match is not found, and [if_not_found] is missing, #N/A is returned."
           },
           "matchMode": {
-            "name": "[match_mode]",
+            "name": "match_mode",
             "detail": "Specify the match type: 0 - Exact match. If none found, return #N/A. This is the default. -1 - Exact match. If none found, return the next smaller item. 1 - Exact match. If none found, return the next larger item. 2 - A wildcard match where *, ?, and ~ have special meaning."
           },
           "searchMode": {
-            "name": "[search_mode]",
+            "name": "search_mode",
             "detail": "Specify the search mode to use: 1 - Perform a search starting at the first item. This is the default. -1 - Perform a reverse search starting at the last item. 2 - Perform a binary search that relies on lookup_array being sorted in ascending order. If not sorted, invalid results will be returned. -2 - Perform a binary search that relies on lookup_array being sorted in descending order. If not sorted, invalid results will be returned."
           }
         }
@@ -6609,11 +6637,11 @@
         ],
         "functionParameter": {
           "text1": {
-            "name": "Text 1",
+            "name": "text1",
             "detail": "The first item to join. The item can be a text value, number, or cell reference."
           },
           "text2": {
-            "name": "Text 2",
+            "name": "text2",
             "detail": "Additional text items to join. You can have up to 255 items, up to a total of 8,192 characters."
           }
         }
@@ -6976,13 +7004,13 @@
           }
         ],
         "functionParameter": {
-          "number1": {
-            "name": "number1",
-            "detail": "first"
+          "text": {
+            "name": "text",
+            "detail": "The text you want to repeat."
           },
-          "number2": {
-            "name": "number2",
-            "detail": "second"
+          "numberTimes": {
+            "name": "number_times",
+            "detail": "A positive number specifying the number of times to repeat text."
           }
         }
       },
@@ -7136,13 +7164,29 @@
           }
         ],
         "functionParameter": {
-          "number1": {
-            "name": "number1",
-            "detail": "first"
+          "text": {
+            "name": "text",
+            "detail": "The text you are searching within. Wildcard characters not allowed."
           },
-          "number2": {
-            "name": "number2",
-            "detail": "second"
+          "delimiter": {
+            "name": "delimiter",
+            "detail": "The text that marks the point after which you want to extract."
+          },
+          "instanceNum": {
+            "name": "instance_num",
+            "detail": "The instance of the delimiter after which you want to extract the text."
+          },
+          "matchMode": {
+            "name": "match_mode",
+            "detail": "Determines whether the text search is case-sensitive. The default is case-sensitive."
+          },
+          "matchEnd": {
+            "name": "match_end",
+            "detail": "Treats the end of text as a delimiter. By default, the text is an exact match."
+          },
+          "ifNotFound": {
+            "name": "if_not_found",
+            "detail": "Value returned if no match is found. By default, #N/A is returned."
           }
         }
       },
@@ -7156,13 +7200,29 @@
           }
         ],
         "functionParameter": {
-          "number1": {
-            "name": "number1",
-            "detail": "first"
+          "text": {
+            "name": "text",
+            "detail": "The text you are searching within. Wildcard characters not allowed."
           },
-          "number2": {
-            "name": "number2",
-            "detail": "second"
+          "delimiter": {
+            "name": "delimiter",
+            "detail": "The text that marks the point after which you want to extract."
+          },
+          "instanceNum": {
+            "name": "instance_num",
+            "detail": "The instance of the delimiter after which you want to extract the text."
+          },
+          "matchMode": {
+            "name": "match_mode",
+            "detail": "Determines whether the text search is case-sensitive. The default is case-sensitive."
+          },
+          "matchEnd": {
+            "name": "match_end",
+            "detail": "Treats the end of text as a delimiter. By default, the text is an exact match."
+          },
+          "ifNotFound": {
+            "name": "if_not_found",
+            "detail": "Value returned if no match is found. By default, #N/A is returned."
           }
         }
       },
@@ -7196,13 +7256,29 @@
           }
         ],
         "functionParameter": {
-          "number1": {
-            "name": "number1",
-            "detail": "first"
+          "text": {
+            "name": "text",
+            "detail": "The text to split."
           },
-          "number2": {
-            "name": "number2",
-            "detail": "second"
+          "colDelimiter": {
+            "name": "col_delimiter",
+            "detail": "The character or string by which to split the column."
+          },
+          "rowDelimiter": {
+            "name": "row_delimiter",
+            "detail": "The character or string on which to split the line."
+          },
+          "ignoreEmpty": {
+            "name": "ignore_empty",
+            "detail": "Whether to ignore empty cells. The default is FALSE."
+          },
+          "matchMode": {
+            "name": "match_mode",
+            "detail": "Searches for a delimiter match in the text. By default, a case-sensitive match is done."
+          },
+          "padWith": {
+            "name": "pad_with",
+            "detail": "The value to use for padding. By default, #N/A is used."
           }
         }
       },
@@ -7447,24 +7523,15 @@
         }
       },
       "FALSE": {
-        "description": "Returns the logical value FALSE",
-        "abstract": "Returns the logical value FALSE",
+        "description": "Returns the logical value FALSE.",
+        "abstract": "Returns the logical value FALSE.",
         "links": [
           {
             "title": "Instruction",
             "url": "https://support.microsoft.com/en-us/office/false-function-2d58dfa5-9c03-4259-bf8f-f0ae14346904"
           }
         ],
-        "functionParameter": {
-          "number1": {
-            "name": "number1",
-            "detail": "first"
-          },
-          "number2": {
-            "name": "number2",
-            "detail": "second"
-          }
-        }
+        "functionParameter": {}
       },
       "IF": {
         "description": "Specifies a logical test to perform",
@@ -7520,13 +7587,13 @@
           }
         ],
         "functionParameter": {
-          "number1": {
-            "name": "number1",
-            "detail": "first"
+          "value": {
+            "name": "value",
+            "detail": "The argument that is checked for the #N/A error value."
           },
-          "number2": {
-            "name": "number2",
-            "detail": "second"
+          "valueIfNa": {
+            "name": "value_if_na",
+            "detail": "The value to return if the formula evaluates to the #N/A error value."
           }
         }
       },
@@ -7540,13 +7607,21 @@
           }
         ],
         "functionParameter": {
-          "number1": {
-            "name": "number1",
-            "detail": "first"
+          "logicalTest1": {
+            "name": "logical_test1",
+            "detail": "Condition that evaluates to TRUE or FALSE."
           },
-          "number2": {
-            "name": "number2",
-            "detail": "second"
+          "valueIfTrue1": {
+            "name": "value_if_true1",
+            "detail": "Result to be returned if logical_test1 evaluates to TRUE. Can be empty."
+          },
+          "logicalTest2": {
+            "name": "logical_test2",
+            "detail": "Condition that evaluates to TRUE or FALSE."
+          },
+          "valueIfTrue2": {
+            "name": "value_if_true2",
+            "detail": "Result to be returned if logical_testN evaluates to TRUE. Each value_if_trueN corresponds with a condition logical_testN. Can be empty."
           }
         }
       },
@@ -7615,8 +7690,8 @@
         }
       },
       "NOT": {
-        "description": "Reverses the logic of its argument",
-        "abstract": "Reverses the logic of its argument",
+        "description": "Reverses the logic of its argument.",
+        "abstract": "Reverses the logic of its argument.",
         "links": [
           {
             "title": "Instruction",
@@ -7624,13 +7699,9 @@
           }
         ],
         "functionParameter": {
-          "number1": {
-            "name": "number1",
-            "detail": "first"
-          },
-          "number2": {
-            "name": "number2",
-            "detail": "second"
+          "logical": {
+            "name": "logical",
+            "detail": "The condition that you want to reverse the logic for, which can evaluate to either TRUE or FALSE."
           }
         }
       },
@@ -7704,39 +7775,42 @@
           }
         ],
         "functionParameter": {
-          "number1": {
-            "name": "number1",
-            "detail": "first"
+          "expression": {
+            "name": "expression",
+            "detail": "Expression is the value (such as a number, date or some text) that will be compared against value1…value126."
           },
-          "number2": {
-            "name": "number2",
-            "detail": "second"
+          "value1": {
+            "name": "value1",
+            "detail": "ValueN is a value that will be compared against expression."
+          },
+          "result1": {
+            "name": "result1",
+            "detail": "ResultN is the value to be returned when the corresponding valueN argument matches expression. ResultN and must be supplied for each corresponding valueN argument."
+          },
+          "defaultOrValue2": {
+            "name": "default_or_value2",
+            "detail": "Default is the value to return in case no matches are found in the valueN expressions. The Default argument is identified by having no corresponding resultN expression (see examples). Default must be the final argument in the function."
+          },
+          "result2": {
+            "name": "result2",
+            "detail": "ResultN is the value to be returned when the corresponding valueN argument matches expression. ResultN and must be supplied for each corresponding valueN argument."
           }
         }
       },
       "TRUE": {
-        "description": "Returns the logical value TRUE",
-        "abstract": "Returns the logical value TRUE",
+        "description": "Returns the logical value TRUE.",
+        "abstract": "Returns the logical value TRUE.",
         "links": [
           {
             "title": "Instruction",
             "url": "https://support.microsoft.com/en-us/office/true-function-7652c6e3-8987-48d0-97cd-ef223246b3fb"
           }
         ],
-        "functionParameter": {
-          "number1": {
-            "name": "number1",
-            "detail": "first"
-          },
-          "number2": {
-            "name": "number2",
-            "detail": "second"
-          }
-        }
+        "functionParameter": {}
       },
       "XOR": {
-        "description": "Returns a logical exclusive OR of all arguments",
-        "abstract": "Returns a logical exclusive OR of all arguments",
+        "description": "Returns TRUE if an odd number of its arguments evaluate to TRUE, and FALSE if an even number of its arguments evaluate to TRUE.",
+        "abstract": "Returns TRUE if an odd number of arguments are TRUE",
         "links": [
           {
             "title": "Instruction",
@@ -7744,13 +7818,13 @@
           }
         ],
         "functionParameter": {
-          "number1": {
-            "name": "number1",
-            "detail": "first"
+          "logical1": {
+            "name": "logical1",
+            "detail": "The first condition that you want to test that can evaluate to either TRUE or FALSE."
           },
-          "number2": {
-            "name": "number2",
-            "detail": "second"
+          "logical2": {
+            "name": "logical2",
+            "detail": "Additional conditions that you want to test that can evaluate to either TRUE or FALSE, up to a maximum of 255 conditions."
           }
         }
       },