@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 CHANGED
@@ -2,11 +2,11 @@
2
2
 
3
3
  A JavaScript / TypeScript SDK for controlling a Thinkfree Office editor (Word, Spreadsheet, Presentation) that is embedded in your web page as an iframe. The SDK talks to the editor over exact-origin `postMessage`; your page never touches the editor's internals.
4
4
 
5
- - **Document API** — get an app handle with `Office.word` / `Office.cell` / `Office.show`, then work on the document object model through `getDocument()`.
6
- - **AI agent integration** — fetch the editor's tool catalog as executable tools (`getTools`) or register them into a tool-calling framework (`registerTools`).
5
+ - **Document API** — get an app handle with `Office.word` / `Office.cell` / `Office.show` (or let the SDK open the editor with `Office.word.load()`), then work on the document object model through `getDocument()`.
6
+ - **AI agent integration** — package the editor's tools, prompt rules and results for your LLM loop (`createOfficeToolkit`), or fetch them as executable tools (`getTools`) and register them into a tool-calling framework (`registerTools`).
7
7
  - **Fully typed** — one bundled `index.d.ts` covers the Word, Spreadsheet, and Presentation APIs.
8
8
 
9
- > **Private developer preview.** This is a 0.x release. The public surface may change between minor versions.
9
+ > **Developer preview.** This is a 0.x release. The public surface may change between minor versions.
10
10
 
11
11
  ## Try it first
12
12
 
