Excel.Line class

ワークシート内の行を表します。Represents a line inside a worksheet. 対応する Shape オブジェクトを取得するには、Line.shapeTo get the corresponding Shape object, use Line.shape.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

Extends

プロパティ

beginArrowheadLength

指定された線の始点の矢印の長さを表します。Represents the length of the arrowhead at the beginning of the specified line.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

beginArrowheadStyle

指定された線の始点の矢印のスタイルを表します。Represents the style of the arrowhead at the beginning of the specified line.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

beginArrowheadWidth

指定された線の始点の矢印の幅を表します。Represents the width of the arrowhead at the beginning of the specified line.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

beginConnectedShape

指定された線の始点が接続されている図形を表します。Represents the shape to which the beginning of the specified line is attached. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

beginConnectedSite

コネクタの始点が接続されている結合点を表します。Represents the connection site to which the beginning of a connector is connected. 読み取り専用です。Read-only. 線の始点がどの図形にも接続されていない場合は、null を返します。Returns null when the beginning of the line is not attached to any shape.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

connectorType

線のコネクタの種類を表します。Represents the connector type for the line.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

endArrowheadLength

指定された線の終点の矢印の長さを表します。Represents the length of the arrowhead at the end of the specified line.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

endArrowheadStyle

指定された線の終点の矢印のスタイルを表します。Represents the style of the arrowhead at the end of the specified line.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

endArrowheadWidth

指定された線の終点の矢印の幅を表します。Represents the width of the arrowhead at the end of the specified line.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

endConnectedShape

指定された線の終点が接続されている図形を表します。Represents the shape to which the end of the specified line is attached. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

endConnectedSite

コネクタの終点が接続されている結合点を表します。Represents the connection site to which the end of a connector is connected. 読み取り専用です。Read-only. 線の終点がどの図形にも接続されていない場合は、null を返します。Returns null when the end of the line is not attached to any shape.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

id

図形 ID を表します。Represents the shape identifier. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

isBeginConnected

指定された線の始点が図形に接続されているかどうかを指定します。Specifies whether or not the beginning of the specified line is connected to a shape. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

isEndConnected

指定された線の終点が図形に接続されているかどうかを指定します。Specifies whether or not the end of the specified line is connected to a shape. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

shape

線に関連付けられた Shape オブジェクトを返します。Returns the Shape object associated with the line. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

メソッド

connectBeginShape(shape, connectionSite)

指定されたコネクタの始点を指定された図形に接続します。Attaches the beginning of the specified connector to a specified shape.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

connectEndShape(shape, connectionSite)

指定されたコネクタの終点を指定された図形に接続します。Attaches the end of the specified connector to a specified shape.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

disconnectBeginShape()

指定されたコネクタの始点を図形から切り離します。Detaches the beginning of the specified connector from a shape.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

disconnectEndShape()

指定されたコネクタの終点を図形から切り離します。Detaches the end of the specified connector from a shape.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の Excel の Line オブジェクトは API オブジェクトであるのにtoJSON対して、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.LineData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.Line object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.LineData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

プロパティの詳細

beginArrowheadLength

指定された線の始点の矢印の長さを表します。Represents the length of the arrowhead at the beginning of the specified line.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

プロパティ値

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

beginArrowheadStyle

指定された線の始点の矢印のスタイルを表します。Represents the style of the arrowhead at the beginning of the specified line.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

プロパティ値

Excel.ArrowheadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open"

beginArrowheadWidth

指定された線の始点の矢印の幅を表します。Represents the width of the arrowhead at the beginning of the specified line.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

プロパティ値

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

beginConnectedShape

指定された線の始点が接続されている図形を表します。Represents the shape to which the beginning of the specified line is attached. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly beginConnectedShape: Excel.Shape;

プロパティ値

beginConnectedSite

コネクタの始点が接続されている結合点を表します。Represents the connection site to which the beginning of a connector is connected. 読み取り専用です。Read-only. 線の始点がどの図形にも接続されていない場合は、null を返します。Returns null when the beginning of the line is not attached to any shape.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly beginConnectedSite: number;

プロパティ値

number

connectorType

線のコネクタの種類を表します。Represents the connector type for the line.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

プロパティ値

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

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

context: RequestContext;

プロパティ値

RequestContext

endArrowheadLength

指定された線の終点の矢印の長さを表します。Represents the length of the arrowhead at the end of the specified line.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

プロパティ値

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

endArrowheadStyle

指定された線の終点の矢印のスタイルを表します。Represents the style of the arrowhead at the end of the specified line.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

