Excel.Image class
Representa uma imagem na folha de cálculo. Para obter o objeto correspondente Shape , utilize Image.shape.
- Extends
Comentários
Propriedades
| brightness | Especifica a luminosidade 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 aplicado à imagem. |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã 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 que são recortados na parte inferior da imagem. |
| crop |
Especifica o número de pontos que são recortados do lado esquerdo da imagem. |
| crop |
Especifica o número de pontos que são recortados do lado direito da imagem. |
| crop |
Especifica o número de pontos que são recortados na parte superior da imagem. |
| format | Retorna o formato da imagem. |
| id | Especifica o identificador da forma para o objeto de imagem. |
| shape | Devolve o |
Métodos
| increment |
Incrementa a luminosidade da imagem por uma quantidade especificada. |
| increment |
Incrementa o contraste da imagem por 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. 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 |
Detalhes da propriedade
brightness
Especifica a luminosidade 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 aplicado à imagem.
colorType: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";Valor da propriedade
Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark"
Comentários
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
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 que são recortados na parte inferior da imagem.
cropBottom: number;Valor da propriedade
number
Comentários
cropLeft
Especifica o número de pontos que são recortados do lado esquerdo da imagem.
cropLeft: number;Valor da propriedade
number
Comentários
cropRight
Especifica o número de pontos que são recortados do lado direito da imagem.
cropRight: number;Valor da propriedade
number
Comentários
cropTop
Especifica o número de pontos que são recortados na 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 API: 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 da forma para o objeto de imagem.
readonly id: string;Valor da propriedade
string
Comentários
shape
Devolve o Shape objeto associado à imagem.
readonly shape: Excel.Shape;Valor da propriedade
Comentários
Detalhes do método
incrementBrightness(increment)
Incrementa a luminosidade da imagem por 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 por 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 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[]): Excel.Image;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
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 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
- Excel.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: 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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.Image é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ImageData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.ImageData;