Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

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

Used by

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

$all?: boolean;

Property Value

boolean

beginArrowheadLength

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

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.

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.

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.

beginConnectedShape?: Excel.Interfaces.ShapeLoadOptions;

Property Value

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?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi 1.9

connectorType

Represents the connector type for the line.

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.

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.

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.

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.

endConnectedShape?: Excel.Interfaces.ShapeLoadOptions;

Property Value

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?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi 1.9

id

Specifies the shape identifier.

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.

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

shape

Returns the Shape object associated with the line.

shape?: Excel.Interfaces.ShapeLoadOptions;

Property Value

Remarks

API set: ExcelApi 1.9

Feedback

Was this page helpful?