Excel.Line class

リファレンス

パッケージ:: excel

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

Extends: OfficeExtension.ClientObject

注釈

プロパティ

beginArrowheadLength	指定された線の始点の矢印の長さを表します。
beginArrowheadStyle	指定された線の始点の矢印のスタイルを表します。
beginArrowheadWidth	指定された線の始点の矢印の幅を表します。
beginConnectedShape	指定された線の始点が接続されている図形を表します。
beginConnectedSite	コネクタの始点が接続されている結合点を表します。線の先頭が図形にアタッチされていない場合に `null` を返します。
connectorType	線のコネクタの種類を表します。
context	オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。
endArrowheadLength	指定された線の終点の矢印の長さを表します。
endArrowheadStyle	指定された線の終点の矢印のスタイルを表します。
endArrowheadWidth	指定された線の終点の矢印の幅を表します。
endConnectedShape	指定された線の終点が接続されている図形を表します。
endConnectedSite	コネクタの終点が接続されている結合点を表します。線の末尾が図形にアタッチされていない場合に `null` を返します。
id	図形識別子を指定します。
isBeginConnected	指定した線の先頭が図形に接続されているかどうかを指定します。
isEndConnected	指定した線の末尾が図形に接続されているかどうかを指定します。
shape	行に関連付けられている `Shape` オブジェクトを返します。

メソッド

