/
onenote.image.yml
402 lines (382 loc) · 14.8 KB
/
onenote.image.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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
### YamlMime:TSType
name: OneNote.Image
uid: 'onenote!OneNote.Image:class'
package: onenote!
fullName: OneNote.Image
summary: Represents an Image. An Image can be a direct child of a PageContent object or a Paragraph object.
remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
- name: context
uid: 'onenote!OneNote.Image#context:member'
package: onenote!
fullName: context
summary: >-
The request context associated with the object. This connects the add-in's process to the Office host
application's process.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
return:
type: '<xref uid="onenote!OneNote.RequestContext:class" />'
- name: description
uid: 'onenote!OneNote.Image#description:member'
package: onenote!
fullName: description
summary: Gets or sets the description of the Image.
remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'description: string;'
return:
type: string
- name: height
uid: 'onenote!OneNote.Image#height:member'
package: onenote!
fullName: height
summary: Gets or sets the height of the Image layout.
remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'height: number;'
return:
type: number
- name: hyperlink
uid: 'onenote!OneNote.Image#hyperlink:member'
package: onenote!
fullName: hyperlink
summary: Gets or sets the hyperlink of the Image.
remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'hyperlink: string;'
return:
type: string
- name: id
uid: 'onenote!OneNote.Image#id:member'
package: onenote!
fullName: id
summary: Gets the ID of the Image object. Read-only.
remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly id: string;'
return:
type: string
- name: ocrData
uid: 'onenote!OneNote.Image#ocrData:member'
package: onenote!
fullName: ocrData
summary: 'Gets the data obtained by OCR (Optical Character Recognition) of this Image, such as OCR text and language.'
remarks: |-
\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]
#### Examples
```TypeScript
let image = null;
await OneNote.run(async (context) => {
// Get the current outline.
const outline = context.application.getActiveOutline();
// Queue a command to load paragraphs and their types.
outline.load("paragraphs")
await context.sync();
for (let i=0; i < outline.paragraphs.items.length; i++) {
const paragraph = outline.paragraphs.items[i];
if (paragraph.type == "Image")
{
image = paragraph.image;
}
}
if (image != null) {
image.load("ocrData");
}
await context.sync();
// Log ocrText and ocrLanguageId.
console.log(image.ocrData.ocrText);
console.log(image.ocrData.ocrLanguageId);
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'readonly ocrData: OneNote.ImageOcrData;'
return:
type: '<xref uid="onenote!OneNote.ImageOcrData:interface" />'
- name: pageContent
uid: 'onenote!OneNote.Image#pageContent:member'
package: onenote!
fullName: pageContent
summary: >-
Gets the PageContent object that contains the Image. Throws if the Image is not a direct child of a PageContent.
This object defines the position of the Image on the page. Read-only.
remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly pageContent: OneNote.PageContent;'
return:
type: '<xref uid="onenote!OneNote.PageContent:class" />'
- name: paragraph
uid: 'onenote!OneNote.Image#paragraph:member'
package: onenote!
fullName: paragraph
summary: >-
Gets the Paragraph object that contains the Image. Throws if the Image is not a direct child of a Paragraph.
Read-only.
remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly paragraph: OneNote.Paragraph;'
return:
type: '<xref uid="onenote!OneNote.Paragraph:class" />'
- name: width
uid: 'onenote!OneNote.Image#width:member'
package: onenote!
fullName: width
summary: Gets or sets the width of the Image layout.
remarks: '\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'width: number;'
return:
type: number
methods:
- name: getBase64Image()
uid: 'onenote!OneNote.Image#getBase64Image:member(1)'
package: onenote!
fullName: getBase64Image()
summary: >-
Gets the base64-encoded binary representation of the Image. Example:
data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIA...
remarks: |-
\[ [API set: OneNoteApi 1.1](/javascript/api/requirement-sets/onenote/onenote-api-requirement-sets) \]
#### Examples
```TypeScript
let image = null;
let imageString;
await OneNote.run(async (context) => {
// Get the current outline.
const outline = context.application.getActiveOutline();
// Queue a command to load paragraphs and their types.
outline.load("paragraphs/type")
await context.sync();
for (let i=0; i < outline.paragraphs.items.length; i++) {
const paragraph = outline.paragraphs.items[i];
if (paragraph.type == "Image")
{
image = paragraph.image;
}
}
if (image != null) {
imageString = image.getBase64Image();
await context.sync();
}
console.log(imageString);
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'getBase64Image(): OfficeExtension.ClientResult<string>;'
return:
type: '<xref uid="office!OfficeExtension.ClientResult:class" /><string>'
description: ''
- name: load(options)
uid: 'onenote!OneNote.Image#load:member(1)'
package: onenote!
fullName: load(options)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'load(options?: OneNote.Interfaces.ImageLoadOptions): OneNote.Image;'
parameters:
- id: options
description: Provides options for which properties of the object to load.
type: '<xref uid="onenote!OneNote.Interfaces.ImageLoadOptions:interface" />'
return:
type: '<xref uid="onenote!OneNote.Image:class" />'
description: ''
- name: load(propertyNames)
uid: 'onenote!OneNote.Image#load:member(2)'
package: onenote!
fullName: load(propertyNames)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'load(propertyNames?: string | string[]): OneNote.Image;'
parameters:
- id: propertyNames
description: A comma-delimited string or an array of strings that specify the properties to load.
type: 'string | string[]'
return:
type: '<xref uid="onenote!OneNote.Image:class" />'
description: |-
#### Examples
```TypeScript
await OneNote.run(async (context) => {
// Get the current outline.
const outline = context.application.getActiveOutline();
let image = null;
// Queue a command to load paragraphs and their types.
outline.load("paragraphs/type")
await context.sync();
for (let i=0; i < outline.paragraphs.items.length; i++) {
const paragraph = outline.paragraphs.items[i];
if (paragraph.type == "Image")
{
image = paragraph.image;
}
}
if (image != null) {
// Load all properties and relationships.
image.load(["id", "width", "height", "description", "hyperlink"]);
await context.sync();
}
if (image != null) {
console.log("image " + image.id + " width is " + image.width + " height is " + image.height);
console.log("description: " + image.description);
console.log("hyperlink: " + image.hyperlink);
}
});
```
- name: load(propertyNamesAndPaths)
uid: 'onenote!OneNote.Image#load:member(3)'
package: onenote!
fullName: load(propertyNamesAndPaths)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: |-
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): OneNote.Image;
parameters:
- id: propertyNamesAndPaths
description: >-
`propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and
`propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
type: |-
{
select?: string;
expand?: string;
}
return:
type: '<xref uid="onenote!OneNote.Image:class" />'
description: ''
- name: 'set(properties, options)'
uid: 'onenote!OneNote.Image#set:member(1)'
package: onenote!
fullName: 'set(properties, options)'
summary: >-
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate
properties, or another API object of the same type.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'set(properties: Interfaces.ImageUpdateData, options?: OfficeExtension.UpdateOptions): void;'
parameters:
- id: properties
description: >-
A JavaScript object with properties that are structured isomorphically to the properties of the object on
which the method is called.
type: '<xref uid="onenote!OneNote.Interfaces.ImageUpdateData:interface" />'
- id: options
description: Provides an option to suppress errors if the properties object tries to set any read-only properties.
type: '<xref uid="office!OfficeExtension.UpdateOptions:interface" />'
return:
type: void
description: ''
- name: set(properties)
uid: 'onenote!OneNote.Image#set:member(2)'
package: onenote!
fullName: set(properties)
summary: 'Sets multiple properties on the object at the same time, based on an existing loaded object.'
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'set(properties: OneNote.Image): void;'
parameters:
- id: properties
description: ''
type: '<xref uid="onenote!OneNote.Image:class" />'
return:
type: void
description: ''
- name: toJSON()
uid: 'onenote!OneNote.Image#toJSON:member(1)'
package: onenote!
fullName: toJSON()
summary: >-
Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to
`JSON.stringify()`<!-- -->. (`JSON.stringify`<!-- -->, in turn, calls the `toJSON` method of the object that is
passed to it.) Whereas the original OneNote.Image object is an API object, the `toJSON` method returns a plain
JavaScript object (typed as `OneNote.Interfaces.ImageData`<!-- -->) that contains shallow copies of any loaded
child properties from the original object.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): OneNote.Interfaces.ImageData;'
return:
type: '<xref uid="onenote!OneNote.Interfaces.ImageData:interface" />'
description: ''
- name: track()
uid: 'onenote!OneNote.Image#track:member(1)'
package: onenote!
fullName: track()
summary: >-
Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand
for `context.trackedObjects.add(thisObject)`<!-- -->. If you are using this object across `.sync` calls and
outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property
or invoking a method on the object, you needed to have added the object to the tracked object collection when the
object was first created.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'track(): OneNote.Image;'
return:
type: '<xref uid="onenote!OneNote.Image:class" />'
description: ''
- name: untrack()
uid: 'onenote!OneNote.Image#untrack:member(1)'
package: onenote!
fullName: untrack()
summary: >-
Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
`context.trackedObjects.remove(thisObject)`<!-- -->. Having many tracked objects slows down the host application,
so please remember to free any objects you add, once you're done using them. You will need to call
`context.sync()` before the memory release takes effect.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'untrack(): OneNote.Image;'
return:
type: '<xref uid="onenote!OneNote.Image:class" />'
description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'