Excel.WebImageCellValue interface

Pacote:

excel

Representa o valor de uma célula que contém uma imagem baixada da Internet.

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

Propriedades

address	Representa a URL da qual a imagem será baixada. Essa imagem deve ser hospedada em um servidor que dá suporte a HTTPS.
altText	Representa o texto alternativo que pode ser usado em cenários de acessibilidade para descrever o que a imagem representa.
attribution	Representa informações de atribuição para descrever os requisitos de origem e licença para usar essa imagem.
basicType	Representa o valor que seria retornado por Range.valueTypes para uma célula com esse valor.
basicValue	Representa o valor que seria retornado por Range.values para uma célula com esse valor. Quando acessado por meio de uma valuesAsJson propriedade, esse valor de cadeia de caracteres se alinha com a localidade en-US. Quando acessado por meio de uma valuesAsJsonLocal propriedade, esse valor de cadeia de caracteres se alinha à localidade de exibição do usuário.
provider	Representa informações que descrevem a entidade ou o indivíduo que forneceu a imagem. Essas informações podem ser usadas para identidade visual em cartões de imagem.
relatedImagesAddress	Representa a URL de uma página da Web com imagens consideradas relacionadas a este WebImageCellValue.
type	Representa o tipo desse valor de célula.

Detalhes da propriedade

address

Representa a URL da qual a imagem será baixada. Essa imagem deve ser hospedada em um servidor que dá suporte a HTTPS.

address: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

Exemplos

// 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 o texto alternativo que pode ser usado em cenários de acessibilidade para descrever o que a imagem representa.

altText?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

attribution

Representa informações de atribuição para descrever os requisitos de origem e licença para usar essa imagem.

attribution?: CellValueAttributionAttributes[];

Valor da propriedade

Excel.CellValueAttributionAttributes[]

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

basicType

Representa o valor que seria retornado por Range.valueTypes para uma célula com esse valor.

basicType?: RangeValueType.error | "Error";

Valor da propriedade

error | "Error"

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

basicValue

Representa o valor que seria retornado por Range.values para uma célula com esse valor. Quando acessado por meio de uma valuesAsJson propriedade, esse valor de cadeia de caracteres se alinha com a localidade en-US. Quando acessado por meio de uma valuesAsJsonLocal propriedade, esse valor de cadeia de caracteres se alinha à localidade de exibição do usuário.

basicValue?: "#VALUE!" | string;

Valor da propriedade

"#VALUE!" | string

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

provider

Representa informações que descrevem a entidade ou o indivíduo que forneceu a imagem. Essas informações podem ser usadas para identidade visual em cartões de imagem.

provider?: CellValueProviderAttributes;

Valor da propriedade

Excel.CellValueProviderAttributes

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

relatedImagesAddress

Representa a URL de uma página da Web com imagens consideradas relacionadas a este WebImageCellValue.

relatedImagesAddress?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

type

Representa o tipo desse valor de célula.

type: CellValueType.webImage | "WebImage";

Valor da propriedade

webImage | "WebImage"

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

Exemplos

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