connectBeginShape(shape, connectionSite)	指定されたコネクタの始点を指定された図形に接続します。
connectEndShape(shape, connectionSite)	指定されたコネクタの終点を指定された図形に接続します。
disconnectBeginShape()	指定されたコネクタの始点を図形から切り離します。
disconnectEndShape()	指定されたコネクタの終点を図形から切り離します。
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.Line` オブジェクトは API オブジェクトですが、 `toJSON` メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( `Excel.Interfaces.LineData` として型指定) を返します。

プロパティの詳細

beginArrowheadLength

指定された線の始点の矢印の長さを表します。

beginArrowheadLength: Excel.ArrowheadLength | "Short" | "Medium" | "Long";

プロパティ値

Excel.ArrowheadLength | "Short" | "Medium" | "Long"

注釈

[ API セット: ExcelApi 1.9 ]

beginArrowheadStyle

指定された線の始点の矢印のスタイルを表します。

beginArrowheadStyle: Excel.ArrowheadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open";

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

beginArrowheadWidth

指定された線の始点の矢印の幅を表します。

beginArrowheadWidth: Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide";

プロパティ値

Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide"

注釈

[ API セット: ExcelApi 1.9 ]

beginConnectedShape

指定された線の始点が接続されている図形を表します。

readonly beginConnectedShape: Excel.Shape;

プロパティ値

Excel.Shape

注釈

[ API セット: ExcelApi 1.9 ]

beginConnectedSite

コネクタの始点が接続されている結合点を表します。線の先頭が図形にアタッチされていない場合に null を返します。

readonly beginConnectedSite: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.9 ]

connectorType

線のコネクタの種類を表します。

connectorType: Excel.ConnectorType | "Straight" | "Elbow" | "Curve";

プロパティ値

Excel.ConnectorType | "Straight" | "Elbow" | "Curve"

注釈

[ API セット: ExcelApi 1.9 ]

context

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

context: RequestContext;

プロパティ値

Excel.RequestContext

endArrowheadLength

指定された線の終点の矢印の長さを表します。

endArrowheadLength: Excel.ArrowheadLength | "Short" | "Medium" | "Long";

プロパティ値

Excel.ArrowheadLength | "Short" | "Medium" | "Long"

注釈

[ API セット: ExcelApi 1.9 ]

endArrowheadStyle

指定された線の終点の矢印のスタイルを表します。

endArrowheadStyle: Excel.ArrowheadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open";

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

endArrowheadWidth

指定された線の終点の矢印の幅を表します。

endArrowheadWidth: Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide";

プロパティ値

Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide"

注釈

[ API セット: ExcelApi 1.9 ]

endConnectedShape

指定された線の終点が接続されている図形を表します。

readonly endConnectedShape: Excel.Shape;

プロパティ値

Excel.Shape

注釈

[ API セット: ExcelApi 1.9 ]

endConnectedSite

コネクタの終点が接続されている結合点を表します。線の末尾が図形にアタッチされていない場合に null を返します。

readonly endConnectedSite: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.9 ]

id

図形識別子を指定します。

readonly id: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.9 ]

isBeginConnected

指定した線の先頭が図形に接続されているかどうかを指定します。

readonly isBeginConnected: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

isEndConnected

指定した線の末尾が図形に接続されているかどうかを指定します。

readonly isEndConnected: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

shape

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

readonly shape: Excel.Shape;

プロパティ値

Excel.Shape

注釈

[ API セット: ExcelApi 1.9 ]

メソッドの詳細

connectBeginShape(shape, connectionSite)

指定されたコネクタの始点を指定された図形に接続します。

connectBeginShape(shape: Excel.Shape, connectionSite: number): void;

パラメーター

shape: Excel.Shape

接続する図形。

connectionSite: number

コネクタの先頭が接続されている図形上の接続サイト。 0 (包括) から指定した図形の接続サイト数 (排他) の整数である必要があります。

戻り値

void

注釈

[ API セット: ExcelApi 1.9 ]

例

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

await Excel.run(async (context) => {
    const shapes = context.workbook.worksheets.getItem("Shapes").shapes;
    const line = shapes.getItem("StraightLine").line;
    line.connectBeginShape(shapes.getItem("Left"), 2);
    line.connectEndShape(shapes.getItem("Right"), 0);
    await context.sync();
});

connectEndShape(shape, connectionSite)

指定されたコネクタの終点を指定された図形に接続します。

connectEndShape(shape: Excel.Shape, connectionSite: number): void;

パラメーター

shape: Excel.Shape

接続する図形。

connectionSite: number

コネクタの末尾が接続されている図形上の接続サイト。 0 (包括) から指定した図形の接続サイト数 (排他) の整数である必要があります。

戻り値

void

注釈

[ API セット: ExcelApi 1.9 ]

例

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

await Excel.run(async (context) => {
    const shapes = context.workbook.worksheets.getItem("Shapes").shapes;
    const line = shapes.getItem("StraightLine").line;
    line.connectBeginShape(shapes.getItem("Left"), 2);
    line.connectEndShape(shapes.getItem("Right"), 0);
    await context.sync();
});

disconnectBeginShape()

指定されたコネクタの始点を図形から切り離します。

disconnectBeginShape(): void;

戻り値

void

注釈

[ API セット: ExcelApi 1.9 ]

例

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

await Excel.run(async (context) => {
    const shapes = context.workbook.worksheets.getItem("Shapes").shapes;
    const line = shapes.getItem("StraightLine").line;
    line.disconnectBeginShape();
    line.disconnectEndShape();
    await context.sync();
});

disconnectEndShape()

指定されたコネクタの終点を図形から切り離します。

disconnectEndShape(): void;

戻り値

void

注釈

[ API セット: ExcelApi 1.9 ]

例

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

await Excel.run(async (context) => {
    const shapes = context.workbook.worksheets.getItem("Shapes").shapes;
    const line = shapes.getItem("StraightLine").line;
    line.disconnectBeginShape();
    line.disconnectEndShape();
    await context.sync();
});

load(options)

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

load(options?: Excel.Interfaces.LineLoadOptions): Excel.Line;

パラメーター

options: Excel.Interfaces.LineLoadOptions

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

戻り値

Excel.Line

load(propertyNames)

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

パラメーター

propertyNames: string | string[]

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

戻り値

Excel.Line

load(propertyNamesAndPaths)

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

パラメーター

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

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

戻り値

Excel.Line

set(properties, options)

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

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

パラメーター

properties: Excel.Interfaces.LineUpdateData

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

options: OfficeExtension.UpdateOptions

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

戻り値

void

set(properties)

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

set(properties: Excel.Line): void;

パラメーター

properties: Excel.Line

戻り値

void

toJSON()

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

toJSON(): Excel.Interfaces.LineData;

戻り値

Excel.Interfaces.LineData

次の方法で共有

Excel.Line class

注釈

プロパティ

メソッド

プロパティの詳細

beginArrowheadLength

プロパティ値

注釈

beginArrowheadStyle

プロパティ値

注釈

beginArrowheadWidth

プロパティ値

注釈

beginConnectedShape

プロパティ値

注釈

beginConnectedSite

プロパティ値

注釈

connectorType

プロパティ値

注釈

context

プロパティ値

endArrowheadLength

プロパティ値

注釈

endArrowheadStyle

プロパティ値

注釈

endArrowheadWidth

プロパティ値

注釈

endConnectedShape

プロパティ値

注釈

endConnectedSite

プロパティ値

注釈

id

プロパティ値

注釈

isBeginConnected

プロパティ値

注釈

isEndConnected

プロパティ値

注釈

shape

プロパティ値

注釈

メソッドの詳細

connectBeginShape(shape, connectionSite)

パラメーター

戻り値

注釈

例

connectEndShape(shape, connectionSite)

パラメーター

戻り値

注釈

例

disconnectBeginShape()

戻り値

注釈

例

disconnectEndShape()

戻り値

注釈

例

load(options)

パラメーター

戻り値

load(propertyNames)

パラメーター

戻り値

load(propertyNamesAndPaths)

パラメーター