Edit

Share via

OneNote.Interfaces.ImageData interface

  • Reference
Package:
onenote

An interface describing the data returned by calling image.toJSON().

Properties

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.
width

Gets or sets the width of the Image layout.

Property Details

description

Gets or sets the description of the Image.

description?: string;

Property Value

string

Remarks

[ API set: OneNoteApi 1.1 ]

height

Gets or sets the height of the Image layout.

height?: number;

Property Value

number

Remarks

[ API set: OneNoteApi 1.1 ]

Gets or sets the hyperlink of the Image.

hyperlink?: string;

Property Value

string

Remarks

[ API set: OneNoteApi 1.1 ]

id

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

id?: string;

Property Value

string

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?: OneNote.ImageOcrData;

Property Value

OneNote.ImageOcrData

Remarks

[ API set: OneNoteApi 1.1 ]

width

Gets or sets the width of the Image layout.

width?: number;

Property Value

number

Remarks

[ API set: OneNoteApi 1.1 ]