-
Notifications
You must be signed in to change notification settings - Fork 61
/
excel.interfaces.pagelayoutdata.yml
269 lines (269 loc) · 11.5 KB
/
excel.interfaces.pagelayoutdata.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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
### YamlMime:TSType
name: Excel.Interfaces.PageLayoutData
uid: 'excel!Excel.Interfaces.PageLayoutData:interface'
package: excel!
fullName: Excel.Interfaces.PageLayoutData
summary: An interface describing the data returned by calling `pageLayout.toJSON()`<!-- -->.
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- name: blackAndWhite
uid: 'excel!Excel.Interfaces.PageLayoutData#blackAndWhite:member'
package: excel!
fullName: blackAndWhite
summary: The worksheet's black and white print option.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'blackAndWhite?: boolean;'
return:
type: boolean
- name: bottomMargin
uid: 'excel!Excel.Interfaces.PageLayoutData#bottomMargin:member'
package: excel!
fullName: bottomMargin
summary: The worksheet's bottom page margin to use for printing in points.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'bottomMargin?: number;'
return:
type: number
- name: centerHorizontally
uid: 'excel!Excel.Interfaces.PageLayoutData#centerHorizontally:member'
package: excel!
fullName: centerHorizontally
summary: >-
The worksheet's center horizontally flag. This flag determines whether the worksheet will be centered horizontally
when it's printed.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'centerHorizontally?: boolean;'
return:
type: boolean
- name: centerVertically
uid: 'excel!Excel.Interfaces.PageLayoutData#centerVertically:member'
package: excel!
fullName: centerVertically
summary: >-
The worksheet's center vertically flag. This flag determines whether the worksheet will be centered vertically
when it's printed.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'centerVertically?: boolean;'
return:
type: boolean
- name: draftMode
uid: 'excel!Excel.Interfaces.PageLayoutData#draftMode:member'
package: excel!
fullName: draftMode
summary: 'The worksheet''s draft mode option. If `true`<!-- -->, the sheet will be printed without graphics.'
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'draftMode?: boolean;'
return:
type: boolean
- name: firstPageNumber
uid: 'excel!Excel.Interfaces.PageLayoutData#firstPageNumber:member'
package: excel!
fullName: firstPageNumber
summary: The worksheet's first page number to print. A `null` value represents "auto" page numbering.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'firstPageNumber?: number | "";'
return:
type: number | ""
- name: footerMargin
uid: 'excel!Excel.Interfaces.PageLayoutData#footerMargin:member'
package: excel!
fullName: footerMargin
summary: 'The worksheet''s footer margin, in points, for use when printing.'
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'footerMargin?: number;'
return:
type: number
- name: headerMargin
uid: 'excel!Excel.Interfaces.PageLayoutData#headerMargin:member'
package: excel!
fullName: headerMargin
summary: 'The worksheet''s header margin, in points, for use when printing.'
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'headerMargin?: number;'
return:
type: number
- name: headersFooters
uid: 'excel!Excel.Interfaces.PageLayoutData#headersFooters:member'
package: excel!
fullName: headersFooters
summary: Header and footer configuration for the worksheet.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'headersFooters?: Excel.Interfaces.HeaderFooterGroupData;'
return:
type: '<xref uid="excel!Excel.Interfaces.HeaderFooterGroupData:interface" />'
- name: leftMargin
uid: 'excel!Excel.Interfaces.PageLayoutData#leftMargin:member'
package: excel!
fullName: leftMargin
summary: 'The worksheet''s left margin, in points, for use when printing.'
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'leftMargin?: number;'
return:
type: number
- name: orientation
uid: 'excel!Excel.Interfaces.PageLayoutData#orientation:member'
package: excel!
fullName: orientation
summary: The worksheet's orientation of the page.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'orientation?: Excel.PageOrientation | "Portrait" | "Landscape";'
return:
type: '<xref uid="excel!Excel.PageOrientation:enum" /> | "Portrait" | "Landscape"'
- name: paperSize
uid: 'excel!Excel.Interfaces.PageLayoutData#paperSize:member'
package: excel!
fullName: paperSize
summary: The worksheet's paper size of the page.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
paperSize?: Excel.PaperType | "Letter" | "LetterSmall" | "Tabloid" | "Ledger" | "Legal" | "Statement" |
"Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "Folio" | "Quatro" | "Paper10x14" | "Paper11x17" |
"Note" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "Csheet" | "Dsheet" |
"Esheet" | "EnvelopeDL" | "EnvelopeC5" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC6" | "EnvelopeC65" |
"EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" |
"FanfoldUS" | "FanfoldStdGerman" | "FanfoldLegalGerman";
return:
type: >-
<xref uid="excel!Excel.PaperType:enum" /> | "Letter" | "LetterSmall" | "Tabloid" | "Ledger" | "Legal" |
"Statement" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "Folio" | "Quatro" | "Paper10x14" |
"Paper11x17" | "Note" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "Csheet" |
"Dsheet" | "Esheet" | "EnvelopeDL" | "EnvelopeC5" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC6" | "EnvelopeC65"
| "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" |
"FanfoldUS" | "FanfoldStdGerman" | "FanfoldLegalGerman"
- name: printComments
uid: 'excel!Excel.Interfaces.PageLayoutData#printComments:member'
package: excel!
fullName: printComments
summary: Specifies if the worksheet's comments should be displayed when printing.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'printComments?: Excel.PrintComments | "NoComments" | "EndSheet" | "InPlace";'
return:
type: '<xref uid="excel!Excel.PrintComments:enum" /> | "NoComments" | "EndSheet" | "InPlace"'
- name: printErrors
uid: 'excel!Excel.Interfaces.PageLayoutData#printErrors:member'
package: excel!
fullName: printErrors
summary: The worksheet's print errors option.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'printErrors?: Excel.PrintErrorType | "AsDisplayed" | "Blank" | "Dash" | "NotAvailable";'
return:
type: '<xref uid="excel!Excel.PrintErrorType:enum" /> | "AsDisplayed" | "Blank" | "Dash" | "NotAvailable"'
- name: printGridlines
uid: 'excel!Excel.Interfaces.PageLayoutData#printGridlines:member'
package: excel!
fullName: printGridlines
summary: Specifies if the worksheet's gridlines will be printed.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'printGridlines?: boolean;'
return:
type: boolean
- name: printHeadings
uid: 'excel!Excel.Interfaces.PageLayoutData#printHeadings:member'
package: excel!
fullName: printHeadings
summary: Specifies if the worksheet's headings will be printed.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'printHeadings?: boolean;'
return:
type: boolean
- name: printOrder
uid: 'excel!Excel.Interfaces.PageLayoutData#printOrder:member'
package: excel!
fullName: printOrder
summary: The worksheet's page print order option. This specifies the order to use for processing the page number printed.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'printOrder?: Excel.PrintOrder | "DownThenOver" | "OverThenDown";'
return:
type: '<xref uid="excel!Excel.PrintOrder:enum" /> | "DownThenOver" | "OverThenDown"'
- name: rightMargin
uid: 'excel!Excel.Interfaces.PageLayoutData#rightMargin:member'
package: excel!
fullName: rightMargin
summary: 'The worksheet''s right margin, in points, for use when printing.'
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'rightMargin?: number;'
return:
type: number
- name: topMargin
uid: 'excel!Excel.Interfaces.PageLayoutData#topMargin:member'
package: excel!
fullName: topMargin
summary: 'The worksheet''s top margin, in points, for use when printing.'
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'topMargin?: number;'
return:
type: number
- name: zoom
uid: 'excel!Excel.Interfaces.PageLayoutData#zoom:member'
package: excel!
fullName: zoom
summary: >-
The worksheet's print zoom options. The `PageLayoutZoomOptions` object must be set as a JSON object (use `x.zoom =
{...}` instead of `x.zoom.scale = ...`<!-- -->).
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'zoom?: Excel.PageLayoutZoomOptions;'
return:
type: '<xref uid="excel!Excel.PageLayoutZoomOptions:interface" />'