Excel.WebImageCellValue interface
インターネットからダウンロードしたイメージを含むセルの値を表します。
注釈
プロパティ
| address | イメージのダウンロード元となる URL を表します。 このイメージは、HTTPS をサポートするサーバーでホストされている必要があります。 |
| alt |
アクセシビリティ シナリオでイメージが表す内容を説明するために使用できる代替テキストを表します。 |
| attribution | このイメージを使用するためのソースとライセンスの要件を説明する属性情報を表します。 |
| basic |
この値を持つセルの |
| basic |
この値を持つセルの |
| provider | イメージを提供したエンティティまたは個人を表す情報を表します。 この情報は、イメージ カードのブランド化に使用できます。 |
| related |
この |
| type | このセル値の型を表します。 |
プロパティの詳細
address
イメージのダウンロード元となる URL を表します。 このイメージは、HTTPS をサポートするサーバーでホストされている必要があります。
address: string;プロパティ値
string
注釈
例
// 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
注釈
attribution
このイメージを使用するためのソースとライセンスの要件を説明する属性情報を表します。
attribution?: CellValueAttributionAttributes[];プロパティ値
注釈
basicType
この値を持つセルの Range.valueTypes によって返される値を表します。
basicType?: RangeValueType.error | "Error";プロパティ値
error | "Error"
注釈
basicValue
この値を持つセルの Range.values によって返される値を表します。
valuesAsJson プロパティを介してアクセスすると、この文字列値は en-US ロケールに合わせて調整されます。
valuesAsJsonLocal プロパティを介してアクセスすると、この文字列値はユーザーの表示ロケールと一致します。
basicValue?: "#VALUE!" | string;プロパティ値
"#VALUE!" | string
注釈
provider
イメージを提供したエンティティまたは個人を表す情報を表します。 この情報は、イメージ カードのブランド化に使用できます。
provider?: CellValueProviderAttributes;プロパティ値
注釈
relatedImagesAddress
この WebImageCellValueに関連すると見なされる画像を含む Web ページの URL を表します。
relatedImagesAddress?: string;プロパティ値
string
注釈
type
このセル値の型を表します。
type: CellValueType.webImage | "WebImage";プロパティ値
webImage | "WebImage"
注釈
例
// 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();
});
Office Add-ins