Excel.WebImageCellValue interface

Paket:

excel

Stellt den Wert einer Zelle dar, die ein aus dem Internet heruntergeladenes Bild enthält.

Hinweise

[ API-Satz: ExcelApi 1.16 ]

Eigenschaften

address	Stellt die URL dar, von der das Bild heruntergeladen wird. Dieses Image muss auf einem Server gehostet werden, der HTTPS unterstützt.
altText	Stellt den alternativen Text dar, der in Barrierefreiheitsszenarien verwendet werden kann, um zu beschreiben, was das Bild darstellt.
attribution	Stellt Zuordnungsinformationen dar, um die Quell- und Lizenzanforderungen für die Verwendung dieses Bilds zu beschreiben.
basicType	Stellt den Wert dar, der von Range.valueTypes für eine Zelle mit diesem Wert zurückgegeben wird.
basicValue	Stellt den Wert dar, der von Range.values für eine Zelle mit diesem Wert zurückgegeben wird. Beim Zugriff über eine valuesAsJson Eigenschaft wird dieser Zeichenfolgenwert am Gebietsschema en-US ausgerichtet. Beim Zugriff über eine valuesAsJsonLocal Eigenschaft wird dieser Zeichenfolgenwert am Anzeigegebietsschema des Benutzers ausgerichtet.
provider	Stellt Informationen dar, die die Entität oder Person beschreiben, die das Bild bereitgestellt hat. Diese Informationen können für das Branding in Imagecards verwendet werden.
relatedImagesAddress	Stellt die URL einer Webseite mit Bildern dar, die als mit dieser WebImageCellValueverknüpft betrachtet werden.
type	Stellt den Typ dieses Zellwerts dar.

Details zur Eigenschaft

address

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

string

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

altText

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

altText?: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.16 ]

attribution

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

attribution?: CellValueAttributionAttributes[];

Eigenschaftswert

Excel.CellValueAttributionAttributes[]

Hinweise

[ API-Satz: ExcelApi 1.16 ]

basicType

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

basicType?: RangeValueType.error | "Error";

Eigenschaftswert

error | "Error"

Hinweise

[ API-Satz: ExcelApi 1.16 ]

basicValue

Stellt den Wert dar, der von Range.values für eine Zelle mit diesem Wert zurückgegeben wird. Beim Zugriff über eine valuesAsJson Eigenschaft wird dieser Zeichenfolgenwert am Gebietsschema en-US ausgerichtet. Beim Zugriff über eine valuesAsJsonLocal Eigenschaft wird dieser Zeichenfolgenwert am Anzeigegebietsschema des Benutzers ausgerichtet.

basicValue?: "#VALUE!" | string;

Eigenschaftswert

"#VALUE!" | string

Hinweise

[ API-Satz: ExcelApi 1.16 ]

provider

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

provider?: CellValueProviderAttributes;

Eigenschaftswert

Excel.CellValueProviderAttributes

Hinweise

[ API-Satz: ExcelApi 1.16 ]

relatedImagesAddress

Stellt die URL einer Webseite mit Bildern dar, die als mit dieser WebImageCellValueverknüpft betrachtet werden.

relatedImagesAddress?: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.16 ]

type

Stellt den Typ dieses Zellwerts dar.

type: CellValueType.webImage | "WebImage";

Eigenschaftswert

webImage | "WebImage"

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 = $("#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();
});