OneNote.Image class

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Obtient ou définit la description de l’image.

description: string;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Obtient ou définit la hauteur de la disposition de l’image.

height: number;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Obtient ou définit le lien hypertexte de l’image.

hyperlink: string;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Obtient l’ID de l’objet Image.

readonly id: string;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Obtient les données obtenues suite à la reconnaissance optique des caractères (OCR) de cette image, par exemple la langue et le texte OCR.

readonly ocrData: OneNote.ImageOcrData;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Exemples

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

Obtient l’objet PageContent qui contient l’image. Indique si l’image n’est pas un enfant direct d’un objet PageContent. Cet objet définit la position de l’image sur la page.

readonly pageContent: OneNote.PageContent;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Obtient l’objet Paragraph qui contient l’image. Se lève si l’image n’est pas un enfant direct d’un paragraphe.

readonly paragraph: OneNote.Paragraph;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Obtient ou définit la largeur de la disposition de l’image.

width: number;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Obtient la représentation binaire encodée en Base64 de l’image. Exemple : data :image/png ; base64,iVBORw0KGgoAAAANSUhEUgAAADIA...

getBase64Image(): OfficeExtension.ClientResult<string>;

Retours

Remarques

Jeu d’API : OneNoteApi 1.1

Exemples

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

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

Retours

Exemples

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

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

Retours

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

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

Paramètres

Retours

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: OneNote.Image): void;

Paramètres

Retours

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine OneNote.Image est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) OneNote.Interfaces.ImageDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): OneNote.Interfaces.ImageData;

Retours

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet entre des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run » et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivis lors de la création initiale de l’objet.

track(): OneNote.Image;

Retours

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la libération de mémoire prenne effet.

untrack(): OneNote.Image;

Retours