OneNote.Image class

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Obtém ou define a descrição da Imagem.

description: string;

Valor da propriedade

Comentários

Conjunto de APIs: OneNoteApi 1.1

Obtém ou define a altura do layout da Imagem.

height: number;

Valor da propriedade

Comentários

Conjunto de APIs: OneNoteApi 1.1

Obtém ou define o hiperlink da Imagem.

hyperlink: string;

Valor da propriedade

Comentários

Conjunto de APIs: OneNoteApi 1.1

Obtém a ID do objeto Image.

readonly id: string;

Valor da propriedade

Comentários

Conjunto de APIs: OneNoteApi 1.1

Obtém os dados obtidos por OCR (reconhecimento óptico de caracteres) dessa imagem, como texto OCR e idioma.

readonly ocrData: OneNote.ImageOcrData;

Valor da propriedade

Comentários

Conjunto de APIs: OneNoteApi 1.1

Exemplos

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

Obtém o objeto PageContent que contém o Image. É gerado se a Imagem não é um filho direto de um PageContent. Este objeto define a posição de Image na página.

readonly pageContent: OneNote.PageContent;

Valor da propriedade

Comentários

Conjunto de APIs: OneNoteApi 1.1

Obtém o objeto Paragraph que contém o Image. Lança se a imagem não for um filho direto de um parágrafo.

readonly paragraph: OneNote.Paragraph;

Valor da propriedade

Comentários

Conjunto de APIs: OneNoteApi 1.1

Obtém ou define a largura do layout da Imagem.

width: number;

Valor da propriedade

Comentários

Conjunto de APIs: OneNoteApi 1.1

Obtém a representação binária codificada em base64 da Imagem. Exemplo: data:image/png; base64,iVBORw0KGgoAAAANSUhEUgAAADIA...

getBase64Image(): OfficeExtension.ClientResult<string>;

Retornos

Comentários

Conjunto de APIs: OneNoteApi 1.1

Exemplos

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

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Exemplos

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

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

Retornos

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: OneNote.Image): void;

Parâmetros

Retornos

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original OneNote.Image é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como OneNote.Interfaces.ImageData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): OneNote.Interfaces.ImageData;

Retornos

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação de context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez.

track(): OneNote.Image;

Retornos

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é a forma abreviada de context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Você precisará ligar context.sync() antes que a liberação de memória entre em vigor.

untrack(): OneNote.Image;

Retornos