Excel.Image class
Representa una imagen de la hoja de cálculo. Para obtener el objeto correspondiente Shape , use Image.shape.
- Extends
Propiedades
| brightness | Especifica el brillo de la imagen. El valor de esta propiedad debe ser un número de 0,0 (atenuación máxima) a 1,0 (brillo máximo). |
| color |
Especifica el tipo de transformación del color que se aplica a la imagen. |
| context | 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. |
| contrast | Especifica el contraste de la imagen. El valor de esta propiedad debe ser un número de 0,0 (el menor contraste) a 1,0 (el mayor contraste). |
| crop |
Especifica el número de puntos que se recortan de la parte inferior de la imagen. |
| crop |
Especifica el número de puntos que se recortan del lado izquierdo de la imagen. |
| crop |
Especifica el número de puntos que se recortan del lado derecho de la imagen. |
| crop |
Especifica el número de puntos recortados de la parte superior de la imagen. |
| format | Devuelve el formato de la imagen. |
| id | Especifica el identificador de forma del objeto image. |
| shape | Devuelve el |
Métodos
| increment |
Incrementa el brillo de la imagen en una cantidad especificada. |
| increment |
Incrementa el contraste de la imagen en una cantidad especificada. |
| 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 API del mismo tipo. |
| set(properties) | Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente. |
| toJSON() | Reemplaza el método JavaScript |
Detalles de las propiedades
brightness
Especifica el brillo de la imagen. El valor de esta propiedad debe ser un número de 0,0 (atenuación máxima) a 1,0 (brillo máximo).
brightness: number;Valor de propiedad
number
Comentarios
colorType
Especifica el tipo de transformación del color que se aplica a la imagen.
colorType: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";Valor de propiedad
Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark"
Comentarios
context
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
contrast
Especifica el contraste de la imagen. El valor de esta propiedad debe ser un número de 0,0 (el menor contraste) a 1,0 (el mayor contraste).
contrast: number;Valor de propiedad
number
Comentarios
cropBottom
Especifica el número de puntos que se recortan de la parte inferior de la imagen.
cropBottom: number;Valor de propiedad
number
Comentarios
cropLeft
Especifica el número de puntos que se recortan del lado izquierdo de la imagen.
cropLeft: number;Valor de propiedad
number
Comentarios
cropRight
Especifica el número de puntos que se recortan del lado derecho de la imagen.
cropRight: number;Valor de propiedad
number
Comentarios
cropTop
Especifica el número de puntos recortados de la parte superior de la imagen.
cropTop: number;Valor de propiedad
number
Comentarios
format
Devuelve el formato de la imagen.
readonly format: Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG";Valor de propiedad
Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG"
Comentarios
Ejemplos
// 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 el identificador de forma del objeto image.
readonly id: string;Valor de propiedad
string
Comentarios
shape
Devuelve el Shape objeto asociado a la imagen.
readonly shape: Excel.Shape;Valor de propiedad
Comentarios
Detalles del método
incrementBrightness(increment)
Incrementa el brillo de la imagen en una cantidad especificada.
incrementBrightness(increment: number): void;Parámetros
- increment
-
number
Especifica cuánto para cambiar el valor de la propiedad Brightness de la imagen. Un valor positivo hace la imagen más brillante; un valor negativo oscurece la imagen.
Devoluciones
void
Comentarios
incrementContrast(increment)
Incrementa el contraste de la imagen en una cantidad especificada.
incrementContrast(increment: number): void;Parámetros
- increment
-
number
Especifica cuánto para cambiar el valor de la propiedad Contrast de la imagen. Un valor positivo aumenta el contraste; un valor negativo reduce el contraste.
Devoluciones
void
Comentarios
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?: Excel.Interfaces.ImageLoadOptions): Excel.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[]): Excel.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
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;
}): Excel.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 API del mismo tipo.
set(properties: Interfaces.ImageUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Excel.Interfaces.ImageUpdateData
Un objeto JavaScript con propiedades que están estructuradas isomorfamente a las propiedades del objeto en el 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, basadas en un objeto cargado existente.
set(properties: Excel.Image): void;Parámetros
- properties
- Excel.Image
Devoluciones
void
toJSON()
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 Excel.Image es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.ImageData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.
toJSON(): Excel.Interfaces.ImageData;