@thinkfree.dev/tfo-sdk 0.4.0 → 0.4.1
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.
- package/README.md +23 -6
- package/dist/apiReference.generated.js +179 -179
- package/dist/apiReference.generated.js.map +1 -1
- package/dist/index.d.ts +159 -159
- package/dist/index.js +1 -1
- package/dist/version.json +4 -4
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Every proxy method crosses a postMessage bridge and returns a Promise.
|
|
6
6
|
* ⚠️ AUTO-GENERATED — DO NOT EDIT.
|
|
7
7
|
*
|
|
8
|
-
* Generated: 2026-11-
|
|
8
|
+
* Generated: 2026-11-17
|
|
9
9
|
*/
|
|
10
10
|
/** Line dash type (OOXML a:prstDash). */
|
|
11
11
|
declare const LineDash: {
|
|
@@ -5728,13 +5728,6 @@ declare namespace Cell {
|
|
|
5728
5728
|
* @param sheet - sheet index (0-based, the array index in the getSheetList() result) or sheet name
|
|
5729
5729
|
*/
|
|
5730
5730
|
getWorksheet(sheet?: number | string): Promise<Worksheet>;
|
|
5731
|
-
/**
|
|
5732
|
-
* Returns an object by ID. It searches all sheets of the document, and currently only Chart is supported.
|
|
5733
|
-
* Returns null for an object that is not a chart.
|
|
5734
|
-
*
|
|
5735
|
-
* @param oid - unique ID that identifies the object
|
|
5736
|
-
*/
|
|
5737
|
-
getObjectById(oid: string): Promise<Chart>;
|
|
5738
5731
|
/**
|
|
5739
5732
|
* Returns a Table by name. The name is case-insensitive.
|
|
5740
5733
|
*
|
|
@@ -5749,6 +5742,21 @@ declare namespace Cell {
|
|
|
5749
5742
|
* @param sheet - sheet that the name is scoped to. If omitted, the entire workbook
|
|
5750
5743
|
*/
|
|
5751
5744
|
getDefinedName(name: string, sheet?: number | string): Promise<Name>;
|
|
5745
|
+
/**
|
|
5746
|
+
* Returns the list of defined names. Built-in names and names without a formula are excluded.
|
|
5747
|
+
* If sheet is omitted, the workbook-scoped names are returned.
|
|
5748
|
+
*
|
|
5749
|
+
* @param sheet - sheet that the name is scoped to. If omitted, the entire workbook
|
|
5750
|
+
* @returns Formulas start with `=`
|
|
5751
|
+
*/
|
|
5752
|
+
getDefinedNameList(sheet?: number | string): Promise<NameInfo[]>;
|
|
5753
|
+
/**
|
|
5754
|
+
* Returns an object by ID. It searches all sheets of the document, and currently only Chart is supported.
|
|
5755
|
+
* Returns null for an object that is not a chart.
|
|
5756
|
+
*
|
|
5757
|
+
* @param oid - unique ID that identifies the object
|
|
5758
|
+
*/
|
|
5759
|
+
getObjectById(oid: string): Promise<Chart>;
|
|
5752
5760
|
/**
|
|
5753
5761
|
* Creates a defined name.
|
|
5754
5762
|
* References in the formula that do not specify a sheet are resolved against the active sheet.
|
|
@@ -5760,14 +5768,6 @@ declare namespace Cell {
|
|
|
5760
5768
|
* @param sheet - sheet that the name is scoped to. If omitted, the entire workbook
|
|
5761
5769
|
*/
|
|
5762
5770
|
addDefinedName(name: string, formula: string, sheet?: number | string): Promise<Name>;
|
|
5763
|
-
/**
|
|
5764
|
-
* Returns the list of defined names. Built-in names and names without a formula are excluded.
|
|
5765
|
-
* If sheet is omitted, the workbook-scoped names are returned.
|
|
5766
|
-
*
|
|
5767
|
-
* @param sheet - sheet that the name is scoped to. If omitted, the entire workbook
|
|
5768
|
-
* @returns Formulas start with `=`
|
|
5769
|
-
*/
|
|
5770
|
-
getDefinedNameList(sheet?: number | string): Promise<NameInfo[]>;
|
|
5771
5771
|
/**
|
|
5772
5772
|
* Adds a new sheet at the end of the sheet list and makes it the active sheet.
|
|
5773
5773
|
*
|
|
@@ -5862,6 +5862,30 @@ declare namespace Cell {
|
|
|
5862
5862
|
* Returns the sheet properties in a single call.
|
|
5863
5863
|
*/
|
|
5864
5864
|
getSheetInfo(): Promise<SheetInfo>;
|
|
5865
|
+
/**
|
|
5866
|
+
* Returns a Range for a range on this sheet.
|
|
5867
|
+
*
|
|
5868
|
+
* @param range - target range. An A1 notation string is also accepted ("A1:B2", "E10" for a single cell, "5:5" for an entire row, or "A:C" for entire columns). An address with a sheet name ("Sheet1!A1") is not accepted
|
|
5869
|
+
*/
|
|
5870
|
+
getRange(range: string | RangeCoords): Promise<Range>;
|
|
5871
|
+
/**
|
|
5872
|
+
* Returns the list of table summaries on this sheet. To get a Table, call Workbook.getTable() with the name in the summary.
|
|
5873
|
+
*/
|
|
5874
|
+
getTableList(): Promise<TableInfo[]>;
|
|
5875
|
+
/**
|
|
5876
|
+
* Returns a Filter that manages the AutoFilter on this sheet. A Filter is returned even if no AutoFilter exists, and whether one exists is given by enabled in getInfo() of the Filter.
|
|
5877
|
+
*/
|
|
5878
|
+
getFilter(): Promise<Filter>;
|
|
5879
|
+
/**
|
|
5880
|
+
* Returns the list of data validation rules on this sheet.
|
|
5881
|
+
*
|
|
5882
|
+
* @returns formula1 and formula2 of a rule start with `=`, except that the comma-separated list of the list type is given without `=`
|
|
5883
|
+
*/
|
|
5884
|
+
getDataValidationList(): Promise<DataValidationInfo[]>;
|
|
5885
|
+
/**
|
|
5886
|
+
* Returns the list of cell comments on this sheet.
|
|
5887
|
+
*/
|
|
5888
|
+
getCommentList(): Promise<CommentInfo[]>;
|
|
5865
5889
|
/**
|
|
5866
5890
|
* Renames the sheet.
|
|
5867
5891
|
*
|
|
@@ -5914,12 +5938,6 @@ declare namespace Cell {
|
|
|
5914
5938
|
* @param zoomFactor - zoom factor where 1 is 100%. It must be greater than or equal to 0.5 and less than or equal to 1.5
|
|
5915
5939
|
*/
|
|
5916
5940
|
setZoom(zoomFactor: number): Promise<void>;
|
|
5917
|
-
/**
|
|
5918
|
-
* Returns a Range for a range on this sheet.
|
|
5919
|
-
*
|
|
5920
|
-
* @param range - target range. An A1 notation string is also accepted ("A1:B2", "E10" for a single cell, "5:5" for an entire row, or "A:C" for entire columns). An address with a sheet name ("Sheet1!A1") is not accepted
|
|
5921
|
-
*/
|
|
5922
|
-
getRange(range: string | RangeCoords): Promise<Range>;
|
|
5923
5941
|
/**
|
|
5924
5942
|
* Adds a chart to this sheet and returns the Chart. The title is taken from the data and set automatically.
|
|
5925
5943
|
* Up to 100 rows and 100 columns are supported.
|
|
@@ -5949,14 +5967,6 @@ declare namespace Cell {
|
|
|
5949
5967
|
* @param hasHeaders - whether the first row of the range is used as the header row (default: true)
|
|
5950
5968
|
*/
|
|
5951
5969
|
addTable(dataRange: string | RangeCoords, hasHeaders?: boolean): Promise<Table>;
|
|
5952
|
-
/**
|
|
5953
|
-
* Returns the list of table summaries on this sheet. To get a Table, call Workbook.getTable() with the name in the summary.
|
|
5954
|
-
*/
|
|
5955
|
-
getTableList(): Promise<TableInfo[]>;
|
|
5956
|
-
/**
|
|
5957
|
-
* Returns a Filter that manages the AutoFilter on this sheet. A Filter is returned even if no AutoFilter exists, and whether one exists is given by enabled in getInfo() of the Filter.
|
|
5958
|
-
*/
|
|
5959
|
-
getFilter(): Promise<Filter>;
|
|
5960
5970
|
/**
|
|
5961
5971
|
* Returns the list of conditional format rules on this sheet.
|
|
5962
5972
|
* The font size and name, gradient, and number format of rule.style are currently read-only.
|
|
@@ -5965,16 +5975,6 @@ declare namespace Cell {
|
|
|
5965
5975
|
* @returns formula1 and formula2 of a rule, and formula of a ConditionalFormatValue whose type is formula, start with `=`
|
|
5966
5976
|
*/
|
|
5967
5977
|
getConditionalFormatList(): Promise<ConditionalFormatInfo[]>;
|
|
5968
|
-
/**
|
|
5969
|
-
* Returns the list of data validation rules on this sheet.
|
|
5970
|
-
*
|
|
5971
|
-
* @returns formula1 and formula2 of a rule start with `=`, except that the comma-separated list of the list type is given without `=`
|
|
5972
|
-
*/
|
|
5973
|
-
getDataValidationList(): Promise<DataValidationInfo[]>;
|
|
5974
|
-
/**
|
|
5975
|
-
* Returns the list of cell comments on this sheet.
|
|
5976
|
-
*/
|
|
5977
|
-
getCommentList(): Promise<CommentInfo[]>;
|
|
5978
5978
|
/**
|
|
5979
5979
|
* Edits conditional format rules in a single call. Deleting rules, changing applied ranges, and moving priorities are processed as one batch, and if any of them cannot be applied, nothing is changed.
|
|
5980
5980
|
* To apply only one edit, use the method for that action.
|
|
@@ -6044,18 +6044,18 @@ declare namespace Cell {
|
|
|
6044
6044
|
* @returns formula starting with `=`. Array formula cells are in the form `{=...}`
|
|
6045
6045
|
*/
|
|
6046
6046
|
getFormula(): Promise<string | null>;
|
|
6047
|
-
/**
|
|
6048
|
-
* Returns the string displayed for the top-left cell of the range. It is the result after the number format is applied, so it can differ from the stored value.
|
|
6049
|
-
*
|
|
6050
|
-
* @returns empty string if the cell is empty
|
|
6051
|
-
*/
|
|
6052
|
-
getDisplayValue(): Promise<string>;
|
|
6053
6047
|
/**
|
|
6054
6048
|
* Returns the formulas of the whole range as a row-major two-dimensional array. The array has the same size as the range.
|
|
6055
6049
|
*
|
|
6056
6050
|
* @returns formulas starting with `=`, where array formula cells are in the form `{=...}`. Positions of cells that are not formulas are null
|
|
6057
6051
|
*/
|
|
6058
6052
|
getFormulas(): Promise<(string | null)[][]>;
|
|
6053
|
+
/**
|
|
6054
|
+
* Returns the string displayed for the top-left cell of the range. It is the result after the number format is applied, so it can differ from the stored value.
|
|
6055
|
+
*
|
|
6056
|
+
* @returns empty string if the cell is empty
|
|
6057
|
+
*/
|
|
6058
|
+
getDisplayValue(): Promise<string>;
|
|
6059
6059
|
/**
|
|
6060
6060
|
* Returns the displayed strings of the whole range as a row-major two-dimensional array. The array has the same size as the range.
|
|
6061
6061
|
*
|
|
@@ -6082,6 +6082,100 @@ declare namespace Cell {
|
|
|
6082
6082
|
* Returns the width (px) of the first column of the range.
|
|
6083
6083
|
*/
|
|
6084
6084
|
getColumnWidth(): Promise<number>;
|
|
6085
|
+
/**
|
|
6086
|
+
* Returns whether the first row of the range is visible.
|
|
6087
|
+
*/
|
|
6088
|
+
isRowVisible(): Promise<boolean>;
|
|
6089
|
+
/**
|
|
6090
|
+
* Returns whether the first column of the range is visible.
|
|
6091
|
+
*/
|
|
6092
|
+
isColumnVisible(): Promise<boolean>;
|
|
6093
|
+
/**
|
|
6094
|
+
* Returns whether the top-left cell of the range is bold.
|
|
6095
|
+
*/
|
|
6096
|
+
isFontBold(): Promise<boolean>;
|
|
6097
|
+
/**
|
|
6098
|
+
* Returns whether the top-left cell of the range is italic.
|
|
6099
|
+
*/
|
|
6100
|
+
isFontItalic(): Promise<boolean>;
|
|
6101
|
+
/**
|
|
6102
|
+
* Returns the underline type of the top-left cell of the range. Accounting underlines (singleAccounting and doubleAccounting) can only be read and cannot be set with setFontUnderline.
|
|
6103
|
+
*
|
|
6104
|
+
* @returns "none" if there is no underline
|
|
6105
|
+
*/
|
|
6106
|
+
getFontUnderline(): Promise<UnderlineType>;
|
|
6107
|
+
/**
|
|
6108
|
+
* Returns whether the top-left cell of the range has strikethrough.
|
|
6109
|
+
*/
|
|
6110
|
+
isFontStrikethrough(): Promise<boolean>;
|
|
6111
|
+
/**
|
|
6112
|
+
* Returns the font name of the top-left cell of the range. A cell with no font specified holds the default font name of the document.
|
|
6113
|
+
*/
|
|
6114
|
+
getFontName(): Promise<string>;
|
|
6115
|
+
/**
|
|
6116
|
+
* Returns the font size (pt) of the top-left cell of the range. A cell with no size specified holds the default size of the document.
|
|
6117
|
+
*/
|
|
6118
|
+
getFontSize(): Promise<number>;
|
|
6119
|
+
/**
|
|
6120
|
+
* Returns the font color of the top-left cell of the range. A cell with no color specified holds the default color of the document.
|
|
6121
|
+
*
|
|
6122
|
+
* @returns color in "#RRGGBB" format
|
|
6123
|
+
*/
|
|
6124
|
+
getFontColor(): Promise<string>;
|
|
6125
|
+
/**
|
|
6126
|
+
* Returns the font format of the top-left cell of the range in a single call.
|
|
6127
|
+
*/
|
|
6128
|
+
getFont(): Promise<FontInfo>;
|
|
6129
|
+
/**
|
|
6130
|
+
* Returns the horizontal alignment of the top-left cell of the range. Returns only an explicitly set value. If the document holds a value outside HorizontalAlign, it is returned as is without correction.
|
|
6131
|
+
*
|
|
6132
|
+
* @returns undefined if not set
|
|
6133
|
+
*/
|
|
6134
|
+
getHorizontalAlign(): Promise<string | undefined>;
|
|
6135
|
+
/**
|
|
6136
|
+
* Returns the vertical alignment of the top-left cell of the range. Returns only an explicitly set value. If the document holds a value outside VerticalAlign, it is returned as is without correction.
|
|
6137
|
+
*
|
|
6138
|
+
* @returns undefined if not set
|
|
6139
|
+
*/
|
|
6140
|
+
getVerticalAlign(): Promise<string | undefined>;
|
|
6141
|
+
/**
|
|
6142
|
+
* Returns whether text wrapping is applied to the top-left cell of the range.
|
|
6143
|
+
*/
|
|
6144
|
+
isWrapText(): Promise<boolean>;
|
|
6145
|
+
/**
|
|
6146
|
+
* Returns the alignment format of the top-left cell of the range in a single call.
|
|
6147
|
+
*/
|
|
6148
|
+
getAlignment(): Promise<AlignmentInfo>;
|
|
6149
|
+
/**
|
|
6150
|
+
* Returns the indent level of the top-left cell of the range.
|
|
6151
|
+
*
|
|
6152
|
+
* @returns 0 if no indent is set
|
|
6153
|
+
*/
|
|
6154
|
+
getIndent(): Promise<number>;
|
|
6155
|
+
/**
|
|
6156
|
+
* Returns the borders of the top-left cell of the range, split into the four edges and the diagonal. Only lines that are set are included.
|
|
6157
|
+
*
|
|
6158
|
+
* @returns undefined if the format of the cell has no border information
|
|
6159
|
+
*/
|
|
6160
|
+
getBorder(): Promise<BorderInfo | undefined>;
|
|
6161
|
+
/**
|
|
6162
|
+
* Returns the number format of the top-left cell of the range. A cell with no format specified also returns the code of the document default format.
|
|
6163
|
+
*
|
|
6164
|
+
* @returns number format code that can be passed as is to setNumberFormat
|
|
6165
|
+
*/
|
|
6166
|
+
getNumberFormat(): Promise<string>;
|
|
6167
|
+
/**
|
|
6168
|
+
* Returns the addresses of the merged areas that overlap the range as an array of A1 notation strings. A merge that overlaps only partly is not cut to fit the range, and the address of the entire merged area is returned. Use Worksheet.getMergeCellList to get the merge list of the whole sheet.
|
|
6169
|
+
*/
|
|
6170
|
+
getMergeCellList(): Promise<string[]>;
|
|
6171
|
+
/**
|
|
6172
|
+
* Returns the list of comments on the cells in the range.
|
|
6173
|
+
*/
|
|
6174
|
+
getCommentList(): Promise<CommentInfo[]>;
|
|
6175
|
+
/**
|
|
6176
|
+
* Returns the list of hyperlinks that overlap the range. Links that overlap only partly are included.
|
|
6177
|
+
*/
|
|
6178
|
+
getHyperlinkList(): Promise<HyperlinkInfo[]>;
|
|
6085
6179
|
/**
|
|
6086
6180
|
* Sets the height of the rows spanned by the range. Setting a height on a hidden row also unhides it.
|
|
6087
6181
|
* Passing 0 or less hides the rows without changing the height.
|
|
@@ -6140,14 +6234,6 @@ declare namespace Cell {
|
|
|
6140
6234
|
* @param visible - true to show, false to hide
|
|
6141
6235
|
*/
|
|
6142
6236
|
setColumnVisible(visible: boolean): Promise<void>;
|
|
6143
|
-
/**
|
|
6144
|
-
* Returns whether the first row of the range is visible.
|
|
6145
|
-
*/
|
|
6146
|
-
isRowVisible(): Promise<boolean>;
|
|
6147
|
-
/**
|
|
6148
|
-
* Returns whether the first column of the range is visible.
|
|
6149
|
-
*/
|
|
6150
|
-
isColumnVisible(): Promise<boolean>;
|
|
6151
6237
|
/**
|
|
6152
6238
|
* Enters the same value into every cell of the range. The value is converted to a string and then interpreted, so a value starting with "=" becomes a formula, and a value in the form "{=...}" becomes an array formula that binds the whole range as one unit.
|
|
6153
6239
|
* If the number format of the top-left cell of the range is text, a value starting with "=" also does not become a formula and is entered as a string in the whole range.
|
|
@@ -6196,24 +6282,6 @@ declare namespace Cell {
|
|
|
6196
6282
|
* @param isOn - true to apply, false to remove
|
|
6197
6283
|
*/
|
|
6198
6284
|
setFontStrikethrough(isOn: boolean): Promise<void>;
|
|
6199
|
-
/**
|
|
6200
|
-
* Returns whether the top-left cell of the range is bold.
|
|
6201
|
-
*/
|
|
6202
|
-
isFontBold(): Promise<boolean>;
|
|
6203
|
-
/**
|
|
6204
|
-
* Returns whether the top-left cell of the range is italic.
|
|
6205
|
-
*/
|
|
6206
|
-
isFontItalic(): Promise<boolean>;
|
|
6207
|
-
/**
|
|
6208
|
-
* Returns the underline type of the top-left cell of the range. Accounting underlines (singleAccounting and doubleAccounting) can only be read and cannot be set with setFontUnderline.
|
|
6209
|
-
*
|
|
6210
|
-
* @returns "none" if there is no underline
|
|
6211
|
-
*/
|
|
6212
|
-
getFontUnderline(): Promise<UnderlineType>;
|
|
6213
|
-
/**
|
|
6214
|
-
* Returns whether the top-left cell of the range has strikethrough.
|
|
6215
|
-
*/
|
|
6216
|
-
isFontStrikethrough(): Promise<boolean>;
|
|
6217
6285
|
/**
|
|
6218
6286
|
* Changes the font of the range.
|
|
6219
6287
|
*
|
|
@@ -6232,24 +6300,6 @@ declare namespace Cell {
|
|
|
6232
6300
|
* @param color - color in "#RRGGBB" format, or a CSS color name such as "red"
|
|
6233
6301
|
*/
|
|
6234
6302
|
setFontColor(color: string): Promise<void>;
|
|
6235
|
-
/**
|
|
6236
|
-
* Returns the font name of the top-left cell of the range. A cell with no font specified holds the default font name of the document.
|
|
6237
|
-
*/
|
|
6238
|
-
getFontName(): Promise<string>;
|
|
6239
|
-
/**
|
|
6240
|
-
* Returns the font size (pt) of the top-left cell of the range. A cell with no size specified holds the default size of the document.
|
|
6241
|
-
*/
|
|
6242
|
-
getFontSize(): Promise<number>;
|
|
6243
|
-
/**
|
|
6244
|
-
* Returns the font color of the top-left cell of the range. A cell with no color specified holds the default color of the document.
|
|
6245
|
-
*
|
|
6246
|
-
* @returns color in "#RRGGBB" format
|
|
6247
|
-
*/
|
|
6248
|
-
getFontColor(): Promise<string>;
|
|
6249
|
-
/**
|
|
6250
|
-
* Returns the font format of the top-left cell of the range in a single call.
|
|
6251
|
-
*/
|
|
6252
|
-
getFont(): Promise<FontInfo>;
|
|
6253
6303
|
/**
|
|
6254
6304
|
* Fills the range with a solid background color. If no color is given, the fill is cleared.
|
|
6255
6305
|
*
|
|
@@ -6280,32 +6330,12 @@ declare namespace Cell {
|
|
|
6280
6330
|
* @returns color in "#RRGGBB" format
|
|
6281
6331
|
*/
|
|
6282
6332
|
getBackgroundColor(): Promise<string | undefined>;
|
|
6283
|
-
/**
|
|
6284
|
-
* Returns the horizontal alignment of the top-left cell of the range. Returns only an explicitly set value. If the document holds a value outside HorizontalAlign, it is returned as is without correction.
|
|
6285
|
-
*
|
|
6286
|
-
* @returns undefined if not set
|
|
6287
|
-
*/
|
|
6288
|
-
getHorizontalAlign(): Promise<string | undefined>;
|
|
6289
|
-
/**
|
|
6290
|
-
* Returns the vertical alignment of the top-left cell of the range. Returns only an explicitly set value. If the document holds a value outside VerticalAlign, it is returned as is without correction.
|
|
6291
|
-
*
|
|
6292
|
-
* @returns undefined if not set
|
|
6293
|
-
*/
|
|
6294
|
-
getVerticalAlign(): Promise<string | undefined>;
|
|
6295
|
-
/**
|
|
6296
|
-
* Returns whether text wrapping is applied to the top-left cell of the range.
|
|
6297
|
-
*/
|
|
6298
|
-
isWrapText(): Promise<boolean>;
|
|
6299
6333
|
/**
|
|
6300
6334
|
* Returns the fill of the top-left cell of the range.
|
|
6301
6335
|
*
|
|
6302
6336
|
* @returns undefined if there is no fill
|
|
6303
6337
|
*/
|
|
6304
6338
|
getFill(): Promise<FillInfo | undefined>;
|
|
6305
|
-
/**
|
|
6306
|
-
* Returns the alignment format of the top-left cell of the range in a single call.
|
|
6307
|
-
*/
|
|
6308
|
-
getAlignment(): Promise<AlignmentInfo>;
|
|
6309
6339
|
/**
|
|
6310
6340
|
* Increases the indent level of the range by 1. If the horizontal alignment of the range is not uniformly left or right, the whole range is first changed to left alignment and then the indent level is increased.
|
|
6311
6341
|
*/
|
|
@@ -6314,12 +6344,6 @@ declare namespace Cell {
|
|
|
6314
6344
|
* Decreases the indent level of the range by 1. It does not go below 0.
|
|
6315
6345
|
*/
|
|
6316
6346
|
decreaseIndent(): Promise<void>;
|
|
6317
|
-
/**
|
|
6318
|
-
* Returns the indent level of the top-left cell of the range.
|
|
6319
|
-
*
|
|
6320
|
-
* @returns 0 if no indent is set
|
|
6321
|
-
*/
|
|
6322
|
-
getIndent(): Promise<number>;
|
|
6323
6347
|
/**
|
|
6324
6348
|
* Applies or clears borders on the range. If type is "none", all borders of the range are cleared, and for any other type, the border that type refers to is merged into the existing borders.
|
|
6325
6349
|
* If lineStyle is "none", only the line at the position that type refers to is cleared and color is ignored.
|
|
@@ -6330,12 +6354,6 @@ declare namespace Cell {
|
|
|
6330
6354
|
* @param color - line color in "#RRGGBB" format, or a CSS color name such as "red" (default: "#000000")
|
|
6331
6355
|
*/
|
|
6332
6356
|
setBorder(type: BorderType, lineStyle?: BorderLineStyle | null, color?: string | null): Promise<void>;
|
|
6333
|
-
/**
|
|
6334
|
-
* Returns the borders of the top-left cell of the range, split into the four edges and the diagonal. Only lines that are set are included.
|
|
6335
|
-
*
|
|
6336
|
-
* @returns undefined if the format of the cell has no border information
|
|
6337
|
-
*/
|
|
6338
|
-
getBorder(): Promise<BorderInfo | undefined>;
|
|
6339
6357
|
/**
|
|
6340
6358
|
* Clears the cell formats (font, fill, alignment, border, and number format) of the range and unmerges the merges in the range. Values and formulas are kept.
|
|
6341
6359
|
* It cannot be used on a range that covers only part of a merged area.
|
|
@@ -6356,22 +6374,12 @@ declare namespace Cell {
|
|
|
6356
6374
|
* Unmerges all merged areas that overlap the range.
|
|
6357
6375
|
*/
|
|
6358
6376
|
unmerge(): Promise<void>;
|
|
6359
|
-
/**
|
|
6360
|
-
* Returns the addresses of the merged areas that overlap the range as an array of A1 notation strings. A merge that overlaps only partly is not cut to fit the range, and the address of the entire merged area is returned. Use Worksheet.getMergeCellList to get the merge list of the whole sheet.
|
|
6361
|
-
*/
|
|
6362
|
-
getMergeCellList(): Promise<string[]>;
|
|
6363
6377
|
/**
|
|
6364
6378
|
* Sets the number format of the range by format code. The given code is saved as a custom format.
|
|
6365
6379
|
*
|
|
6366
6380
|
* @param formatCode - Excel-compatible format code (such as "#,##0.00", "yyyy-mm-dd", or "0.00%")
|
|
6367
6381
|
*/
|
|
6368
6382
|
setNumberFormat(formatCode: string): Promise<void>;
|
|
6369
|
-
/**
|
|
6370
|
-
* Returns the number format of the top-left cell of the range. A cell with no format specified also returns the code of the document default format.
|
|
6371
|
-
*
|
|
6372
|
-
* @returns number format code that can be passed as is to setNumberFormat
|
|
6373
|
-
*/
|
|
6374
|
-
getNumberFormat(): Promise<string>;
|
|
6375
6383
|
/**
|
|
6376
6384
|
* Returns the cell formats of the whole range as a row-major two-dimensional array. The outer array holds rows and the inner arrays hold columns. The array has the same size as the range.
|
|
6377
6385
|
*
|
|
@@ -6423,14 +6431,6 @@ declare namespace Cell {
|
|
|
6423
6431
|
* @param visible - true to always show, false to show only on mouse hover
|
|
6424
6432
|
*/
|
|
6425
6433
|
setCommentVisible(visible: boolean): Promise<void>;
|
|
6426
|
-
/**
|
|
6427
|
-
* Returns the list of comments on the cells in the range.
|
|
6428
|
-
*/
|
|
6429
|
-
getCommentList(): Promise<CommentInfo[]>;
|
|
6430
|
-
/**
|
|
6431
|
-
* Returns the list of hyperlinks that overlap the range. Links that overlap only partly are included.
|
|
6432
|
-
*/
|
|
6433
|
-
getHyperlinkList(): Promise<HyperlinkInfo[]>;
|
|
6434
6434
|
/**
|
|
6435
6435
|
* Adds a hyperlink to the range. The link and the link format (blue underline) are applied to the whole range, but the display text is entered only in the top-left cell.
|
|
6436
6436
|
*
|
|
@@ -6588,6 +6588,14 @@ declare namespace Cell {
|
|
|
6588
6588
|
* Returns the display options of the table in a single call.
|
|
6589
6589
|
*/
|
|
6590
6590
|
getOptions(): Promise<TableOptions>;
|
|
6591
|
+
/**
|
|
6592
|
+
* Returns a Filter that manages the AutoFilter of this table. A Filter is returned even if no AutoFilter exists, and whether one exists is given by enabled in getInfo() of the Filter.
|
|
6593
|
+
*/
|
|
6594
|
+
getFilter(): Promise<Filter>;
|
|
6595
|
+
/**
|
|
6596
|
+
* Returns the name, location, range, and display options of the table in a single call.
|
|
6597
|
+
*/
|
|
6598
|
+
getInfo(): Promise<TableInfo>;
|
|
6591
6599
|
/**
|
|
6592
6600
|
* Deletes the table. Removes the table definition and the AutoFilter of the table, and clears the cell content of the table range.
|
|
6593
6601
|
*/
|
|
@@ -6655,20 +6663,17 @@ declare namespace Cell {
|
|
|
6655
6663
|
* @param name - new table name. It cannot contain spaces or disallowed characters, and names that read as cell references and names longer than the maximum length are not accepted
|
|
6656
6664
|
*/
|
|
6657
6665
|
setName(name: string): Promise<void>;
|
|
6658
|
-
/**
|
|
6659
|
-
* Returns a Filter that manages the AutoFilter of this table. A Filter is returned even if no AutoFilter exists, and whether one exists is given by enabled in getInfo() of the Filter.
|
|
6660
|
-
*/
|
|
6661
|
-
getFilter(): Promise<Filter>;
|
|
6662
|
-
/**
|
|
6663
|
-
* Returns the name, location, range, and display options of the table in a single call.
|
|
6664
|
-
*/
|
|
6665
|
-
getInfo(): Promise<TableInfo>;
|
|
6666
6666
|
}
|
|
6667
6667
|
/**
|
|
6668
6668
|
* Represents an AutoFilter on a sheet or table.
|
|
6669
6669
|
* Reads and edits the filter range, the filter criteria of each column, and the sort state.
|
|
6670
6670
|
*/
|
|
6671
6671
|
interface Filter {
|
|
6672
|
+
/**
|
|
6673
|
+
* Returns the filter range, the criteria of each column, the number of rows hidden by the filter, and the sort state.
|
|
6674
|
+
* If no filter exists yet, only enabled is included, as false, and the other fields are omitted.
|
|
6675
|
+
*/
|
|
6676
|
+
getInfo(): Promise<FilterInfo>;
|
|
6672
6677
|
/**
|
|
6673
6678
|
* Creates an AutoFilter.
|
|
6674
6679
|
* A sheet filter is created on the range specified by range. If range is omitted, the data region surrounding the current selection is used.
|
|
@@ -6710,11 +6715,6 @@ declare namespace Cell {
|
|
|
6710
6715
|
* Does nothing if there is no filter.
|
|
6711
6716
|
*/
|
|
6712
6717
|
remove(): Promise<void>;
|
|
6713
|
-
/**
|
|
6714
|
-
* Returns the filter range, the criteria of each column, the number of rows hidden by the filter, and the sort state.
|
|
6715
|
-
* If no filter exists yet, only enabled is included, as false, and the other fields are omitted.
|
|
6716
|
-
*/
|
|
6717
|
-
getInfo(): Promise<FilterInfo>;
|
|
6718
6718
|
}
|
|
6719
6719
|
/**
|
|
6720
6720
|
* Represents a defined name in the workbook.
|
|
@@ -6745,6 +6745,12 @@ declare namespace Cell {
|
|
|
6745
6745
|
* @returns empty string if the name refers to a constant or an error, or uses an unsupported function
|
|
6746
6746
|
*/
|
|
6747
6747
|
getRanges(): Promise<string>;
|
|
6748
|
+
/**
|
|
6749
|
+
* Returns the name, the scope sheet, the formula, and the referenced ranges in a single call.
|
|
6750
|
+
*
|
|
6751
|
+
* @returns Formulas start with `=`
|
|
6752
|
+
*/
|
|
6753
|
+
getInfo(): Promise<NameInfo>;
|
|
6748
6754
|
/**
|
|
6749
6755
|
* Renames the defined name.
|
|
6750
6756
|
* A name cannot be changed to a name that already exists in the same scope or to a table name.
|
|
@@ -6770,12 +6776,6 @@ declare namespace Cell {
|
|
|
6770
6776
|
* Deletes the defined name.
|
|
6771
6777
|
*/
|
|
6772
6778
|
delete(): Promise<void>;
|
|
6773
|
-
/**
|
|
6774
|
-
* Returns the name, the scope sheet, the formula, and the referenced ranges in a single call.
|
|
6775
|
-
*
|
|
6776
|
-
* @returns Formulas start with `=`
|
|
6777
|
-
*/
|
|
6778
|
-
getInfo(): Promise<NameInfo>;
|
|
6779
6779
|
}
|
|
6780
6780
|
}
|
|
6781
6781
|
|
package/dist/index.js
CHANGED
package/dist/version.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@thinkfree.dev/tfo-sdk",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.1",
|
|
4
4
|
"description": "Thinkfree Editor SDK — control Word, Spreadsheet, and Presentation documents in an embedded Thinkfree Office editor from the host page, and expose the editor's document tools to your AI agent.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"thinkfree",
|