Excel.Line class

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

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

Property Value

Remarks

[ API set: ExcelApi 1.9 ]

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

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

Property Value

Remarks

[ API set: ExcelApi 1.9 ]

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

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

Property Value

Remarks

[ API set: ExcelApi 1.9 ]

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

readonly beginConnectedShape: Excel.Shape;

Property Value

Remarks

[ API set: ExcelApi 1.9 ]

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.

readonly beginConnectedSite: number;

Property Value

Remarks

[ API set: ExcelApi 1.9 ]

Represents the connector type for the line.

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

Property Value

Remarks

[ API set: ExcelApi 1.9 ]

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

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

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

Property Value

Remarks

[ API set: ExcelApi 1.9 ]

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

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

Property Value

Remarks

[ API set: ExcelApi 1.9 ]

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

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

Property Value

Remarks

[ API set: ExcelApi 1.9 ]

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

readonly endConnectedShape: Excel.Shape;

Property Value

Remarks

[ API set: ExcelApi 1.9 ]

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.

readonly endConnectedSite: number;

Property Value

Remarks

[ API set: ExcelApi 1.9 ]

Specifies the shape identifier.

readonly id: string;

Property Value

Remarks

[ API set: ExcelApi 1.9 ]

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

readonly isBeginConnected: boolean;

Property Value

Remarks

[ API set: ExcelApi 1.9 ]

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

readonly isEndConnected: boolean;

Property Value

Remarks

[ API set: ExcelApi 1.9 ]

Returns the Shape object associated with the line.

readonly shape: Excel.Shape;

Property Value

Remarks

[ API set: ExcelApi 1.9 ]

Attaches the beginning of the specified connector to a specified shape.

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

Parameters

Returns

Remarks

[ API set: ExcelApi 1.9 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-lines.yaml

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

Attaches the end of the specified connector to a specified shape.

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

Parameters

Returns

Remarks

[ API set: ExcelApi 1.9 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-lines.yaml

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

Detaches the beginning of the specified connector from a shape.

disconnectBeginShape(): void;

Returns

Remarks

[ API set: ExcelApi 1.9 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-lines.yaml

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

Detaches the end of the specified connector from a shape.

disconnectEndShape(): void;

Returns

Remarks

[ API set: ExcelApi 1.9 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-lines.yaml

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

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

Returns

Sets multiple properties of an object at the same time. 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;

Parameters

Returns

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.Line): void;

Parameters

Returns

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's 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;

Returns