@univerjs/sheets-formula 0.2.5 → 0.2.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3136,13 +3136,13 @@
3136
3136
  }
3137
3137
  ],
3138
3138
  "functionParameter": {
3139
- "number1": {
3140
- "name": "number1",
3141
- "detail": "first"
3139
+ "number": {
3140
+ "name": "number",
3141
+ "detail": "The number you want to truncate."
3142
3142
  },
3143
- "number2": {
3144
- "name": "number2",
3145
- "detail": "second"
3143
+ "numDigits": {
3144
+ "name": "num_digits",
3145
+ "detail": "A number specifying the precision of the truncation. The default value for num_digits is 0 (zero)."
3146
3146
  }
3147
3147
  }
3148
3148
  },
@@ -5496,13 +5496,17 @@
5496
5496
  }
5497
5497
  ],
5498
5498
  "functionParameter": {
5499
- "number1": {
5500
- "name": "number1",
5501
- "detail": "first"
5499
+ "array": {
5500
+ "name": "array",
5501
+ "detail": "The array containing the columns to be returned in the new array."
5502
5502
  },
5503
- "number2": {
5504
- "name": "number2",
5505
- "detail": "second"
5503
+ "colNum1": {
5504
+ "name": "col_num1",
5505
+ "detail": "The first column to be returned."
5506
+ },
5507
+ "colNum2": {
5508
+ "name": "col_num2",
5509
+ "detail": "Additional columns to be returned."
5506
5510
  }
5507
5511
  }
5508
5512
  },
@@ -5516,13 +5520,17 @@
5516
5520
  }
5517
5521
  ],
5518
5522
  "functionParameter": {
5519
- "number1": {
5520
- "name": "number1",
5521
- "detail": "first"
5523
+ "array": {
5524
+ "name": "array",
5525
+ "detail": "The array containing the rows to be returned in the new array."
5522
5526
  },
5523
- "number2": {
5524
- "name": "number2",
5525
- "detail": "second"
5527
+ "rowNum1": {
5528
+ "name": "row_num1",
5529
+ "detail": "The first row number to be returned."
5530
+ },
5531
+ "rowNum2": {
5532
+ "name": "row_num2",
5533
+ "detail": "Additional row numbers to be returned."
5526
5534
  }
5527
5535
  }
5528
5536
  },
@@ -5608,13 +5616,17 @@
5608
5616
  }
5609
5617
  ],
5610
5618
  "functionParameter": {
5611
- "number1": {
5612
- "name": "number1",
5613
- "detail": "first"
5619
+ "array": {
5620
+ "name": "array",
5621
+ "detail": "The range or array to filter."
5614
5622
  },
5615
- "number2": {
5616
- "name": "number2",
5617
- "detail": "second"
5623
+ "include": {
5624
+ "name": "include",
5625
+ "detail": "An array of Boolean values ​​where TRUE indicates that a row or column is to be retained."
5626
+ },
5627
+ "ifEmpty": {
5628
+ "name": "if_empty",
5629
+ "detail": "If no items are reserved, return."
5618
5630
  }
5619
5631
  }
5620
5632
  },
@@ -5696,13 +5708,13 @@
5696
5708
  }
5697
5709
  ],
5698
5710
  "functionParameter": {
5699
- "number1": {
5700
- "name": "number1",
5701
- "detail": "first"
5711
+ "array1": {
5712
+ "name": "array",
5713
+ "detail": "The arrays to append."
5702
5714
  },
5703
- "number2": {
5704
- "name": "number2",
5705
- "detail": "second"
5715
+ "array2": {
5716
+ "name": "array",
5717
+ "detail": "The arrays to append."
5706
5718
  }
5707
5719
  }
5708
5720
  },
@@ -5936,13 +5948,21 @@
5936
5948
  }
5937
5949
  ],
