-
Notifications
You must be signed in to change notification settings - Fork 62
/
excel.interfaces.worksheetdata.yml
99 lines (99 loc) · 3.83 KB
/
excel.interfaces.worksheetdata.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
### YamlMime:TSType
name: Excel.Interfaces.WorksheetData
uid: 'excel!Excel.Interfaces.WorksheetData:interface'
package: excel!
fullName: Excel.Interfaces.WorksheetData
summary: An interface describing the data returned by calling `worksheet.toJSON()`<!-- -->.
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- name: charts
uid: 'excel!Excel.Interfaces.WorksheetData#charts:member'
package: excel!
fullName: charts
summary: Returns a collection of charts that are part of the worksheet.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'charts?: Excel.Interfaces.ChartData[];'
return:
type: '<xref uid="excel!Excel.Interfaces.ChartData:interface" />[]'
- name: id
uid: 'excel!Excel.Interfaces.WorksheetData#id:member'
package: excel!
fullName: id
summary: >-
Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains
the same even when the worksheet is renamed or moved.
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.WorksheetData#name:member'
package: excel!
fullName: name
summary: The display name of the worksheet. The name must be fewer than 32 characters.
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: position
uid: 'excel!Excel.Interfaces.WorksheetData#position:member'
package: excel!
fullName: position
summary: The zero-based position of the worksheet within the workbook.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'position?: number;'
return:
type: number
- name: protection
uid: 'excel!Excel.Interfaces.WorksheetData#protection:member'
package: excel!
fullName: protection
summary: Returns the sheet protection object for a worksheet.
remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'protection?: Excel.Interfaces.WorksheetProtectionData;'
return:
type: '<xref uid="excel!Excel.Interfaces.WorksheetProtectionData:interface" />'
- name: tables
uid: 'excel!Excel.Interfaces.WorksheetData#tables:member'
package: excel!
fullName: tables
summary: Collection of tables that are part of the worksheet.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'tables?: Excel.Interfaces.TableData[];'
return:
type: '<xref uid="excel!Excel.Interfaces.TableData:interface" />[]'
- name: visibility
uid: 'excel!Excel.Interfaces.WorksheetData#visibility:member'
package: excel!
fullName: visibility
summary: The visibility of the worksheet.
remarks: >-
\[ [API set: ExcelApi 1.1 for reading visibility; 1.2 for setting
it.](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
isPreview: false
isDeprecated: false
syntax:
content: 'visibility?: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";'
return:
type: '<xref uid="excel!Excel.SheetVisibility:enum" /> | "Visible" | "Hidden" | "VeryHidden"'