Excel.Interfaces.LineData interface

Package:

excel

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.
beginArrowheadStyle	Represents the style of the arrowhead at the beginning of the specified line.
beginArrowheadWidth	Represents the width of the arrowhead at the beginning of the specified line.
beginConnectedSite	Represents the connection site to which the beginning of a connector is connected. Returns null when the beginning of the line is not attached to any shape.
connectorType	Represents the connector type for the line.
endArrowheadLength	Represents the length of the arrowhead at the end of the specified line.
endArrowheadStyle	Represents the style of the arrowhead at the end of the specified line.
endArrowheadWidth	Represents the width of the arrowhead at the end of the specified line.
endConnectedSite	Represents the connection site to which the end of a connector is connected. Returns null when the end of the line is not attached to any shape.
id	Specifies the shape identifier.
isBeginConnected	Specifies if the beginning of the specified line is connected to a shape.
isEndConnected	Specifies if the end of the specified line is connected to a shape.

Property Details

beginArrowheadLength

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

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

Property Value

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

Remarks

[ API set: ExcelApi 1.9 ]

beginArrowheadStyle

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

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

Property Value

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

Remarks

[ API set: ExcelApi 1.9 ]

beginArrowheadWidth

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

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

Property Value

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

Remarks

[ API set: ExcelApi 1.9 ]

beginConnectedSite

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

beginConnectedSite?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.9 ]

connectorType

Represents the connector type for the line.

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

Property Value

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

Remarks

[ API set: ExcelApi 1.9 ]

endArrowheadLength

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

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

Property Value

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

Remarks

[ API set: ExcelApi 1.9 ]

endArrowheadStyle

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

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

Property Value

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

Remarks

[ API set: ExcelApi 1.9 ]

endArrowheadWidth

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

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

Property Value

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

Remarks

[ API set: ExcelApi 1.9 ]

endConnectedSite

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

endConnectedSite?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.9 ]

id

Specifies the shape identifier.

id?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.9 ]

isBeginConnected

Specifies if the beginning of the specified line is connected to a shape.

isBeginConnected?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

isEndConnected

Specifies if the end of the specified line is connected to a shape.

isEndConnected?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]