Excel.Image class
ワークシート内の画像を表します。 対応する Shape オブジェクトを取得するには、 Image.shape を使用します。
- Extends
プロパティ
| brightness | 画像の明るさを指定します。 このプロパティの値は、0.0 (最も暗い) から 1.0 (最も明るい) までの数値で指定する必要があります。 |
| color |
画像に適用される色変換の種類を指定します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| contrast | 画像のコントラストを指定します。 このプロパティの値は、0.0 (最小のコントラスト) から 1.0 (最大のコントラスト) までの数値で指定します。 |
| crop |
画像の下部から切り取られる点の数を指定します。 |
| crop |
画像の左側から切り取られる点の数を指定します。 |
| crop |
画像の右側から切り取られる点の数を指定します。 |
| crop |
画像の上部から切り取られる点の数を指定します。 |
| format | 画像の形式を返します。 |
| id | 画像オブジェクトの図形識別子を指定します。 |
| shape | 画像に関連付けられている |
メソッド
| increment |
指定した量だけ画像の明るさをインクリメントします。 |
| increment |
画像のコントラストを指定した量だけインクリメントします。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
brightness
画像の明るさを指定します。 このプロパティの値は、0.0 (最も暗い) から 1.0 (最も明るい) までの数値で指定する必要があります。
brightness: number;プロパティ値
number
注釈
colorType
画像に適用される色変換の種類を指定します。
colorType: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";プロパティ値
Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark"
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
contrast
画像のコントラストを指定します。 このプロパティの値は、0.0 (最小のコントラスト) から 1.0 (最大のコントラスト) までの数値で指定します。
contrast: number;プロパティ値
number
注釈
cropBottom
cropLeft
cropRight
cropTop
format
画像の形式を返します。
readonly format: Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG";プロパティ値
Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG"
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-images.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Shapes");
const image = sheet.shapes.getItem("Image").image;
image.load("format");
await context.sync();
console.log("The image's format is: " + image.format);
await context.sync();
});
id
shape
画像に関連付けられている Shape オブジェクトを返します。
readonly shape: Excel.Shape;プロパティ値
注釈
メソッドの詳細
incrementBrightness(increment)
指定した量だけ画像の明るさをインクリメントします。
incrementBrightness(increment: number): void;パラメーター
- increment
-
number
現在の図の明るさを示す Brightness プロパティの設定値から明るさの強弱を調整する値を指定します。 正の値を指定すると、図の明るさが強くなり、負の値を指定すると弱くなります。
返品
void
注釈
incrementContrast(increment)
画像のコントラストを指定した量だけインクリメントします。
incrementContrast(increment: number): void;パラメーター
- increment
-
number
現在の図のコントラストを示す Contrast プロパティの設定値からコントラストの強弱を調整する値を指定します。 正の値を指定するとコントラストが強くなり、負の値を指定すると弱くなります。
返品
void
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.ImageLoadOptions): Excel.Image;パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.Image;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Image;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.ImageUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Excel.Interfaces.ImageUpdateData
メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Excel.Image): void;パラメーター
- properties
- Excel.Image
返品
void
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.Image オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.ImageData と型指定) を返します。
toJSON(): Excel.Interfaces.ImageData;