5938
5950
  "functionParameter": {
5939
- "number1": {
5940
- "name": "number1",
5941
- "detail": "first"
5951
+ "array": {
5952
+ "name": "array",
5953
+ "detail": "The range or array to be sorted."
5942
5954
  },
5943
- "number2": {
5944
- "name": "number2",
5945
- "detail": "second"
5955
+ "sortIndex": {
5956
+ "name": "sort_index",
5957
+ "detail": "A number indicating the sort order (by row or by column)."
5958
+ },
5959
+ "sortOrder": {
5960
+ "name": "sort_order",
5961
+ "detail": "A number representing the desired sort order; 1 for ascending (default), -1 for descending."
5962
+ },
5963
+ "byCol": {
5964
+ "name": "by_col",
5965
+ "detail": "Logical value indicating the desired sort direction; FALSE sorts by rows (default), TRUE sorts by columns."
5946
5966
  }
5947
5967
  }
5948
5968
  },
@@ -5956,13 +5976,25 @@
5956
5976
  }
5957
5977
  ],
5958
5978
  "functionParameter": {
5959
- "number1": {
5960
- "name": "number1",
5961
- "detail": "first"
5979
+ "array": {
5980
+ "name": "array",
5981
+ "detail": "The range or array to be sorted."
5962
5982
  },
5963
- "number2": {
5964
- "name": "number2",
5965
- "detail": "second"
5983
+ "byArray1": {
5984
+ "name": "by_array1",
5985
+ "detail": "The range or array to sort based on."
5986
+ },
5987
+ "sortOrder1": {
5988
+ "name": "sort_order1",
5989
+ "detail": "A number representing the desired sort order; 1 for ascending (default), -1 for descending."
5990
+ },
5991
+ "byArray2": {
5992
+ "name": "by_array2",
5993
+ "detail": "The range or array to sort based on."
5994
+ },
5995
+ "sortOrder2": {
5996
+ "name": "sort_order2",
5997
+ "detail": "A number representing the desired sort order; 1 for ascending (default), -1 for descending."
5966
5998
  }
5967
5999
  }
5968
6000
  },
@@ -6036,13 +6068,9 @@
6036
6068
  }
6037
6069
  ],
6038
6070
  "functionParameter": {
6039
- "number1": {
6040
- "name": "number1",
6041
- "detail": "first"
6042
- },
6043
- "number2": {
6044
- "name": "number2",
6045
- "detail": "second"
6071
+ "array": {
6072
+ "name": "array",
6073
+ "detail": "A range of cells or an array in a worksheet."
6046
6074
  }
6047
6075
  }
6048
6076
  },
@@ -6056,13 +6084,17 @@
6056
6084
  }
6057
6085
  ],
6058
6086
  "functionParameter": {
6059
- "number1": {
6060
- "name": "number1",
6061
- "detail": "first"
6087
+ "array": {
6088
+ "name": "array",
6089
+ "detail": "The range or array from which unique rows or columns are returned."
6062
6090
  },
6063
- "number2": {
6064
- "name": "number2",
6065
- "detail": "second"
6091
+ "byCol": {
6092
+ "name": "by_col",
6093
+ "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."
6094
+ },
6095
+ "exactlyOnce": {
6096
+ "name": "exactly_once",
6097
+ "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."
6066
6098
  }
6067
6099
  }
6068
6100
  },
@@ -6104,13 +6136,13 @@
6104
6136
  }
6105
6137
  ],
6106
6138
  "functionParameter": {
6107
- "number1": {
6108
- "name": "number1",
6109
- "detail": "first"
6139
+ "array1": {
6140
+ "name": "array",
6141
+ "detail": "The arrays to append."
6110
6142
  },
6111
- "number2": {
6112
- "name": "number2",
6113
- "detail": "second"
6143
+ "array2": {
6144
+ "name": "array",
6145
+ "detail": "The arrays to append."
6114
6146
  }
6115
6147
  }
6116
6148
  },
@@ -6976,13 +7008,13 @@
6976
7008
  }
6977
7009
  ],
6978
7010
  "functionParameter": {
6979
- "number1": {
6980
- "name": "number1",
6981
- "detail": "first"
7011
+ "text": {
7012
+ "name": "text",
7013
+ "detail": "The text you want to repeat."
6982
7014
  },
6983
- "number2": {
6984
- "name": "number2",
6985
- "detail": "second"
7015
+ "numberTimes": {
7016
+ "name": "numberTimes",
7017
+ "detail": "A positive number specifying the number of times to repeat text."
6986
7018
  }
6987
7019
  }
6988
7020
  },
@@ -7136,13 +7168,29 @@
7136
7168
  }
