OneNote.Image class

Ссылка

Пакет:: onenote

Представляет изображение. Объект Image может быть прямым потомком объекта PageContent или объекта Paragraph.

Extends: OfficeExtension.ClientObject

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
description	Получает или задает описание объекта Image.
height	Получает или задает высоту объекта Image.
hyperlink	Получает или задает гиперссылку для объекта Image.
id	Получает идентификатор объекта Image. Только для чтения.
ocrData	Получает данные, собранные с помощью распознавания текста (OCR) для этого объекта Image, например текст и язык.
pageContent	Получает объект PageContent, содержащий объект Image. Выдает исключение, если объект Image не является непосредственным дочерним элементом для объекта PageContent. Этот объект определяет положение объекта Image на странице. Только для чтения.
paragraph	Получает объект Paragraph, содержащий объект Image. Выдает исключение, если объект Image не является непосредственным дочерним элементом для объекта Paragraph. Только для чтения.
width	Получает или задает ширину объекта Image.

Методы

getBase64Image()	Получает двоичное представление объекта Image в кодировке Base64. Пример: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIA...
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный объект OneNote.Image является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `OneNote.Interfaces.ImageData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для `context.trackedObjects.add(thisObject)`. Если вы используете этот объект в вызовах `.sync` и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для `context.trackedObjects.remove(thisObject)`. Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить `context.sync()` до того, как выпуск памяти вступит в силу.

Сведения о свойстве

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

OneNote.RequestContext

description

Получает или задает описание объекта Image.

description: string;

Значение свойства

string

height

Получает или задает высоту объекта Image.

height: number;

Значение свойства

number

hyperlink

Получает или задает гиперссылку для объекта Image.

hyperlink: string;

Значение свойства

string

id

Получает идентификатор объекта Image. Только для чтения.

readonly id: string;

Значение свойства

string

ocrData

Получает данные, собранные с помощью распознавания текста (OCR) для этого объекта Image, например текст и язык.

readonly ocrData: OneNote.ImageOcrData;

Значение свойства

OneNote.ImageOcrData

Примеры

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);
});

pageContent

Получает объект PageContent, содержащий объект Image. Выдает исключение, если объект Image не является непосредственным дочерним элементом для объекта PageContent. Этот объект определяет положение объекта Image на странице. Только для чтения.

readonly pageContent: OneNote.PageContent;

Значение свойства

OneNote.PageContent

paragraph

Получает объект Paragraph, содержащий объект Image. Выдает исключение, если объект Image не является непосредственным дочерним элементом для объекта Paragraph. Только для чтения.

readonly paragraph: OneNote.Paragraph;

Значение свойства

OneNote.Paragraph

width

Получает или задает ширину объекта Image.

width: number;

Значение свойства

number

Сведения о методе

getBase64Image()

Получает двоичное представление объекта Image в кодировке Base64. Пример: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIA...

getBase64Image(): OfficeExtension.ClientResult<string>;

Возвращаемое значение

OfficeExtension.ClientResult<string>

Примеры

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);
});

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: OneNote.Interfaces.ImageLoadOptions): OneNote.Image;

Параметры

options: OneNote.Interfaces.ImageLoadOptions

Предоставляет параметры свойств загружаемого объекта.

Возвращаемое значение

OneNote.Image

load(propertyNames)

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

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

OneNote.Image

Примеры

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);
    }
});

load(propertyNamesAndPaths)

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

Параметры

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

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

OneNote.Image

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

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

Параметры

properties: OneNote.Interfaces.ImageUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options: OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

Возвращаемое значение

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: OneNote.Image): void;

Параметры

properties: OneNote.Image

Возвращаемое значение

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект OneNote.Image является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как OneNote.Interfaces.ImageData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): OneNote.Interfaces.ImageData;

Возвращаемое значение

OneNote.Interfaces.ImageData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта.

track(): OneNote.Image;

Возвращаемое значение

OneNote.Image

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

untrack(): OneNote.Image;

Возвращаемое значение

OneNote.Image

Поделиться через

OneNote.Image class

Комментарии

Свойства

Методы

Сведения о свойстве

context

Значение свойства

description

Значение свойства

Комментарии

height

Значение свойства

Комментарии

hyperlink

Значение свойства

Комментарии

id

Значение свойства

Комментарии

ocrData

Значение свойства

Комментарии

Примеры

pageContent

Значение свойства

Комментарии

paragraph

Значение свойства

Комментарии

width

Значение свойства

Комментарии

Сведения о методе

getBase64Image()

Возвращаемое значение

Комментарии

Примеры

load(options)

Параметры

Возвращаемое значение

load(propertyNames)

Параметры

Возвращаемое значение

Примеры

load(propertyNamesAndPaths)

Параметры

Возвращаемое значение

set(properties, options)

Параметры

Возвращаемое значение

set(properties)

Параметры

Возвращаемое значение

toJSON()

Возвращаемое значение

track()

Возвращаемое значение

untrack()

Возвращаемое значение

Обратная связь

Дополнительные ресурсы