プロパティ値

Excel.ArrowheadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open"

endArrowheadWidth

指定された線の終点の矢印の幅を表します。Represents the width of the arrowhead at the end of the specified line.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

プロパティ値

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

endConnectedShape

指定された線の終点が接続されている図形を表します。Represents the shape to which the end of the specified line is attached. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly endConnectedShape: Excel.Shape;

プロパティ値

endConnectedSite

コネクタの終点が接続されている結合点を表します。Represents the connection site to which the end of a connector is connected. 読み取り専用です。Read-only. 線の終点がどの図形にも接続されていない場合は、null を返します。Returns null when the end of the line is not attached to any shape.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly endConnectedSite: number;

プロパティ値

number

id

図形 ID を表します。Represents the shape identifier. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly id: string;

プロパティ値

string

isBeginConnected

指定された線の始点が図形に接続されているかどうかを指定します。Specifies whether or not the beginning of the specified line is connected to a shape. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly isBeginConnected: boolean;

プロパティ値

boolean

isEndConnected

指定された線の終点が図形に接続されているかどうかを指定します。Specifies whether or not the end of the specified line is connected to a shape. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly isEndConnected: boolean;

プロパティ値

boolean

shape

線に関連付けられた Shape オブジェクトを返します。Returns the Shape object associated with the line. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly shape: Excel.Shape;

プロパティ値

メソッドの詳細

connectBeginShape(shape, connectionSite)

指定されたコネクタの始点を指定された図形に接続します。Attaches the beginning of the specified connector to a specified shape.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

パラメーター

shape
Excel.Shape

接続する図形を示します。The shape to connect.

connectionSite
number

コネクタの始点が接続される図形の接続サイトです。The connection site on the shape to which the beginning of the connector is attached. 指定した図形の 0 (両端を含む) と、指定した図形の接続サイト数 (排他) の間の整数である必要があります。Must be an integer between 0 (inclusive) and the connection-site count of the specified shape (exclusive).

戻り値

void

Examples

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)

指定されたコネクタの終点を指定された図形に接続します。Attaches the end of the specified connector to a specified shape.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

パラメーター

shape
Excel.Shape

接続する図形を示します。The shape to connect.

connectionSite
number

コネクタの終点が接続されている図形の接続サイトを指定します。The connection site on the shape to which the end of the connector is attached. 指定した図形の 0 (両端を含む) と、指定した図形の接続サイト数 (排他) の間の整数である必要があります。Must be an integer between 0 (inclusive) and the connection-site count of the specified shape (exclusive).

戻り値

void

Examples

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()

指定されたコネクタの始点を図形から切り離します。Detaches the beginning of the specified connector from a shape.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

disconnectBeginShape(): void;

戻り値

void

Examples

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()

指定されたコネクタの終点を図形から切り離します。Detaches the end of the specified connector from a shape.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

disconnectEndShape(): void;

戻り値

void

Examples

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(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

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

パラメーター

戻り値

注釈

このシグネチャに加えて、このメソッドのシグネチャは次のとおりです。In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.Line-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.Line - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.Line-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.Line - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Line-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.Line - Only available on collection types. これは、前述の署名に似ています。It is similar to the preceding signature. Top は、結果に含めることができるコレクション項目の最大数を指定します。Option.top specifies the maximum number of collection items that can be included in the result. 省略すると、スキップされ、結果に含まれないアイテムの数を指定します。Option.skip specifies the number of items that are to be skipped and not included in the result. Option を指定すると、指定した数のアイテムをスキップした後に結果セットが開始されます。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

propertyNames
string | string[]

読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列。A comma-delimited string or an array of strings that specify the properties to load.

戻り値

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

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

ここで、は、読み込むプロパティを指定するコンマで区切られた文字列を指定します。 expand は、読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

戻り値

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

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

パラメーター

properties
Interfaces.LineUpdateData

メソッドが呼び出されるオブジェクトのプロパティに構造化 isomorphically されているプロパティを持つ JavaScript オブジェクト。A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

プロパティオブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。Provides an option to suppress errors if the properties object tries to set any read-only properties.

戻り値

void

注釈

このメソッドには、次の追加のシグネチャがあります。This method has the following additional signature:

set(properties: Excel.Line): void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.Line): void;

パラメーター

properties
Excel.Line

戻り値

void

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の Excel の Line オブジェクトは API オブジェクトであるのにtoJSON対して、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.LineData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.Line object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.LineData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.LineData;

戻り値