7137
7169
  ],
7138
7170
  "functionParameter": {
7139
- "number1": {
7140
- "name": "number1",
7141
- "detail": "first"
7171
+ "text": {
7172
+ "name": "text",
7173
+ "detail": "The text you are searching within. Wildcard characters not allowed."
7142
7174
  },
7143
- "number2": {
7144
- "name": "number2",
7145
- "detail": "second"
7175
+ "delimiter": {
7176
+ "name": "delimiter",
7177
+ "detail": "The text that marks the point after which you want to extract."
7178
+ },
7179
+ "instanceNum": {
7180
+ "name": "instance_num",
7181
+ "detail": "The instance of the delimiter after which you want to extract the text."
7182
+ },
7183
+ "matchMode": {
7184
+ "name": "match_mode",
7185
+ "detail": "Determines whether the text search is case-sensitive. The default is case-sensitive."
7186
+ },
7187
+ "matchEnd": {
7188
+ "name": "match_end",
7189
+ "detail": "Treats the end of text as a delimiter. By default, the text is an exact match."
7190
+ },
7191
+ "ifNotFound": {
7192
+ "name": "if_not_found",
7193
+ "detail": "Value returned if no match is found. By default, #N/A is returned."
7146
7194
  }
7147
7195
  }
7148
7196
  },
@@ -7156,13 +7204,29 @@
7156
7204
  }
7157
7205
  ],
7158
7206
  "functionParameter": {
7159
- "number1": {
7160
- "name": "number1",
7161
- "detail": "first"
7207
+ "text": {
7208
+ "name": "text",
7209
+ "detail": "The text you are searching within. Wildcard characters not allowed."
7162
7210
  },
7163
- "number2": {
7164
- "name": "number2",
7165
- "detail": "second"
7211
+ "delimiter": {
7212
+ "name": "delimiter",
7213
+ "detail": "The text that marks the point after which you want to extract."
7214
+ },
7215
+ "instanceNum": {
7216
+ "name": "instance_num",
7217
+ "detail": "The instance of the delimiter after which you want to extract the text."
7218
+ },
7219
+ "matchMode": {
7220
+ "name": "match_mode",
7221
+ "detail": "Determines whether the text search is case-sensitive. The default is case-sensitive."
7222
+ },
7223
+ "matchEnd": {
7224
+ "name": "match_end",
7225
+ "detail": "Treats the end of text as a delimiter. By default, the text is an exact match."
7226
+ },
7227
+ "ifNotFound": {
7228
+ "name": "if_not_found",
7229
+ "detail": "Value returned if no match is found. By default, #N/A is returned."
7166
7230
  }
7167
7231
  }
7168
7232
  },
@@ -7196,13 +7260,29 @@
7196
7260
  }
7197
7261
  ],
7198
7262
  "functionParameter": {
7199
- "number1": {
7200
- "name": "number1",
7201
- "detail": "first"
7263
+ "text": {
7264
+ "name": "text",
7265
+ "detail": "The text to split."
7202
7266
  },
7203
- "number2": {
7204
- "name": "number2",
7205
- "detail": "second"
7267
+ "colDelimiter": {
7268
+ "name": "col_delimiter",
7269
+ "detail": "The character or string by which to split the column."
7270
+ },
7271
+ "rowDelimiter": {
7272
+ "name": "row_delimiter",
7273
+ "detail": "The character or string on which to split the line."
7274
+ },
7275
+ "ignoreEmpty": {
7276
+ "name": "ignore_empty",
7277
+ "detail": "Whether to ignore empty cells. The default is FALSE."
7278
+ },
7279
+ "matchMode": {
7280
+ "name": "match_mode",
7281
+ "detail": "Searches for a delimiter match in the text. By default, a case-sensitive match is done."
7282
+ },
7283
+ "padWith": {
7284
+ "name": "pad_with",
7285
+ "detail": "The value to use for padding. By default, #N/A is used."
7206
7286
  }
7207
7287
  }
7208
7288
  },
@@ -3136,13 +3136,13 @@
3136
3136
  }
