Excel.Interfaces.LineLoadOptions interface

Package:

excel

Represents a line inside a worksheet. To get the corresponding Shape object, use Line.shape.

Remarks

[ API set: ExcelApi 1.9 ]

Properties

$all	Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
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.
beginConnectedShape	Represents the shape to which the beginning of the specified line is attached.
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.
endConnectedShape	Represents the shape to which the end of the specified line is attached.
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.
shape	Returns the Shape object associated with the line.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

TypeScript

$all?: boolean;

Property Value

boolean

beginArrowheadLength

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

TypeScript

beginArrowheadLength?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

beginArrowheadStyle

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

TypeScript

beginArrowheadStyle?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

beginArrowheadWidth

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

TypeScript

beginArrowheadWidth?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

beginConnectedShape

Represents the shape to which the beginning of the specified line is attached.

TypeScript

beginConnectedShape?: Excel.Interfaces.ShapeLoadOptions;

Property Value

Excel.Interfaces.ShapeLoadOptions

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.

TypeScript

beginConnectedSite?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

connectorType

Represents the connector type for the line.

TypeScript

connectorType?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

endArrowheadLength

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

TypeScript

endArrowheadLength?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

endArrowheadStyle

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

TypeScript

endArrowheadStyle?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

endArrowheadWidth

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

TypeScript

endArrowheadWidth?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

endConnectedShape

Represents the shape to which the end of the specified line is attached.

TypeScript

endConnectedShape?: Excel.Interfaces.ShapeLoadOptions;

Property Value

Excel.Interfaces.ShapeLoadOptions

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.

TypeScript

endConnectedSite?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

id

Specifies the shape identifier.

TypeScript

id?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

isBeginConnected

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

TypeScript

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.

TypeScript

isEndConnected?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

shape

Returns the Shape object associated with the line.

TypeScript

shape?: Excel.Interfaces.ShapeLoadOptions;

Property Value

Excel.Interfaces.ShapeLoadOptions

Remarks

[ API set: ExcelApi 1.9 ]