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