Excel.ShapeFill class

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

context: RequestContext;

プロパティ値

図形の塗りつぶしの前景色を HTML カラー形式で、#RRGGBB 形式 (例: "FFA500") または名前付き HTML 色 (例: "オレンジ") で表します

foregroundColor: string;

プロパティ値

注釈

API セット: ExcelApi 1.9

塗りつぶしの透明度の割合を、0.0 (不透明) から 1.0 (クリア) までの値で指定します。 図形の種類が透明度をサポートしていない場合や、グラデーションの塗りつぶしの種類など、図形の塗りつぶしの透明度に一貫性がない場合は null を返します。

transparency: number;

プロパティ値

注釈

API セット: ExcelApi 1.9

図形の塗りつぶしの種類を返します。 詳細は「Excel.ShapeFillType」をご覧ください。

readonly type: Excel.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "Mixed";

プロパティ値

注釈

API セット: ExcelApi 1.9

この図形の塗りつぶしの書式設定をクリアします。

clear(): void;

返品

注釈

API セット: ExcelApi 1.9

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-fill-and-line-formatting.yaml

await Excel.run(async (context) => {
    // Remove the shape's fill formatting.
    const sheet = context.workbook.worksheets.getItem("Sample");
    const badge = sheet.shapes.getItem("Badge");
    const shapeFill: Excel.ShapeFill = badge.fill;
    shapeFill.clear();

    await context.sync();
});

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

load(options?: Excel.Interfaces.ShapeFillLoadOptions): Excel.ShapeFill;

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Excel.ShapeFill): void;

パラメーター

返品

図形の塗りつぶしの書式設定を均一な色に設定します。 これにより、塗りつぶしの種類が "Solid" に変更されます。

setSolidColor(color: string): void;

パラメーター

返品

注釈

API セット: ExcelApi 1.9

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-fill-and-line-formatting.yaml

await Excel.run(async (context) => {
    // Apply a solid fill color to the shape.
    const sheet = context.workbook.worksheets.getItem("Sample");
    const badge = sheet.shapes.getItem("Badge");
    const shapeFill: Excel.ShapeFill = badge.fill;
    shapeFill.setSolidColor("#FFE08A");

    await context.sync();
});

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.ShapeFill オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.ShapeFillData と型指定) を返します。

toJSON(): Excel.Interfaces.ShapeFillData;

返品