Excel.WebImageCellValue interface

Paquete:

excel

Representa el valor de una celda que contiene una imagen descargada de Internet.

Comentarios

[ Conjunto de API: ExcelApi 1.16 ]

Propiedades

address	Representa la dirección URL desde la que se descargará la imagen. Esta imagen debe hospedarse en un servidor que admita HTTPS.
altText	Representa el texto alternativo que se puede usar en escenarios de accesibilidad para describir lo que representa la imagen.
attribution	Representa información de atribución para describir los requisitos de origen y licencia para usar esta imagen.
basicType	Representa el valor que devolvería Range.valueTypes para una celda con este valor.
basicValue	Representa el valor que devolvería Range.values para una celda con este valor. Cuando se accede a ella a través de una valuesAsJson propiedad, este valor de cadena se alinea con la configuración regional en-US. Cuando se accede a través de una valuesAsJsonLocal propiedad, este valor de cadena se alinea con la configuración regional de presentación del usuario.
provider	Representa información que describe la entidad o la persona que proporcionó la imagen. Esta información se puede usar para la personalización de marca en tarjetas de imagen.
relatedImagesAddress	Representa la dirección URL de una página web con imágenes que se consideran relacionadas con este WebImageCellValue.
type	Representa el tipo de este valor de celda.

Detalles de las propiedades

address

Representa la dirección URL desde la que se descargará la imagen. Esta imagen debe hospedarse en un servidor que admita HTTPS.

address: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.16 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-web-image.yaml

// This function retrieves the image URL from the selected cell and opens that image in a new browser tab.
await Excel.run(async (context) => {
  // Load the active cell information.
  const activeCell = context.workbook.getActiveCell();
  activeCell.load("valuesAsJson");
  await context.sync();

  // Get image URL from the active cell.
  const values = activeCell.valuesAsJson;
  const webImageData = values[0][0] as Excel.WebImageCellValue;
  const webImageUrl = webImageData.address;

  if (!webImageUrl) {
    console.log("The selected cell is missing an image URL. Select a cell that contains an image.");
    return;
  }

  // Open the image URL in a new browser tab.
  const tab = window.open(webImageData.address, "_blank");
});

altText

Representa el texto alternativo que se puede usar en escenarios de accesibilidad para describir lo que representa la imagen.

altText?: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.16 ]

attribution

Representa información de atribución para describir los requisitos de origen y licencia para usar esta imagen.

attribution?: CellValueAttributionAttributes[];

Valor de propiedad

Excel.CellValueAttributionAttributes[]

Comentarios

[ Conjunto de API: ExcelApi 1.16 ]

basicType

Representa el valor que devolvería Range.valueTypes para una celda con este valor.

basicType?: RangeValueType.error | "Error";

Valor de propiedad

error | "Error"

Comentarios

[ Conjunto de API: ExcelApi 1.16 ]

basicValue

Representa el valor que devolvería Range.values para una celda con este valor. Cuando se accede a ella a través de una valuesAsJson propiedad, este valor de cadena se alinea con la configuración regional en-US. Cuando se accede a través de una valuesAsJsonLocal propiedad, este valor de cadena se alinea con la configuración regional de presentación del usuario.

basicValue?: "#VALUE!" | string;

Valor de propiedad

"#VALUE!" | string

Comentarios

[ Conjunto de API: ExcelApi 1.16 ]

provider

Representa información que describe la entidad o la persona que proporcionó la imagen. Esta información se puede usar para la personalización de marca en tarjetas de imagen.

provider?: CellValueProviderAttributes;

Valor de propiedad

Excel.CellValueProviderAttributes

Comentarios

[ Conjunto de API: ExcelApi 1.16 ]

relatedImagesAddress

Representa la dirección URL de una página web con imágenes que se consideran relacionadas con este WebImageCellValue.

relatedImagesAddress?: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.16 ]

type

Representa el tipo de este valor de celda.

type: CellValueType.webImage | "WebImage";

Valor de propiedad

webImage | "WebImage"

Comentarios

[ Conjunto de API: ExcelApi 1.16 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-web-image.yaml

// This function inserts a web image into the currently selected cell.
await Excel.run(async (context) => {
  // Retrieve image data from the task pane and then clear the input fields.
  const imageUrl = $("#url").val() as string;
  const imageAltText = $("#alt-text").val() as string;
  clearForm();

  // Load the active cell.
  const activeCell = context.workbook.getActiveCell();
  activeCell.load();
  await context.sync();

  if (!imageUrl) {
    console.log("Please enter an image URL.");
    return;
  }

  // Create a web image object and assign the image details.
  const webImage: Excel.WebImageCellValue = {
    type: "WebImage", /* The string equivalent of `Excel.CellValueType.webImage`. */
    address: imageUrl,
    altText: imageAltText     
  };

  // Insert web image into the active cell.
  activeCell.valuesAsJson = [[webImage]];

  await context.sync();
});