Excel.ShapeLineFormat class
図形オブジェクトの線の書式設定を表します。 画像や幾何学的図形の場合、線の書式設定は図形の境界を表します。
- Extends
プロパティ
| color | 線の色を HTML カラー形式で、#RRGGBB 形式 ("FFA500" など) または名前付き HTML 色 ("オレンジ" など) で表します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| dash |
図形の線スタイルを表します。 線が表示されていない場合、または破線のスタイルに一貫性がない場合に |
| style | 図形の線スタイルを表します。 線が表示されていない場合、またはスタイルに一貫性がない場合に |
| transparency | 指定された線の透明度を示す 0.0 (不透明) から 1.0 (透明) までの値を表します。 図形の透明度が均一でない場合に |
| visible | 図形要素の線の書式設定を表示するかどうかを指定します。 図形の表示に一貫性がない場合に |
| weight | 線の太さ (ポイント数) を表します。 線が表示されていない場合、または線の太さが均一でない場合に |
メソッド
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
color
線の色を HTML カラー形式で、#RRGGBB 形式 ("FFA500" など) または名前付き HTML 色 ("オレンジ" など) で表します。
color: string;プロパティ値
string
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
dashStyle
図形の線スタイルを表します。 線が表示されていない場合、または破線のスタイルに一貫性がない場合に null を返します。 詳細は「Excel.ShapeLineDashStyle」をご覧ください。
dashStyle: Excel.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";プロパティ値
Excel.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot"
注釈
style
図形の線スタイルを表します。 線が表示されていない場合、またはスタイルに一貫性がない場合に null を返します。 詳細は「Excel.ShapeLineStyle」をご覧ください。
style: Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";プロパティ値
Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin"
注釈
transparency
指定された線の透明度を示す 0.0 (不透明) から 1.0 (透明) までの値を表します。 図形の透明度が均一でない場合に null を返します。
transparency: number;プロパティ値
number
注釈
visible
図形要素の線の書式設定を表示するかどうかを指定します。 図形の表示に一貫性がない場合に null を返します。
visible: boolean;プロパティ値
boolean
注釈
例
// 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) => {
// Hide the shape's outline.
const sheet = context.workbook.worksheets.getItem("Sample");
const badge = sheet.shapes.getItem("Badge");
const lineFormat: Excel.ShapeLineFormat = badge.lineFormat;
lineFormat.visible = false;
await context.sync();
});
weight
線の太さ (ポイント数) を表します。 線が表示されていない場合、または線の太さが均一でない場合に null を返します。
weight: number;プロパティ値
number
注釈
メソッドの詳細
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.ShapeLineFormatLoadOptions): Excel.ShapeLineFormat;パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.ShapeLineFormat;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ShapeLineFormat;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.ShapeLineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Excel.Interfaces.ShapeLineFormatUpdateData
メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Excel.ShapeLineFormat): void;パラメーター
- properties
- Excel.ShapeLineFormat
返品
void
例
// 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 outline formatting to the shape.
const sheet = context.workbook.worksheets.getItem("Sample");
const badge = sheet.shapes.getItem("Badge");
const lineFormat: Excel.ShapeLineFormat = badge.lineFormat;
lineFormat.set({
color: "#C55A11",
dashStyle: Excel.ShapeLineDashStyle.dashDotDot,
style: Excel.ShapeLineStyle.thinThick,
transparency: 0.2,
visible: true,
weight: 4
});
await context.sync();
});
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.ShapeLineFormat オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.ShapeLineFormatData と型指定) を返します。
toJSON(): Excel.Interfaces.ShapeLineFormatData;