/
excel.interfaces.tablerowcollectionloadoptions.yml
60 lines (58 loc) · 2.48 KB
/
excel.interfaces.tablerowcollectionloadoptions.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
### YamlMime:TSType
name: Excel.Interfaces.TableRowCollectionLoadOptions
uid: 'excel!Excel.Interfaces.TableRowCollectionLoadOptions:interface'
package: excel!
fullName: Excel.Interfaces.TableRowCollectionLoadOptions
summary: >-
Represents a collection of all the rows that are part of the table.
Note that unlike ranges or columns, which will adjust if new rows or columns are added before them, a `TableRow`
object represents the physical location of the table row, but not the data. That is, if the data is sorted or if new
rows are added, a table row will continue to point at the index for which it was created.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
- name: $all
uid: 'excel!Excel.Interfaces.TableRowCollectionLoadOptions#$all:member'
package: excel!
fullName: $all
summary: >-
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`<!-- -->) but not the
navigational properties (e.g.: `Range.format.fill.color`<!-- -->).
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: '$all?: boolean;'
return:
type: boolean
- name: index
uid: 'excel!Excel.Interfaces.TableRowCollectionLoadOptions#index:member'
package: excel!
fullName: index
summary: >-
For EACH ITEM in the collection: Returns the index number of the row within the rows collection of the table.
Zero-indexed.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'index?: boolean;'
return:
type: boolean
- name: values
uid: 'excel!Excel.Interfaces.TableRowCollectionLoadOptions#values:member'
package: excel!
fullName: values
summary: >-
For EACH ITEM in the collection: Represents the raw values of the specified range. The data returned could be a
string, number, or boolean. Cells that contain an error will return the error string. If the returned value starts
with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a formula.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'values?: boolean;'
return:
type: boolean