OneNote.Image class

El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Obtiene o establece la descripción de Image.

description: string;

Valor de propiedad

Comentarios

Conjunto de API: OneNoteApi 1.1

Obtiene o establece el alto del diseño de Image.

height: number;

Valor de propiedad

Comentarios

Conjunto de API: OneNoteApi 1.1

Obtiene o establece el hipervínculo de Image.

hyperlink: string;

Valor de propiedad

Comentarios

Conjunto de API: OneNoteApi 1.1

Obtiene el identificador del objeto de Image.

readonly id: string;

Valor de propiedad

Comentarios

Conjunto de API: OneNoteApi 1.1

Recopila los datos obtenidos mediante OCR (reconocimiento óptico de caracteres) de esta Image, como texto OCR e idioma.

readonly ocrData: OneNote.ImageOcrData;

Valor de propiedad

Comentarios

Conjunto de API: OneNoteApi 1.1

Ejemplos

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

Obtiene el objeto PageContent que contiene Image. Produce una excepción si Image no es un elemento secundario directo de un PageContent. Este objeto define la posición de Image en la página.

readonly pageContent: OneNote.PageContent;

Valor de propiedad

Comentarios

Conjunto de API: OneNoteApi 1.1

Obtiene el objeto Paragraph que contiene Image. Lanza si la imagen no es un elemento secundario directo de un párrafo.

readonly paragraph: OneNote.Paragraph;

Valor de propiedad

Comentarios

Conjunto de API: OneNoteApi 1.1

Obtiene o establece el ancho del diseño de Image.

width: number;

Valor de propiedad

Comentarios

Conjunto de API: OneNoteApi 1.1

Obtiene la representación binaria con codificación base64 de Image. Ejemplo: data:image/png; base64,iVBORw0KGgoAAAANSUhEUgAAADIA...

getBase64Image(): OfficeExtension.ClientResult<string>;

Devoluciones

Comentarios

Conjunto de API: OneNoteApi 1.1

Ejemplos

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

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

Devoluciones

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

Devoluciones

Ejemplos

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

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

Devoluciones

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto API del mismo tipo.

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

Parámetros

Devoluciones

Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente.

set(properties: OneNote.Image): void;

Parámetros

Devoluciones

Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original OneNote.Image es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como OneNote.Interfaces.ImageData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

toJSON(): OneNote.Interfaces.ImageData;

Devoluciones

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura de context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y recibe un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos objeto de seguimiento cuando se creó el objeto por primera vez.

track(): OneNote.Image;

Devoluciones

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es la abreviatura de context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Deberá llamar context.sync() antes de que la liberación de memoria surta efecto.

untrack(): OneNote.Image;

Devoluciones