Share via

Excel.WebImageCellValue interface

  • 参考
包:
excel

表示包含从 Internet 下载的图像的单元格的值。

注解

[ API 集：ExcelApi 1.16 ]

属性

address

表示将从中下载图像的 URL。 此映像必须托管在支持 HTTPS 的服务器上。
altText

表示可在辅助功能方案中用于描述图像所表示内容的备用文本。
attribution

表示属性信息，用于描述使用此映像的源和许可证要求。
basicType

表示将为具有此值的单元格返回 Range.valueTypes 的值。
basicValue

表示将为具有此值的单元格返回 Range.values 的值。 通过 valuesAsJson 属性访问时，此字符串值与 en-US 区域设置一致。 通过 valuesAsJsonLocal 属性访问时，此字符串值与用户的显示区域设置一致。
provider

表示描述提供图像的实体或个人的信息。 此信息可用于图像卡中的品牌打造。
relatedImagesAddress

表示网页的 URL，其中包含被视为与此 WebImageCellValue相关的图像。
type

表示此单元格值的类型。

属性详细信息

address

表示将从中下载图像的 URL。 此映像必须托管在支持 HTTPS 的服务器上。

address: string;

属性值

string

注解

[ API 集：ExcelApi 1.16 ]

示例

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

表示可在辅助功能方案中用于描述图像所表示内容的备用文本。

altText?: string;

属性值

string

注解

[ API 集：ExcelApi 1.16 ]

attribution

表示属性信息，用于描述使用此映像的源和许可证要求。

attribution?: CellValueAttributionAttributes[];

属性值

Excel.CellValueAttributionAttributes[]

注解

[ API 集：ExcelApi 1.16 ]

basicType

表示将为具有此值的单元格返回 Range.valueTypes 的值。

basicType?: RangeValueType.error | "Error";

属性值

error | "Error"

注解

[ API 集：ExcelApi 1.16 ]

basicValue

表示将为具有此值的单元格返回 Range.values 的值。 通过 valuesAsJson 属性访问时，此字符串值与 en-US 区域设置一致。 通过 valuesAsJsonLocal 属性访问时，此字符串值与用户的显示区域设置一致。

basicValue?: "#VALUE!" | string;

属性值

"#VALUE!" | string

注解

[ API 集：ExcelApi 1.16 ]

provider

表示描述提供图像的实体或个人的信息。 此信息可用于图像卡中的品牌打造。

provider?: CellValueProviderAttributes;

属性值

Excel.CellValueProviderAttributes

注解

[ API 集：ExcelApi 1.16 ]

relatedImagesAddress

表示网页的 URL，其中包含被视为与此 WebImageCellValue相关的图像。

relatedImagesAddress?: string;

属性值

string

注解

[ API 集：ExcelApi 1.16 ]

type

表示此单元格值的类型。

type: CellValueType.webImage | "WebImage";

属性值

webImage | "WebImage"

注解

[ API 集：ExcelApi 1.16 ]

示例

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