3137
3137
  ],
3138
3138
  "functionParameter": {
3139
- "number1": {
3140
- "name": "number1",
3141
- "detail": "first"
3139
+ "number": {
3140
+ "name": "number",
3141
+ "detail": "The number you want to truncate."
3142
3142
  },
3143
- "number2": {
3144
- "name": "number2",
3145
- "detail": "second"
3143
+ "numDigits": {
3144
+ "name": "num_digits",
3145
+ "detail": "A number specifying the precision of the truncation. The default value for num_digits is 0 (zero)."
3146
3146
  }
3147
3147
  }
3148
3148
  },
@@ -5496,13 +5496,17 @@
5496
5496
  }
5497
5497
  ],
5498
5498
  "functionParameter": {
5499
- "number1": {
5500
- "name": "number1",
5501
- "detail": "first"
5499
+ "array": {
5500
+ "name": "array",
5501
+ "detail": "The array containing the columns to be returned in the new array."
5502
5502
  },
5503
- "number2": {
5504
- "name": "number2",
5505
- "detail": "second"
5503
+ "colNum1": {
5504
+ "name": "col_num1",
5505
+ "detail": "The first column to be returned."
5506
+ },
5507
+ "colNum2": {
5508
+ "name": "col_num2",
5509
+ "detail": "Additional columns to be returned."
5506
5510
  }
5507
5511
  }
5508
5512
  },
@@ -5516,13 +5520,17 @@
5516
5520
  }
5517
5521
  ],
5518
5522
  "functionParameter": {
5519
- "number1": {
5520
- "name": "number1",
5521
- "detail": "first"
5523
+ "array": {
5524
+ "name": "array",
5525
+ "detail": "The array containing the rows to be returned in the new array."
5522
5526
  },
5523
- "number2": {
5524
- "name": "number2",
5525
- "detail": "second"
5527
+ "rowNum1": {
5528
+ "name": "row_num1",
5529
+ "detail": "The first row number to be returned."
5530
+ },
5531
+ "rowNum2": {
5532
+ "name": "row_num2",
5533
+ "detail": "Additional row numbers to be returned."
5526
5534
  }
5527
5535
  }
5528
5536
  },
@@ -5608,13 +5616,17 @@
5608
5616
  }
5609
5617
  ],
5610
5618
  "functionParameter": {
5611
- "number1": {
5612
- "name": "number1",
5613
- "detail": "first"
5619
+ "array": {
5620
+ "name": "array",
5621
+ "detail": "The range or array to filter."
5614
5622
  },
5615
- "number2": {
5616
- "name": "number2",
5617
- "detail": "second"
5623
+ "include": {
5624
+ "name": "include",
5625
+ "detail": "An array of Boolean values ​​where TRUE indicates that a row or column is to be retained."
5626
+ },
5627
+ "ifEmpty": {
5628
+ "name": "if_empty",
5629
+ "detail": "If no items are reserved, return."
5618
5630
  }
5619
5631
  }
5620
5632
  },
@@ -5696,13 +5708,13 @@
5696
5708
  }
5697
5709
  ],
5698
5710
  "functionParameter": {
5699
- "number1": {
5700
- "name": "number1",
5701
- "detail": "first"
5711
+ "array1": {
5712
+ "name": "array",
5713
+ "detail": "The arrays to append."
5702
5714
  },
5703
- "number2": {
5704
- "name": "number2",
5705
- "detail": "second"
5715
+ "array2": {
5716
+ "name": "array",
5717
+ "detail": "The arrays to append."
5706
5718
  }
5707
5719
  }
5708
5720
  },
@@ -5936,13 +5948,21 @@
5936
5948
  }
5937
5949
  ],
