OneNote.Image class
Representa uma Imagem. Um Image pode ser um filho direto de um objeto PageContent ou Paragraph.
- Extends
Comentários
[ Conjunto de API: OneNoteApi 1.1 ]
Propriedades
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| description | Obtém ou define a descrição da Imagem. |
| height | Obtém ou define a altura do layout da Imagem. |
| hyperlink | Obtém ou define o hiperlink da Imagem. |
| id | Obtém a ID do objeto Image. |
| ocr |
Obtém os dados obtidos por OCR (reconhecimento óptico de caracteres) dessa imagem, como texto OCR e idioma. |
| page |
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. |
| paragraph | Obtém o objeto Paragraph que contém o Image. Gera se a Imagem não for um elemento subordinado direto de um Parágrafo. |
| width | Obtém ou define a largura do layout da Imagem. |
Métodos
| get |
Obtém a representação binária codificada em base64 da Imagem. Exemplo: data:image/png; base64,iVBORw0KGgoAAAANSUhEUgAAADIA... |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| set(properties, options) | Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente. |
| toJSON() | Substitui o método JavaScript |
| track() | Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre |
| untrack() | Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para 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. Terá de chamar |
Detalhes da propriedade
context
O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
context: RequestContext;Valor da propriedade
description
Obtém ou define a descrição da Imagem.
description: string;Valor da propriedade
string
Comentários
height
Obtém ou define a altura do layout da Imagem.
height: number;Valor da propriedade
number
Comentários
hyperlink
Obtém ou define o hiperlink da Imagem.
hyperlink: string;Valor da propriedade
string
Comentários
id
Obtém a ID do objeto Image.
readonly id: string;Valor da propriedade
string
Comentários
ocrData
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 API: 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);
});
pageContent
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
paragraph
Obtém o objeto Paragraph que contém o Image. Gera se a Imagem não for um elemento subordinado direto de um Parágrafo.
readonly paragraph: OneNote.Paragraph;Valor da propriedade
Comentários
width
Obtém ou define a largura do layout da Imagem.
width: number;Valor da propriedade
number
Comentários
Detalhes do método
getBase64Image()
Obtém a representação binária codificada em base64 da Imagem. Exemplo: data:image/png; base64,iVBORw0KGgoAAAANSUhEUgAAADIA...
getBase64Image(): OfficeExtension.ClientResult<string>;Retornos
OfficeExtension.ClientResult<string>
Comentários
[ Conjunto de API: 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);
});
load(options)
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
Fornece opções para as propriedades do objeto a carregar.
Retornos
load(propertyNames)
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
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
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);
}
});
load(propertyNamesAndPaths)
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
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.
Retornos
set(properties, options)
Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties: Interfaces.ImageUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- OneNote.Interfaces.ImageUpdateData
Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
set(properties: OneNote.Image): void;Parâmetros
- properties
- OneNote.Image
Retornos
void
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original OneNote.Image é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como OneNote.Interfaces.ImageData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): OneNote.Interfaces.ImageData;Retornos
track()
Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este 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, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez.
track(): OneNote.Image;Retornos
untrack()
Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para 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. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.
untrack(): OneNote.Image;