-
Notifications
You must be signed in to change notification settings - Fork 64
/
excel.interfaces.tabledata.yml
117 lines (115 loc) · 4.44 KB
/
excel.interfaces.tabledata.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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
### YamlMime:TSType
name: Excel.Interfaces.TableData
uid: 'excel!Excel.Interfaces.TableData:interface'
package: excel!
fullName: Excel.Interfaces.TableData
summary: An interface describing the data returned by calling `table.toJSON()`<!-- -->.
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- name: columns
uid: 'excel!Excel.Interfaces.TableData#columns:member'
package: excel!
fullName: columns
summary: Represents a collection of all the columns in the table.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'columns?: Excel.Interfaces.TableColumnData[];'
return:
type: '<xref uid="excel!Excel.Interfaces.TableColumnData:interface" />[]'
- name: id
uid: 'excel!Excel.Interfaces.TableData#id:member'
package: excel!
fullName: id
summary: >-
Returns a value that uniquely identifies the table in a given workbook. The value of the identifier remains the
same even when the table is renamed.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'id?: string;'
return:
type: string
- name: name
uid: 'excel!Excel.Interfaces.TableData#name:member'
package: excel!
fullName: name
summary: >-
Name of the table.
The set name of the table must follow the guidelines specified in the [Rename an Excel
table](https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114) article.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'name?: string;'
return:
type: string
- name: rows
uid: 'excel!Excel.Interfaces.TableData#rows:member'
package: excel!
fullName: rows
summary: Represents a collection of all the rows in the table.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'rows?: Excel.Interfaces.TableRowData[];'
return:
type: '<xref uid="excel!Excel.Interfaces.TableRowData:interface" />[]'
- name: showHeaders
uid: 'excel!Excel.Interfaces.TableData#showHeaders:member'
package: excel!
fullName: showHeaders
summary: Specifies if the header row is visible. This value can be set to show or remove the header row.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'showHeaders?: boolean;'
return:
type: boolean
- name: showTotals
uid: 'excel!Excel.Interfaces.TableData#showTotals:member'
package: excel!
fullName: showTotals
summary: Specifies if the total row is visible. This value can be set to show or remove the total row.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'showTotals?: boolean;'
return:
type: boolean
- name: sort
uid: 'excel!Excel.Interfaces.TableData#sort:member'
package: excel!
fullName: sort
summary: Represents the sorting for the table.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'sort?: Excel.Interfaces.TableSortData;'
return:
type: '<xref uid="excel!Excel.Interfaces.TableSortData:interface" />'
- name: style
uid: 'excel!Excel.Interfaces.TableData#style:member'
package: excel!
fullName: style
summary: >-
Constant value that represents the table style. Possible values are: "TableStyleLight1" through
"TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through
"TableStyleDark11". A custom user-defined style present in the workbook can also be specified.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'style?: string;'
return:
type: string