Excel.WebImageCellValue interface

Paquet:

excel

Représente la valeur d’une cellule contenant une image téléchargée à partir d’Internet.

Remarques

[ Ensemble d’API : ExcelApi 1.16 ]

Propriétés

address	Représente l’URL à partir de laquelle l’image sera téléchargée. Cette image doit être hébergée sur un serveur qui prend en charge HTTPS.
altText	Représente le texte de remplacement qui peut être utilisé dans les scénarios d’accessibilité pour décrire ce que l’image représente.
attribution	Représente les informations d’attribution pour décrire la source et les licences requises pour l’utilisation de cette image.
basicType	Représente la valeur qui serait retournée par Range.valueTypes pour une cellule avec cette valeur.
basicValue	Représente la valeur qui serait retournée par Range.values pour une cellule avec cette valeur. Lorsqu’elle est accessible via une valuesAsJson propriété, cette valeur de chaîne s’aligne sur les paramètres régionaux en-US. Lorsqu’elle est accessible via une valuesAsJsonLocal propriété, cette valeur de chaîne s’aligne sur les paramètres régionaux d’affichage de l’utilisateur.
provider	Représente des informations qui décrivent l’entité ou la personne qui a fourni l’image. Ces informations peuvent être utilisées pour la personnalisation dans les cartes image.
relatedImagesAddress	Représente l’URL d’une page web avec des images qui sont considérées comme liées à ce WebImageCellValue.
type	Représente le type de cette valeur de cellule.

Détails de la propriété

address

Représente l’URL à partir de laquelle l’image sera téléchargée. Cette image doit être hébergée sur un serveur qui prend en charge HTTPS.

address: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.16 ]

Exemples

// 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

Représente le texte de remplacement qui peut être utilisé dans les scénarios d’accessibilité pour décrire ce que l’image représente.

altText?: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.16 ]

attribution

Représente les informations d’attribution pour décrire la source et les licences requises pour l’utilisation de cette image.

attribution?: CellValueAttributionAttributes[];

Valeur de propriété

Excel.CellValueAttributionAttributes[]

Remarques

[ Ensemble d’API : ExcelApi 1.16 ]

basicType

Représente la valeur qui serait retournée par Range.valueTypes pour une cellule avec cette valeur.

basicType?: RangeValueType.error | "Error";

Valeur de propriété

error | "Error"

Remarques

[ Ensemble d’API : ExcelApi 1.16 ]

basicValue

Représente la valeur qui serait retournée par Range.values pour une cellule avec cette valeur. Lorsqu’elle est accessible via une valuesAsJson propriété, cette valeur de chaîne s’aligne sur les paramètres régionaux en-US. Lorsqu’elle est accessible via une valuesAsJsonLocal propriété, cette valeur de chaîne s’aligne sur les paramètres régionaux d’affichage de l’utilisateur.

basicValue?: "#VALUE!" | string;

Valeur de propriété

"#VALUE!" | string

Remarques

[ Ensemble d’API : ExcelApi 1.16 ]

provider

Représente des informations qui décrivent l’entité ou la personne qui a fourni l’image. Ces informations peuvent être utilisées pour la personnalisation dans les cartes image.

provider?: CellValueProviderAttributes;

Valeur de propriété

Excel.CellValueProviderAttributes

Remarques

[ Ensemble d’API : ExcelApi 1.16 ]

relatedImagesAddress

Représente l’URL d’une page web avec des images qui sont considérées comme liées à ce WebImageCellValue.

relatedImagesAddress?: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.16 ]

type

Représente le type de cette valeur de cellule.

type: CellValueType.webImage | "WebImage";

Valeur de propriété

webImage | "WebImage"

Remarques

[ Ensemble d’API : ExcelApi 1.16 ]

Exemples

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