Excel.Interfaces.LineData interface

An interface describing the data returned by calling line.toJSON().

Properties

beginArrowheadLength

Represents the length of the arrowhead at the beginning of the specified line.

[ API set: ExcelApi 1.9 ]

beginArrowheadStyle

Represents the style of the arrowhead at the beginning of the specified line.

[ API set: ExcelApi 1.9 ]

beginArrowheadWidth

Represents the width of the arrowhead at the beginning of the specified line.

[ API set: ExcelApi 1.9 ]

beginConnectedSite

Represents the connection site to which the beginning of a connector is connected. Read-only. Returns null when the beginning of the line is not attached to any shape.

[ API set: ExcelApi 1.9 ]

connectorType

Represents the connector type for the line.

[ API set: ExcelApi 1.9 ]

endArrowheadLength

Represents the length of the arrowhead at the end of the specified line.

[ API set: ExcelApi 1.9 ]

endArrowheadStyle

Represents the style of the arrowhead at the end of the specified line.

[ API set: ExcelApi 1.9 ]

endArrowheadWidth

Represents the width of the arrowhead at the end of the specified line.

[ API set: ExcelApi 1.9 ]

endConnectedSite

Represents the connection site to which the end of a connector is connected. Read-only. Returns null when the end of the line is not attached to any shape.

[ API set: ExcelApi 1.9 ]

id

Represents the shape identifier. Read-only.

[ API set: ExcelApi 1.9 ]

isBeginConnected

Specifies whether or not the beginning of the specified line is connected to a shape. Read-only.

[ API set: ExcelApi 1.9 ]

isEndConnected

Specifies whether or not the end of the specified line is connected to a shape. Read-only.

[ API set: ExcelApi 1.9 ]

Property Details

beginArrowheadLength

Represents the length of the arrowhead at the beginning of the specified line.

[ API set: ExcelApi 1.9 ]

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

Property Value

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

beginArrowheadStyle

Represents the style of the arrowhead at the beginning of the specified line.

[ API set: ExcelApi 1.9 ]

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

Property Value

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

beginArrowheadWidth

Represents the width of the arrowhead at the beginning of the specified line.

[ API set: ExcelApi 1.9 ]

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

Property Value

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

beginConnectedSite

Represents the connection site to which the beginning of a connector is connected. Read-only. Returns null when the beginning of the line is not attached to any shape.

[ API set: ExcelApi 1.9 ]

beginConnectedSite?: number;

Property Value

number

connectorType

Represents the connector type for the line.

[ API set: ExcelApi 1.9 ]

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

Property Value

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

endArrowheadLength

Represents the length of the arrowhead at the end of the specified line.

[ API set: ExcelApi 1.9 ]

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

Property Value

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

endArrowheadStyle

Represents the style of the arrowhead at the end of the specified line.

[ API set: ExcelApi 1.9 ]

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

Property Value

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

endArrowheadWidth

Represents the width of the arrowhead at the end of the specified line.

[ API set: ExcelApi 1.9 ]

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

Property Value

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

endConnectedSite

Represents the connection site to which the end of a connector is connected. Read-only. Returns null when the end of the line is not attached to any shape.

[ API set: ExcelApi 1.9 ]

endConnectedSite?: number;

Property Value

number

id

Represents the shape identifier. Read-only.

[ API set: ExcelApi 1.9 ]

id?: string;

Property Value

string

isBeginConnected

Specifies whether or not the beginning of the specified line is connected to a shape. Read-only.

[ API set: ExcelApi 1.9 ]

isBeginConnected?: boolean;

Property Value

boolean

isEndConnected

Specifies whether or not the end of the specified line is connected to a shape. Read-only.

[ API set: ExcelApi 1.9 ]

isEndConnected?: boolean;

Property Value

boolean