Excel.WebImageCellValue interface

Пакет:
excel

Представляет значение ячейки, содержащей изображение, скачанное из Интернета.

Комментарии

Набор 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 = (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();
});