Excel.Image class
Representa uma imagem na planilha. Para obter o objeto correspondente Shape , use Image.shape.
- Extends
Propriedades
| brightness | Especifica o brilho da imagem. O valor dessa propriedade deve ser um número de 0,0 (mais esmaecido) a 1,0 (mais brilhante). |
| color |
Especifica o tipo de transformação de cor aplicada à imagem. |
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| contrast | Especifica o contraste da imagem. O valor dessa propriedade deve ser um número de 0,0 (o menor contraste) a 1,0 (o maior contraste). |
| crop |
Especifica o número de pontos cortados da parte inferior da imagem. |
| crop |
Especifica o número de pontos que são cortados do lado esquerdo da imagem. |
| crop |
Especifica o número de pontos cortados do lado direito da imagem. |
| crop |
Especifica o número de pontos cortados da parte superior da imagem. |
| format | Retorna o formato da imagem. |
| id | Especifica o identificador de forma para o objeto de imagem. |
| shape | Retorna o |
Métodos
| increment |
Incrementa o brilho da imagem em uma quantidade especificada. |
| increment |
Incrementa o contraste da imagem em uma quantidade especificada. |
| 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. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente. |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
brightness
Especifica o brilho da imagem. O valor dessa propriedade deve ser um número de 0,0 (mais esmaecido) a 1,0 (mais brilhante).
brightness: number;Valor da propriedade
number
Comentários
colorType
Especifica o tipo de transformação de cor aplicada à imagem.
colorType: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";Valor da propriedade
Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark"
Comentários
context
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
contrast
Especifica o contraste da imagem. O valor dessa propriedade deve ser um número de 0,0 (o menor contraste) a 1,0 (o maior contraste).
contrast: number;Valor da propriedade
number
Comentários
cropBottom
Especifica o número de pontos cortados da parte inferior da imagem.
cropBottom: number;Valor da propriedade
number
Comentários
cropLeft
Especifica o número de pontos que são cortados do lado esquerdo da imagem.
cropLeft: number;Valor da propriedade
number
Comentários
cropRight
Especifica o número de pontos cortados do lado direito da imagem.
cropRight: number;Valor da propriedade
number
Comentários
cropTop
Especifica o número de pontos cortados da parte superior da imagem.
cropTop: number;Valor da propriedade
number
Comentários
format
Retorna o formato da imagem.
readonly format: Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG";Valor da propriedade
Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG"
Comentários
Conjunto de APIs: ExcelApi 1.9
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-images.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Shapes");
const image = sheet.shapes.getItem("Image").image;
image.load("format");
await context.sync();
console.log("The image's format is: " + image.format);
await context.sync();
});
id
Especifica o identificador de forma para o objeto de imagem.
readonly id: string;Valor da propriedade
string
Comentários
shape
Retorna o Shape objeto associado à imagem.
readonly shape: Excel.Shape;Valor da propriedade
Comentários
Detalhes do método
incrementBrightness(increment)
Incrementa o brilho da imagem em uma quantidade especificada.
incrementBrightness(increment: number): void;Parâmetros
- increment
-
number
Especifica quanto para alterar o valor da propriedade brilho da imagem. Um valor positivo torna a figura mais brilhante; um valor negativo torna a imagem mais escura.
Retornos
void
Comentários
incrementContrast(increment)
Incrementa o contraste da imagem em uma quantidade especificada.
incrementContrast(increment: number): void;Parâmetros
- increment
-
number
Especifica quanto para alterar o valor da propriedade contraste da imagem. Um valor positivo aumenta o contraste; um valor negativo diminui o contraste.
Retornos
void
Comentários
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?: Excel.Interfaces.ImageLoadOptions): Excel.Image;Parâmetros
Fornece opções para quais propriedades do objeto devem ser carregadas.
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[]): Excel.Image;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.
Retornos
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;
}): Excel.Image;Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.
Retornos
set(properties, options)
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
- properties
- Excel.Interfaces.ImageUpdateData
Um objeto JavaScript com propriedades estruturadas isomorficamente 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 propriedades somente leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
set(properties: Excel.Image): void;Parâmetros
- properties
- Excel.Image
Retornos
void
toJSON()
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 Excel.Image é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ImageData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.ImageData;