Excel.Image class

パッケージ:: excel

ワークシート内のイメージを表します。対応する Shape オブジェクトを取得するには、 Image.shapeを使用します。

Extends: OfficeExtension.ClientObject

注釈

プロパティ

brightness	イメージの明るさを指定します。このプロパティの値は、0.0 (最も暗い) から 1.0 (最も明るい) までの数値で指定する必要があります。
colorType	イメージに適用される色変換の種類を指定します。
context	オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。
contrast	イメージのコントラストを指定します。このプロパティの値は、0.0 (最小のコントラスト) から 1.0 (最大のコントラスト) までの数値で指定します。
cropBottom	画像の下部からトリミングされるポイントの数を指定します。
cropLeft	イメージの左側からトリミングされるポイントの数を指定します。
cropRight	イメージの右側からトリミングされるポイントの数を指定します。
cropTop	画像の上部からトリミングされるポイントの数を指定します。
format	画像の形式を返します。
id	イメージオブジェクトの図形識別子を指定します。
shape	イメージに関連付けられている `Shape` オブジェクトを返します。

メソッド

incrementBrightness(increment)	指定した量だけ画像の明るさをインクリメントします。
incrementContrast(increment)	指定した量だけイメージのコントラストをインクリメントします。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
set(properties, options)	オブジェクトの複数のプロパティを同時に設定します。適切なプロパティを持つプレーンオブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties)	既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
toJSON()	API オブジェクトが`JSON.stringify()`に渡されたときにより便利な出力を提供するために、JavaScript `toJSON()` メソッドをオーバーライドします。 (`JSON.stringify`、それに渡されるオブジェクトの `toJSON` メソッドを呼び出します)。元の `Excel.Image` オブジェクトは API オブジェクトですが、 `toJSON` メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( `Excel.Interfaces.ImageData` として型指定) を返します。

プロパティの詳細

brightness

イメージの明るさを指定します。このプロパティの値は、0.0 (最も暗い) から 1.0 (最も明るい) までの数値で指定する必要があります。

brightness: number;

プロパティ値

number

注釈

[ API セット: ExcelApiDesktop 1.1 ]

colorType

イメージに適用される色変換の種類を指定します。

colorType: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";

プロパティ値

注釈

[ API セット: ExcelApiDesktop 1.1 ]

context

オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

Excel.RequestContext

contrast

イメージのコントラストを指定します。このプロパティの値は、0.0 (最小のコントラスト) から 1.0 (最大のコントラスト) までの数値で指定します。

contrast: number;

プロパティ値

number

注釈

[ API セット: ExcelApiDesktop 1.1 ]

cropBottom

画像の下部からトリミングされるポイントの数を指定します。

cropBottom: number;

プロパティ値

number

注釈

[ API セット: ExcelApiDesktop 1.1 ]

cropLeft

イメージの左側からトリミングされるポイントの数を指定します。

cropLeft: number;

プロパティ値

number

注釈

[ API セット: ExcelApiDesktop 1.1 ]

cropRight

イメージの右側からトリミングされるポイントの数を指定します。

cropRight: number;

プロパティ値

number

注釈

[ API セット: ExcelApiDesktop 1.1 ]

cropTop

画像の上部からトリミングされるポイントの数を指定します。

cropTop: number;

プロパティ値

number

注釈

[ API セット: ExcelApiDesktop 1.1 ]

format

画像の形式を返します。

readonly format: Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG";

プロパティ値

Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG"

注釈

[ API セット: ExcelApi 1.9 ]

例

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

イメージオブジェクトの図形識別子を指定します。

readonly id: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.9 ]

shape

イメージに関連付けられている Shape オブジェクトを返します。

readonly shape: Excel.Shape;

プロパティ値

Excel.Shape

注釈

[ API セット: ExcelApi 1.9 ]

メソッドの詳細

incrementBrightness(increment)

指定した量だけ画像の明るさをインクリメントします。

incrementBrightness(increment: number): void;

パラメーター

increment: number

現在の図の明るさを示す Brightness プロパティの設定値から明るさの強弱を調整する値を指定します。正の値を指定すると、図の明るさが強くなり、負の値を指定すると弱くなります。

戻り値

void

注釈

[ API セット: ExcelApiDesktop 1.1 ]

incrementContrast(increment)

指定した量だけイメージのコントラストをインクリメントします。

incrementContrast(increment: number): void;

パラメーター

increment: number

現在の図のコントラストを示す Contrast プロパティの設定値からコントラストの強弱を調整する値を指定します。正の値を指定するとコントラストが強くなり、負の値を指定すると弱くなります。

戻り値

void

注釈

[ API セット: ExcelApiDesktop 1.1 ]

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Excel.Interfaces.ImageLoadOptions): Excel.Image;

パラメーター

options: Excel.Interfaces.ImageLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

Excel.Image

load(propertyNames)

load(propertyNames?: string | string[]): Excel.Image;

パラメーター

propertyNames: string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

Excel.Image

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Image;

パラメーター

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。

戻り値

Excel.Image

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。適切なプロパティを持つプレーンオブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.ImageUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

properties: Excel.Interfaces.ImageUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options: OfficeExtension.UpdateOptions

properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

戻り値

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;

戻り値

Excel.Interfaces.ImageData

フィードバック

このページはお役に立ちましたか?

次の方法で共有

Excel.Image class

注釈

プロパティ

メソッド

プロパティの詳細

brightness

プロパティ値

注釈

colorType

プロパティ値

注釈

context

プロパティ値

contrast

プロパティ値

注釈

cropBottom

プロパティ値

注釈

cropLeft

プロパティ値

注釈

cropRight

プロパティ値

注釈

cropTop

プロパティ値

注釈

format

プロパティ値

注釈

例

id

プロパティ値

注釈

shape

プロパティ値

注釈

メソッドの詳細

incrementBrightness(increment)

パラメーター

戻り値

注釈

incrementContrast(increment)

パラメーター

戻り値

注釈

load(options)

パラメーター

戻り値

load(propertyNames)

パラメーター

戻り値

load(propertyNamesAndPaths)

パラメーター

戻り値

set(properties, options)

パラメーター

戻り値

set(properties)

パラメーター

戻り値

toJSON()

戻り値

フィードバック