Edit

Share via

OneNote.Interfaces.ImageLoadOptions interface

Package:
onenote

Represents an Image. An Image can be a direct child of a PageContent object or a Paragraph object.

Remarks

[ API set: OneNoteApi 1.1 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
description

Gets or sets the description of the Image.
height

Gets or sets the height of the Image layout.
hyperlink

Gets or sets the hyperlink of the Image.
id

Gets the ID of the Image object. Read-only.
ocrData

Gets the data obtained by OCR (Optical Character Recognition) of this Image, such as OCR text and language.
pageContent

Gets the PageContent object that contains the Image. Throws if the Image isn't a direct child of a PageContent. This object defines the position of the Image on the page.
paragraph

Gets the Paragraph object that contains the Image. Throws if the Image isn't a direct child of a Paragraph.
width

Gets or sets the width of the Image layout.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

description

Gets or sets the description of the Image.

description?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

height

Gets or sets the height of the Image layout.

height?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

Gets or sets the hyperlink of the Image.

hyperlink?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

id

Gets the ID of the Image object. Read-only.

id?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

ocrData

Gets the data obtained by OCR (Optical Character Recognition) of this Image, such as OCR text and language.

ocrData?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

pageContent

Gets the PageContent object that contains the Image. Throws if the Image isn't a direct child of a PageContent. This object defines the position of the Image on the page.

pageContent?: OneNote.Interfaces.PageContentLoadOptions;

Property Value

OneNote.Interfaces.PageContentLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

paragraph

Gets the Paragraph object that contains the Image. Throws if the Image isn't a direct child of a Paragraph.

paragraph?: OneNote.Interfaces.ParagraphLoadOptions;

Property Value

OneNote.Interfaces.ParagraphLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

width

Gets or sets the width of the Image layout.

width?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]