OneNote JavaScript API overview

Applies to: OneNote Online

The following links show the high level OneNote objects available in the API. Each object page link contains a description of the properties, events, and methods available on the object. Explore these links to learn more.

  • Application: The top-level object used to access all globally addressable OneNote objects, such as the active notebook and the active section.

  • Notebook: A notebook. Notebooks contain section groups and sections.

  • SectionGroup: A section group. Section groups contain section groups and sections.

  • Section: A section. Sections contain pages.

  • Page: A page. Pages contain PageContent objects.

  • PageContent: A top-level region on a page that contains content types such as Outline or Image. A PageContent object can be assigned a position on the page.

  • Outline: A container for Paragraph objects. An Outline is a direct child of a PageContent object.

  • Image: An Image object. An Image can be a direct child of a PageContent object or a Paragraph.

  • Paragraph: A container for the visible content on a page. A Paragraph is a direct child of an Outline.

  • RichText: A RichText object.

  • Table: A container for TableRow objects.

  • TableRow: A container for TableCell objects.

  • TableCell: A container for Paragraph objects.

OneNote JavaScript API requirement sets

Requirement sets are named groups of API members. Office Add-ins use requirement sets specified in the manifest or use a runtime check to determine whether an Office host supports APIs that an add-in needs. For detailed information about OneNote JavaScript API requirement sets, see the OneNote JavaScript API requirement sets article.

OneNote JavaScript API reference

For detailed information about the OneNote JavaScript API, see the OneNote JavaScript API reference documentation.

See also