@@ -44,7 +44,7 @@ If you copy the SDK files instead of installing the package, ship `apiReference.
44
44
  - **Runtime**: a browser (the SDK needs the DOM; Node.js-only environments are not supported).
45
45
  - **Module format**: ESM only. CommonJS `require()` is not supported; use dynamic `import()` if needed.
46
46
  - **TypeScript** (optional): 4.7 or later, with `"dom"` in `compilerOptions.lib`.
47
- - **Editor**: a Thinkfree Office deployment that you can open in an iframe. The SDK does not host or open documents by itself.
47
+ - **Editor**: a Thinkfree Office deployment that you can open in an iframe. The SDK does not host documents; your Office or storage integration issues the open URL.
48
48
 
49
49
  ## Getting started
50
50
 
@@ -69,6 +69,23 @@ Things to know:
69
69
  - Multiple iframes (multiple documents) on one page are safe. Responses are isolated per instance.
70
70
  - If MS Office.js is loaded on the same page, the global `Office` name collides. Import with an alias: `import { Office as TfoOffice } from '@thinkfree.dev/tfo-sdk'`.
71
71
 
72
+ ### Let the SDK open the editor — `load` / `open`
73
+
74
+ `Office.word.load()` (and `Office.cell.load()`, `Office.show.load()`) creates or reuses the iframe, opens the URL **hidden**, and resolves with the app handle when the document has loaded, so the user never sees the editor boot. `open()` takes the same options and shows the editor from the start.
75
+
76
+ ```ts
77
+ import { Office } from '@thinkfree.dev/tfo-sdk';
78
+
79
+ const word = await Office.word.load({ container: '#editor', url: OPEN_URL }); // hidden until ready
80
+ const body = await word.getDocument().getBody(); // works while hidden
81
+ word.show();
82
+ ```
83
+
84
+ - Pass exactly one of `container` (selector or element; the SDK creates the iframe, sized with `frame`) and `iframe` (an existing element).
85
+ - When `url` has an `app=` parameter it must match the entry point (`Office.word` for Word), otherwise `INVALID_ARGUMENT`.
86
+ - `readyLimitMs` (default 60 s) rejects with `TIMEOUT`; `signal` cancels with `AbortError`. On failure an iframe the SDK created is removed and one you passed in is only made visible again.
87
+ - The app handle adds `show()`, `hide()`, `visible`, `iframe`, and `close()`. `hide()` keeps the size and blocks focus; `close()` disconnects and removes the iframe only if the SDK created it.
88
+
72
89
  ### `createOffice` — low-level factory
73
90
 
74
91
  Use the factory directly when you need `targetWindow` transport or explicit options.
@@ -197,7 +214,7 @@ if (!result.success && result.failure.code === 'stale') {
197
214
  - **Custom actions** — add partner tools with `customActions` (`partner_*` names — letters, digits, `_`, `-` only, so they satisfy the OpenAI/Anthropic tool-name rule; `run(ctx, args)` or a list of catalog `steps`).
198
215
  - `withExecute(toolkit)` returns tools with an `execute` for runtimes that call tools themselves. `dispatchAll` runs a batch in order and stops at the first failure.
199
216
 
200
- Keep the tool set small and task-specific with `include`. See the guide on [document tools and errors](https://www.developers.thinkfree.com/docs/editor-sdk/tools-and-errors/) for framework-specific schema mappings, and the [Editor AI SDK](https://www.developers.thinkfree.com/docs/editor-ai-sdk/) docs for a complete tool-calling loop.
217
+ Keep the tool set small and task-specific with `include`. See the guide on [document tools and errors](https://www.developers.thinkfree.com/docs/editor-sdk/document-tools-and-error-handling/) for framework-specific schema mappings, and the [Editor AI SDK](https://www.developers.thinkfree.com/docs/editor-ai-sdk/) docs for a complete tool-calling loop.
201
218
 
202
219
  ## Error handling
203
220
 
@@ -247,5 +264,5 @@ This package is at 0.x; the public surface may change in minor releases. At runt
247
264
  - Word API: <https://www.developers.thinkfree.com/docs/editor-sdk/word-api/>
248
265
  - Spreadsheet API: <https://www.developers.thinkfree.com/docs/editor-sdk/spreadsheet-api/>
249
266
  - Presentation API: <https://www.developers.thinkfree.com/docs/editor-sdk/presentation-api/>
250
- - Document tools and errors: <https://www.developers.thinkfree.com/docs/editor-sdk/tools-and-errors/>
267
+ - Document tools and errors: <https://www.developers.thinkfree.com/docs/editor-sdk/document-tools-and-error-handling/>
251
268
  - Editor AI SDK (LLM tool-calling on top of this package): <https://www.developers.thinkfree.com/docs/editor-ai-sdk/> · npm: <https://www.npmjs.com/package/@thinkfree.dev/tfo-ai-sdk>
@@ -6390,17 +6390,6 @@ var cell = {
6390
6390
  ],
6391
6391
  summary: "Returns the Worksheet. Sheet names are case-sensitive when the sheet is specified by name.\nIf sheet is omitted, the active sheet is used."
6392
6392
  },
6393
- {
6394
- name: "getObjectById",
6395
- signature: "(oid: string) \u2192 Chart | null",
6396
- params: [
6397
- {
6398
- name: "oid",
6399
- type: "string"
6400
- }
6401
- ],
6402
- summary: "Returns an object by ID. It searches all sheets of the document, and currently only Chart is supported.\nReturns null for an object that is not a chart."
6403
- },
6404
6393
  {
6405
6394
  name: "getTable",
6406
6395
  signature: "(name: string) \u2192 Table | null",
@@ -6428,6 +6417,29 @@ var cell = {
6428
6417
  ],
6429
6418
  summary: "Returns the defined name with the given name. The name is case-insensitive.\nIf sheet is omitted, only workbook-scoped names are searched."
6430
6419
  },
6420
+ {
6421
+ name: "getDefinedNameList",
6422
+ signature: "(sheet?: number | string) \u2192 NameInfo[]",
6423
+ params: [
6424
+ {
6425
+ name: "sheet",
6426
+ type: "number|string",
6427
+ optional: true
6428
+ }
6429
+ ],
6430
+ summary: "Returns the list of defined names. Built-in names and names without a formula are excluded.\nIf sheet is omitted, the workbook-scoped names are returned. Returns: Formulas start with `=`"
6431
+ },
6432
+ {
6433
+ name: "getObjectById",
6434
+ signature: "(oid: string) \u2192 Chart | null",
6435
+ params: [
6436
+ {
6437
+ name: "oid",
6438
+ type: "string"
6439
+ }
6440
+ ],
6441
+ summary: "Returns an object by ID. It searches all sheets of the document, and currently only Chart is supported.\nReturns null for an object that is not a chart."
6442
+ },
6431
6443
  {
6432
6444
  name: "addDefinedName",
6433
6445
  signature: "(name: string, formula: string, sheet?: number | string) \u2192 Name",
@@ -6448,18 +6460,6 @@ var cell = {
6448
6460
  ],
6449
6461
  summary: "Creates a defined name.\nReferences in the formula that do not specify a sheet are resolved against the active sheet.\nIf sheet is omitted, the name is created as a workbook-scoped name.\nThrows an error if a defined name or table with the same name already exists."
6450
6462
  },
6451
- {
6452
- name: "getDefinedNameList",
6453
- signature: "(sheet?: number | string) \u2192 NameInfo[]",
6454
- params: [
6455
- {
6456
- name: "sheet",
6457
- type: "number|string",
6458
- optional: true
6459
- }
6460
- ],
6461
- summary: "Returns the list of defined names. Built-in names and names without a formula are excluded.\nIf sheet is omitted, the workbook-scoped names are returned. Returns: Formulas start with `=`"
6462
- },
6463
6463
  {
6464
6464
  name: "addSheet",
6465
6465
  signature: "(name: string) \u2192 SheetRef",
@@ -6586,6 +6586,37 @@ var cell = {
6586
6586
  signature: "() \u2192 SheetInfo",
6587
6587
  summary: "Returns the sheet properties in a single call."
6588
6588
  },
6589
+ {
6590
+ name: "getRange",
6591
+ signature: "(range: string | RangeCoords) \u2192 Range",
6592
+ params: [
6593
+ {
6594
+ name: "range",
6595
+ type: "string|RangeCoords"
6596
+ }
6597
+ ],
6598
+ summary: "Returns a Range for a range on this sheet."
6599
+ },
6600
+ {
6601
+ name: "getTableList",
6602
+ signature: "() \u2192 TableInfo[]",
6603
+ summary: "Returns the list of table summaries on this sheet. To get a Table, call Workbook.getTable() with the name in the summary."
6604
+ },
6605
+ {
6606
+ name: "getFilter",
6607
+ signature: "() \u2192 Filter",
6608
+ summary: "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."
6609
+ },
6610
+ {
6611
+ name: "getDataValidationList",
6612
+ signature: "() \u2192 DataValidationInfo[]",
6613
+ summary: "Returns the list of data validation rules on this sheet. Returns: formula1 and formula2 of a rule start with `=`, except that the comma-separated list of the list type is given without `=`"
6614
+ },
6615
+ {
6616
+ name: "getCommentList",
6617
+ signature: "() \u2192 CommentInfo[]",
6618
+ summary: "Returns the list of cell comments on this sheet."
6619
+ },
6589
6620
  {
6590
6621
  name: "setName",
6591
6622
  signature: "(name: string) \u2192 void",
@@ -6683,17 +6714,6 @@ var cell = {
6683
6714
  ],
6684
6715
  summary: "Sets the zoom factor. A value outside the allowed range throws an error."
6685
6716
  },
6686
- {
6687
- name: "getRange",
6688
- signature: "(range: string | RangeCoords) \u2192 Range",
6689
- params: [
6690
- {
6691
- name: "range",
6692
- type: "string|RangeCoords"
6693
- }
6694
- ],
6695
- summary: "Returns a Range for a range on this sheet."
6696
- },
6697
6717
  {
6698
6718
  name: "addChart",
6699
6719
  signature: "(chartType: ChartType, dataRange: string | RangeCoords, seriesBy?: ChartSeriesBy) \u2192 Chart",
@@ -6747,31 +6767,11 @@ var cell = {
6747
6767
  ],
6748
6768
  summary: "Creates a table on this sheet and returns the Table. The table name is assigned automatically.\nIf headers are not used or the range is a single row, an empty header row is added at the top, so the content below is pushed down by one row and the table is one row larger than the range.\nA table cannot be created while the document is being co-edited, or if the range is entire rows or entire columns or includes the last row of the sheet."
6749
6769
  },
6750
- {
6751
- name: "getTableList",
6752
- signature: "() \u2192 TableInfo[]",
6753
- summary: "Returns the list of table summaries on this sheet. To get a Table, call Workbook.getTable() with the name in the summary."
6754
- },
6755
- {
6756
- name: "getFilter",
6757
- signature: "() \u2192 Filter",
6758
- summary: "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."
6759
- },
6760
6770
  {
6761
6771
  name: "getConditionalFormatList",
6762
6772
  signature: "() \u2192 ConditionalFormatInfo[]",
6763
6773
  summary: "Returns the list of conditional format rules on this sheet.\nThe font size and name, gradient, and number format of rule.style are currently read-only.\nA dataBar loaded from a file with a look that is not in the presets appears as colors, gradient, and cfvo, and these three are currently read-only. Returns: formula1 and formula2 of a rule, and formula of a ConditionalFormatValue whose type is formula, start with `=`"
6764
6774
  },
6765
- {
6766
- name: "getDataValidationList",
6767
- signature: "() \u2192 DataValidationInfo[]",
6768
- summary: "Returns the list of data validation rules on this sheet. Returns: formula1 and formula2 of a rule start with `=`, except that the comma-separated list of the list type is given without `=`"
6769
- },
6770
- {
6771
- name: "getCommentList",
6772
- signature: "() \u2192 CommentInfo[]",
6773
- summary: "Returns the list of cell comments on this sheet."
6774
- },
6775
6775
  {
6776
6776
  name: "updateConditionalFormatRules",
6777
6777
  signature: "(descriptor: ConditionalFormatUpdate) \u2192 void",
@@ -6869,16 +6869,16 @@ var cell = {
6869
6869
  signature: "() \u2192 string | null",
6870
6870
  summary: "Returns the formula string of the top-left cell of the range. Returns null for a cell that is not a formula (a constant or an empty cell). Returns: formula starting with `=`. Array formula cells are in the form `{=...}`"
6871
6871
  },
6872
- {
6873
- name: "getDisplayValue",
6874
- signature: "() \u2192 string",
6875
- summary: "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. Returns: empty string if the cell is empty"
6876
- },
6877
6872
  {
6878
6873
  name: "getFormulas",
6879
6874
  signature: "() \u2192 Array<Array<string | null>>",
6880
6875
  summary: "Returns the formulas of the whole range as a row-major two-dimensional array. The array has the same size as the range. Returns: formulas starting with `=`, where array formula cells are in the form `{=...}`. Positions of cells that are not formulas are null"
6881
6876
  },
6877
+ {
6878
+ name: "getDisplayValue",
6879
+ signature: "() \u2192 string",
6880
+ summary: "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. Returns: empty string if the cell is empty"
6881
+ },
6882
6882
  {
6883
6883
  name: "getDisplayValues",
6884
6884
  signature: "() \u2192 Array<Array<string>>",
@@ -6904,6 +6904,106 @@ var cell = {
6904
6904
  signature: "() \u2192 number",
6905
6905
  summary: "Returns the width (px) of the first column of the range."
6906
6906
  },
6907
+ {
6908
+ name: "isRowVisible",
6909
+ signature: "() \u2192 boolean",
6910
+ summary: "Returns whether the first row of the range is visible."
6911
+ },
6912
+ {
6913
+ name: "isColumnVisible",
6914
+ signature: "() \u2192 boolean",
6915
+ summary: "Returns whether the first column of the range is visible."
6916
+ },
6917
+ {
6918
+ name: "isFontBold",
6919
+ signature: "() \u2192 boolean",
6920
+ summary: "Returns whether the top-left cell of the range is bold."
6921
+ },
6922
+ {
6923
+ name: "isFontItalic",
6924
+ signature: "() \u2192 boolean",
6925
+ summary: "Returns whether the top-left cell of the range is italic."
6926
+ },
6927
+ {
6928
+ name: "getFontUnderline",
6929
+ signature: "() \u2192 UnderlineType",
6930
+ summary: '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. Returns: "none" if there is no underline'
6931
+ },
6932
+ {
6933
+ name: "isFontStrikethrough",
6934
+ signature: "() \u2192 boolean",
6935
+ summary: "Returns whether the top-left cell of the range has strikethrough."
6936
+ },
6937
+ {
6938
+ name: "getFontName",
6939
+ signature: "() \u2192 string",
6940
+ summary: "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."
6941
+ },
6942
+ {
6943
+ name: "getFontSize",
6944
+ signature: "() \u2192 number",
6945
+ summary: "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."
6946
+ },
6947
+ {
6948
+ name: "getFontColor",
6949
+ signature: "() \u2192 string",
6950
+ summary: '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. Returns: color in "#RRGGBB" format'
6951
+ },
6952
+ {
6953
+ name: "getFont",
6954
+ signature: "() \u2192 FontInfo",
6955
+ summary: "Returns the font format of the top-left cell of the range in a single call."
6956
+ },
6957
+ {
6958
+ name: "getHorizontalAlign",
6959
+ signature: "() \u2192 string | undefined",
6960
+ summary: "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. Returns: undefined if not set"
6961
+ },
6962
+ {
6963
+ name: "getVerticalAlign",
6964
+ signature: "() \u2192 string | undefined",
6965
+ summary: "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. Returns: undefined if not set"
6966
+ },
6967
+ {
6968
+ name: "isWrapText",
6969
+ signature: "() \u2192 boolean",
6970
+ summary: "Returns whether text wrapping is applied to the top-left cell of the range."
6971
+ },
6972
+ {
6973
+ name: "getAlignment",
6974
+ signature: "() \u2192 AlignmentInfo",
6975
+ summary: "Returns the alignment format of the top-left cell of the range in a single call."
6976
+ },
6977
+ {
6978
+ name: "getIndent",
6979
+ signature: "() \u2192 number",
6980
+ summary: "Returns the indent level of the top-left cell of the range. Returns: 0 if no indent is set"
6981
+ },
6982
+ {
6983
+ name: "getBorder",
6984
+ signature: "() \u2192 BorderInfo | undefined",
6985
+ summary: "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. Returns: undefined if the format of the cell has no border information"
6986
+ },
6987
+ {
6988
+ name: "getNumberFormat",
6989
+ signature: "() \u2192 string",
6990
+ summary: "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. Returns: number format code that can be passed as is to setNumberFormat"
6991
+ },
6992
+ {
6993
+ name: "getMergeCellList",
6994
+ signature: "() \u2192 string[]",
6995
+ summary: "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."
6996
+ },
6997
+ {
6998
+ name: "getCommentList",
6999
+ signature: "() \u2192 CommentInfo[]",
7000
+ summary: "Returns the list of comments on the cells in the range."
7001
+ },
7002
+ {
7003
+ name: "getHyperlinkList",
7004
+ signature: "() \u2192 HyperlinkInfo[]",
7005
+ summary: "Returns the list of hyperlinks that overlap the range. Links that overlap only partly are included."
7006
+ },
6907
7007
  {
6908
7008
  name: "setRowHeight",
6909
7009
  signature: "(height: number) \u2192 void",
@@ -6992,16 +7092,6 @@ var cell = {
6992
7092
  ],
6993
7093
  summary: "Shows or hides the columns spanned by the range."
6994
7094
  },
6995
- {
6996
- name: "isRowVisible",
6997
- signature: "() \u2192 boolean",
6998
- summary: "Returns whether the first row of the range is visible."
6999
- },
7000
- {
7001
- name: "isColumnVisible",
7002
- signature: "() \u2192 boolean",
7003
- summary: "Returns whether the first column of the range is visible."
7004
- },
7005
7095
  {
7006
7096
  name: "setValue",
7007
7097
  signature: "(value: string | number | boolean | null | Date | object | Array<*>) \u2192 void",
@@ -7073,26 +7163,6 @@ var cell = {
7073
7163
  ],
7074
7164
  summary: "Applies or removes strikethrough for the range."
7075
7165
  },
7076
- {
7077
- name: "isFontBold",
7078
- signature: "() \u2192 boolean",
7079
- summary: "Returns whether the top-left cell of the range is bold."
7080
- },
7081
- {
7082
- name: "isFontItalic",
7083
- signature: "() \u2192 boolean",
7084
- summary: "Returns whether the top-left cell of the range is italic."
7085
- },
7086
- {
7087
- name: "getFontUnderline",
7088
- signature: "() \u2192 UnderlineType",
7089
- summary: '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. Returns: "none" if there is no underline'
7090
- },
7091
- {
7092
- name: "isFontStrikethrough",
7093
- signature: "() \u2192 boolean",
7094
- summary: "Returns whether the top-left cell of the range has strikethrough."
7095
- },
7096
7166
  {
7097
7167
  name: "setFontName",
7098
7168
  signature: "(name: string) \u2192 void",
@@ -7126,26 +7196,6 @@ var cell = {
7126
7196
  ],
7127
7197
  summary: "Changes the font color of the range."
7128
7198
  },
7129
- {
7130
- name: "getFontName",
7131
- signature: "() \u2192 string",
7132
- summary: "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."
7133
- },
7134
- {
7135
- name: "getFontSize",
7136
- signature: "() \u2192 number",
7137
- summary: "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."
7138
- },
7139
- {
7140
- name: "getFontColor",
7141
- signature: "() \u2192 string",
7142
- summary: '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. Returns: color in "#RRGGBB" format'
7143
- },
7144
- {
7145
- name: "getFont",
7146
- signature: "() \u2192 FontInfo",
7147
- summary: "Returns the font format of the top-left cell of the range in a single call."
7148
- },
7149
7199
  {
7150
7200
  name: "setBackgroundColor",
7151
7201
  signature: "(color?: string | null) \u2192 void",
@@ -7196,31 +7246,11 @@ var cell = {
7196
7246
  signature: "() \u2192 string | undefined",
7197
7247
  summary: 'Returns the background color of the top-left cell of the range. It is undefined when there is no fill, and also for a gradient fill because it cannot be expressed as a single color. Use getFill if the fill type is also needed. Returns: color in "#RRGGBB" format'
7198
7248
  },
7199
- {
7200
- name: "getHorizontalAlign",
7201
- signature: "() \u2192 string | undefined",
7202
- summary: "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. Returns: undefined if not set"
7203
- },
7204
- {
7205
- name: "getVerticalAlign",
7206
- signature: "() \u2192 string | undefined",
7207
- summary: "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. Returns: undefined if not set"
7208
- },
7209
- {
7210
- name: "isWrapText",
7211
- signature: "() \u2192 boolean",
7212
- summary: "Returns whether text wrapping is applied to the top-left cell of the range."
7213
- },
7214
7249
  {
7215
7250
  name: "getFill",
7216
7251
  signature: "() \u2192 FillInfo | undefined",
7217
7252
  summary: "Returns the fill of the top-left cell of the range. Returns: undefined if there is no fill"
7218
7253
  },
7219
- {
7220
- name: "getAlignment",
7221
- signature: "() \u2192 AlignmentInfo",
7222
- summary: "Returns the alignment format of the top-left cell of the range in a single call."
7223
- },
7224
7254
  {
7225
7255
  name: "increaseIndent",
7226
7256
  signature: "() \u2192 void",
@@ -7231,11 +7261,6 @@ var cell = {
7231
7261
  signature: "() \u2192 void",
7232
7262
  summary: "Decreases the indent level of the range by 1. It does not go below 0."
7233
7263
  },
7234
- {
7235
- name: "getIndent",
7236
- signature: "() \u2192 number",
7237
- summary: "Returns the indent level of the top-left cell of the range. Returns: 0 if no indent is set"
7238
- },
7239
7264
  {
7240
7265
  name: "setBorder",
7241
7266
  signature: '(type: BorderType, lineStyle: BorderLineStyle | null = "thin", color: string | null = "#000000") \u2192 void',
@@ -7259,11 +7284,6 @@ var cell = {
7259
7284
  ],
7260
7285
  summary: '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.\nIf lineStyle is "none", only the line at the position that type refers to is cleared and color is ignored.\nIf there is no inner line to draw, "center", "middle", and "cross" do nothing.'
7261
7286
  },
7262
- {
7263
- name: "getBorder",
7264
- signature: "() \u2192 BorderInfo | undefined",
7265
- summary: "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. Returns: undefined if the format of the cell has no border information"
7266
- },
7267
7287
  {
7268
7288
  name: "clearFormat",
7269
7289
  signature: "() \u2192 void",
@@ -7284,11 +7304,6 @@ var cell = {
7284
7304
  signature: "() \u2192 void",
7285
7305
  summary: "Unmerges all merged areas that overlap the range."
7286
7306
  },
7287
- {
7288
- name: "getMergeCellList",
7289
- signature: "() \u2192 string[]",
7290
- summary: "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."
7291
- },
7292
7307
  {
7293
7308
  name: "setNumberFormat",
7294
7309
  signature: "(formatCode: string) \u2192 void",
@@ -7300,11 +7315,6 @@ var cell = {
7300
7315
  ],
7301
7316
  summary: "Sets the number format of the range by format code. The given code is saved as a custom format."
7302
7317
  },
7303
- {
7304
- name: "getNumberFormat",
7305
- signature: "() \u2192 string",
7306
- summary: "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. Returns: number format code that can be passed as is to setNumberFormat"
7307
- },
7308
7318
  {
7309
7319
  name: "getCellFormats",
7310
7320
  signature: "(properties?: CellFormatProperty[]) \u2192 Array<Array<CellFormat>>",
@@ -7391,16 +7401,6 @@ var cell = {
7391
7401
  ],
7392
7402
  summary: "Changes the visibility of the comment on the top-left cell of the range."
7393
7403
  },
7394
- {
7395
- name: "getCommentList",
7396
- signature: "() \u2192 CommentInfo[]",
7397
- summary: "Returns the list of comments on the cells in the range."
7398
- },
7399
- {
7400
- name: "getHyperlinkList",
7401
- signature: "() \u2192 HyperlinkInfo[]",
7402
- summary: "Returns the list of hyperlinks that overlap the range. Links that overlap only partly are included."
7403
- },
7404
7404
  {
7405
7405
  name: "setHyperlink",
7406
7406
  signature: "(location: string, display?: string | null, type?: HyperlinkType | null) \u2192 void",
@@ -7640,6 +7640,16 @@ var cell = {
7640
7640
  signature: "() \u2192 TableOptions",
7641
7641
  summary: "Returns the display options of the table in a single call."
7642
7642
  },
7643
+ {
7644
+ name: "getFilter",
7645
+ signature: "() \u2192 Filter",
7646
+ summary: "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."
7647
+ },
7648
+ {
7649
+ name: "getInfo",
7650
+ signature: "() \u2192 TableInfo",
7651
+ summary: "Returns the name, location, range, and display options of the table in a single call."
7652
+ },
7643
7653
  {
7644
7654
  name: "delete",
7645
7655
  signature: "() \u2192 void",
@@ -7743,16 +7753,6 @@ var cell = {
7743
7753
  }
7744
7754
  ],
7745
7755
  summary: "Renames the table.\nThe table cannot be renamed if a table or defined name with the same name already exists, and the comparison is case-insensitive."
7746
- },
7747
- {
7748
- name: "getFilter",
7749
- signature: "() \u2192 Filter",
7750
- summary: "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."
7751
- },
7752
- {
7753
- name: "getInfo",
7754
- signature: "() \u2192 TableInfo",
7755
- summary: "Returns the name, location, range, and display options of the table in a single call."
7756
7756
  }
7757
7757
  ]
7758
7758
  },
@@ -7761,6 +7761,11 @@ var cell = {
7761
7761
  extends: null,
7762
7762
  role: "Represents an AutoFilter on a sheet or table. Reads and edits the filter range, the filter criteria of each column, and the sort state.",
7763
7763
  methods: [
7764
+ {
7765
+ name: "getInfo",
7766
+ signature: "() \u2192 FilterInfo",
7767
+ summary: "Returns the filter range, the criteria of each column, the number of rows hidden by the filter, and the sort state.\nIf no filter exists yet, only enabled is included, as false, and the other fields are omitted."
7768
+ },
7764
7769
  {
7765
7770
  name: "create",
7766
7771
  signature: "(range?: string | RangeCoords) \u2192 void",
@@ -7819,11 +7824,6 @@ var cell = {
7819
7824
  name: "remove",
7820
7825
  signature: "() \u2192 void",
7821
7826
  summary: "Removes the AutoFilter. The filter range and the column criteria are removed together.\nDoes nothing if there is no filter."
7822
- },
7823
- {
7824
- name: "getInfo",
7825
- signature: "() \u2192 FilterInfo",
7826
- summary: "Returns the filter range, the criteria of each column, the number of rows hidden by the filter, and the sort state.\nIf no filter exists yet, only enabled is included, as false, and the other fields are omitted."
7827
7827
  }
7828
7828
  ]
7829
7829
  },
@@ -7852,6 +7852,11 @@ var cell = {
7852
7852
  signature: "() \u2192 string",
7853
7853
  summary: "Returns the ranges that this name actually refers to. Multiple ranges are joined with commas, and each range always includes the sheet name. Returns: empty string if the name refers to a constant or an error, or uses an unsupported function"
7854
7854
  },
7855
+ {
7856
+ name: "getInfo",
7857
+ signature: "() \u2192 NameInfo",
7858
+ summary: "Returns the name, the scope sheet, the formula, and the referenced ranges in a single call. Returns: Formulas start with `=`"
7859
+ },
7855
7860
  {
7856
7861
  name: "setName",
7857
7862
  signature: "(name: string) \u2192 void",
@@ -7889,11 +7894,6 @@ var cell = {
7889
7894
  name: "delete",
7890
7895
  signature: "() \u2192 void",
7891
7896
  summary: "Deletes the defined name."
7892
- },
7893
- {
7894
- name: "getInfo",
7895
- signature: "() \u2192 NameInfo",
7896
- summary: "Returns the name, the scope sheet, the formula, and the referenced ranges in a single call. Returns: Formulas start with `=`"
7897
7897
  }
7898
7898
  ]
7899
7899
  }