OneNote.InkAnalysisParagraph class

Package:

onenote

Represents ink analysis data for an identified paragraph formed by ink strokes.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: OneNoteApi 1.1 ]

Properties

context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
id	Gets the ID of the InkAnalysisParagraph object.
inkAnalysis	Reference to the parent InkAnalysisPage.
lines	Gets the ink analysis lines in this ink analysis paragraph.

Methods

load(options)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
set(properties, options)	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.
set(properties)	Sets multiple properties on the object at the same time, based on an existing loaded object.
toJSON()	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's passed to it.) Whereas the original OneNote.InkAnalysisParagraph object is an API object, the toJSON method returns a plain JavaScript object (typed as OneNote.Interfaces.InkAnalysisParagraphData) that contains shallow copies of any loaded child properties from the original object.
track()	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're 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 need to add the object to the tracked object collection when the object was first created.
untrack()	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'll need to call context.sync() before the memory release takes effect.

Property Details

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

OneNote.RequestContext

id

Gets the ID of the InkAnalysisParagraph object.

readonly id: string;

Property Value

string

Remarks

[ API set: OneNoteApi 1.1 ]

inkAnalysis

Reference to the parent InkAnalysisPage.

readonly inkAnalysis: OneNote.InkAnalysis;

Property Value

OneNote.InkAnalysis

Remarks

[ API set: OneNoteApi 1.1 ]

lines

Gets the ink analysis lines in this ink analysis paragraph.

readonly lines: OneNote.InkAnalysisLineCollection;

Property Value

OneNote.InkAnalysisLineCollection

Remarks

[ API set: OneNoteApi 1.1 ]

Method Details

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: OneNote.Interfaces.InkAnalysisParagraphLoadOptions): OneNote.InkAnalysisParagraph;

Parameters

options

OneNote.Interfaces.InkAnalysisParagraphLoadOptions

Provides options for which properties of the object to load.

Returns

OneNote.InkAnalysisParagraph

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): OneNote.InkAnalysisParagraph;

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

OneNote.InkAnalysisParagraph

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): OneNote.InkAnalysisParagraph;

Parameters

propertyNamesAndPaths

{ select?: string; expand?: string; }

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.

Returns

OneNote.InkAnalysisParagraph

set(properties, options)

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.

set(properties: Interfaces.InkAnalysisParagraphUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties

OneNote.Interfaces.InkAnalysisParagraphUpdateData

A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options

OfficeExtension.UpdateOptions

Provides an option to suppress errors if the properties object tries to set any read-only properties.

Returns

void

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: OneNote.InkAnalysisParagraph): void;

Parameters

properties

OneNote.InkAnalysisParagraph

Returns

void

toJSON()

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's passed to it.) Whereas the original OneNote.InkAnalysisParagraph object is an API object, the toJSON method returns a plain JavaScript object (typed as OneNote.Interfaces.InkAnalysisParagraphData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): OneNote.Interfaces.InkAnalysisParagraphData;

Returns

OneNote.Interfaces.InkAnalysisParagraphData

track()

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're 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 need to add the object to the tracked object collection when the object was first created.

track(): OneNote.InkAnalysisParagraph;

Returns

OneNote.InkAnalysisParagraph

untrack()

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'll need to call context.sync() before the memory release takes effect.

untrack(): OneNote.InkAnalysisParagraph;

Returns

OneNote.InkAnalysisParagraph