OneNote.Image class
Representa a Image. Image puede ser un elemento secundario directo de un objeto PageContent o de un objeto Paragraph.
- Extends
Comentarios
[ Conjunto de API: OneNoteApi 1.1 ]
Propiedades
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| description | Obtiene o establece la descripción de Image. |
| height | Obtiene o establece el alto del diseño de Image. |
| hyperlink | Obtiene o establece el hipervínculo de Image. |
| id | Obtiene el identificador del objeto de Image. |
| ocr |
Recopila los datos obtenidos mediante OCR (reconocimiento óptico de caracteres) de esta Image, como texto OCR e idioma. |
| page |
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. |
| paragraph | Obtiene el objeto Paragraph que contiene Image. Se produce si la imagen no es un elemento secundario directo de un párrafo. |
| width | Obtiene o establece el ancho del diseño de Image. |
Métodos
| get |
Obtiene la representación binaria con codificación base64 de Image. Ejemplo: data:image/png; base64,iVBORw0KGgoAAAANSUhEUgAAADIA... |
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| set(properties, options) | Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo. |
| set(properties) | Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente. |
| toJSON() | Invalida el método JavaScript |
| track() | Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre |
| untrack() | Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para 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. Tendrá que llamar |
Detalles de las propiedades
context
Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
context: RequestContext;Valor de propiedad
description
Obtiene o establece la descripción de Image.
description: string;Valor de propiedad
string
Comentarios
height
Obtiene o establece el alto del diseño de Image.
height: number;Valor de propiedad
number
Comentarios
hyperlink
Obtiene o establece el hipervínculo de Image.
hyperlink: string;Valor de propiedad
string
Comentarios
id
Obtiene el identificador del objeto de Image.
readonly id: string;Valor de propiedad
string
Comentarios
ocrData
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);
});
pageContent
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
paragraph
Obtiene el objeto Paragraph que contiene Image. Se produce si la imagen no es un elemento secundario directo de un párrafo.
readonly paragraph: OneNote.Paragraph;Valor de propiedad
Comentarios
width
Obtiene o establece el ancho del diseño de Image.
width: number;Valor de propiedad
number
Comentarios
Detalles del método
getBase64Image()
Obtiene la representación binaria con codificación base64 de Image. Ejemplo: data:image/png; base64,iVBORw0KGgoAAAANSUhEUgAAADIA...
getBase64Image(): OfficeExtension.ClientResult<string>;Devoluciones
OfficeExtension.ClientResult<string>
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);
});
load(options)
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
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
load(propertyNames)
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
- propertyNames
-
string | string[]
Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.
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);
}
});
load(propertyNamesAndPaths)
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
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.
Devoluciones
set(properties, options)
Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.
set(properties: Interfaces.ImageUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- OneNote.Interfaces.ImageUpdateData
Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.
- options
- OfficeExtension.UpdateOptions
Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.
Devoluciones
void
set(properties)
Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
set(properties: OneNote.Image): void;Parámetros
- properties
- OneNote.Image
Devoluciones
void
toJSON()
Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original OneNote.Image es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como OneNote.Interfaces.ImageData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): OneNote.Interfaces.ImageData;Devoluciones
track()
Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y obtiene 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 de seguimiento cuando se creó el objeto por primera vez.
track(): OneNote.Image;Devoluciones
untrack()
Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para 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. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.
untrack(): OneNote.Image;