5938
5950
  "functionParameter": {
5939
- "number1": {
5940
- "name": "number1",
5941
- "detail": "first"
5951
+ "array": {
5952
+ "name": "array",
5953
+ "detail": "The range or array to be sorted."
5942
5954
  },
5943
- "number2": {
5944
- "name": "number2",
5945
- "detail": "second"
5955
+ "sortIndex": {
5956
+ "name": "sort_index",
5957
+ "detail": "A number indicating the sort order (by row or by column)."
5958
+ },
5959
+ "sortOrder": {
5960
+ "name": "sort_order",
5961
+ "detail": "A number representing the desired sort order; 1 for ascending (default), -1 for descending."
5962
+ },
5963
+ "byCol": {
5964
+ "name": "by_col",
5965
+ "detail": "Logical value indicating the desired sort direction; FALSE sorts by rows (default), TRUE sorts by columns."
5946
5966
  }
5947
5967
  }
5948
5968
  },
@@ -5956,13 +5976,25 @@
5956
5976
  }
5957
5977
  ],
5958
5978
  "functionParameter": {
5959
- "number1": {
5960
- "name": "number1",
5961
- "detail": "first"
5979
+ "array": {
5980
+ "name": "array",
5981
+ "detail": "The range or array to be sorted."
5962
5982
  },
5963
- "number2": {
5964
- "name": "number2",
5965
- "detail": "second"
5983
+ "byArray1": {
5984
+ "name": "by_array1",
5985
+ "detail": "The range or array to sort based on."
5986
+ },
5987
+ "sortOrder1": {
5988
+ "name": "sort_order1",
5989
+ "detail": "A number representing the desired sort order; 1 for ascending (default), -1 for descending."
5990
+ },
5991
+ "byArray2": {
5992
+ "name": "by_array2",
5993
+ "detail": "The range or array to sort based on."
5994
+ },
5995
+ "sortOrder2": {
5996
+ "name": "sort_order2",
5997
+ "detail": "A number representing the desired sort order; 1 for ascending (default), -1 for descending."
5966
5998
  }
5967
5999
  }
5968
6000
  },
@@ -6036,13 +6068,9 @@
6036
6068
  }
6037
6069
  ],
6038
6070
  "functionParameter": {
6039
- "number1": {
6040
- "name": "number1",
6041
- "detail": "first"
6042
- },
6043
- "number2": {
6044
- "name": "number2",
6045
- "detail": "second"
6071
+ "array": {
6072
+ "name": "array",
6073
+ "detail": "A range of cells or an array in a worksheet."
6046
6074
  }
6047
6075
  }
6048
6076
  },
@@ -6056,13 +6084,17 @@
6056
6084
  }
6057
6085
  ],
6058
6086
  "functionParameter": {
6059
- "number1": {
6060
- "name": "number1",
6061
- "detail": "first"
6087
+ "array": {
6088
+ "name": "array",
6089
+ "detail": "The range or array from which unique rows or columns are returned."
6062
6090
  },
6063
- "number2": {
6064
- "name": "number2",
6065
- "detail": "second"
6091
+ "byCol": {
6092
+ "name": "by_col",
6093
+ "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."
6094
+ },
6095
+ "exactlyOnce": {
6096
+ "name": "exactly_once",
6097
+ "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."
6066
6098
  }
6067
6099
  }
6068
6100
  },
@@ -6104,13 +6136,13 @@
6104
6136
  }
6105
6137
  ],
6106
6138
  "functionParameter": {
6107
- "number1": {
6108
- "name": "number1",
6109
- "detail": "first"
6139
+ "array1": {
6140
+ "name": "array",
6141
+ "detail": "The arrays to append."
6110
6142
  },
6111
- "number2": {
6112
- "name": "number2",
6113
- "detail": "second"
6143
+ "array2": {
6144
+ "name": "array",
6145
+ "detail": "The arrays to append."
6114
6146
  }
6115
6147
  }
6116
6148
  },
@@ -2989,13 +2989,13 @@
2989
2989
  }
2990
2990
  ],
2991
2991
  "functionParameter": {
2992
- "number1": {
2993
- "name": "number1",
2994
- "detail": "first"
2992
+ "number": {
2993
+ "name": "number",
2994
+ "detail": "The number you want to truncate."
2995
2995
  },
2996
- "number2": {
2997
- "name": "number2",
2998
- "detail": "second"
2996
+ "numDigits": {
2997
+ "name": "num_digits",
2998
+ "detail": "A number specifying the precision of the truncation. The default value for num_digits is 0 (zero)."
2999
2999
  }
3000
3000
  }
3001
3001
  },