Excel.WebImageCellValue interface

Stellt die URL dar, von der das Bild heruntergeladen wird. Dieses Image muss auf einem Server gehostet werden, der HTTPS unterstützt.

address: string;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.16

Beispiele

// 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");
});

Stellt den Alternativtext dar, der in Barrierefreiheitsszenarien verwendet werden kann, um zu beschreiben, was das Bild darstellt.

altText?: string;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.16

Stellt Zuordnungsinformationen dar, um die Quelle und die Lizenzanforderungen für die Verwendung dieses Bilds zu beschreiben.

attribution?: CellValueAttributionAttributes[];

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.16

Stellt den Wert dar, der für eine Zelle mit diesem Wert zurückgegeben Range.valueTypes würde.

basicType?: RangeValueType.error | "Error";

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.16

Stellt den Wert dar, der für eine Zelle mit diesem Wert zurückgegeben Range.values würde. Wenn über eine valuesAsJson Eigenschaft auf diesen Zeichenfolgenwert zugegriffen wird, entspricht er dem Gebietsschema en-US. Wenn über eine valuesAsJsonLocal Eigenschaft auf diesen Zeichenfolgenwert zugegriffen wird, richtet er sich nach dem Anzeigegebietsschema des Benutzers.

basicValue?: "#VALUE!" | string;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.16

Stellt Informationen dar, die die Entität oder Person beschreiben, die das Bild bereitgestellt hat. Diese Informationen können für das Branding in Bildkarten verwendet werden.

provider?: CellValueProviderAttributes;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.16

Stellt die URL einer Webseite mit Bildern dar, die als damit WebImageCellValuezusammenhängend betrachtet werden.

relatedImagesAddress?: string;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.16

Stellt den Typ dieses Zellwerts dar.

type: CellValueType.webImage | "WebImage";

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.16

Beispiele

// 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 = (document.getElementById("url") as HTMLInputElement).value;
  const imageAltText = (document.getElementById("alt-text") as HTMLInputElement).value;
  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();
});