Excel.Line class

  • 参考
包:
excel

表示工作表中的一行。 若要获取相应的 Shape 对象，请使用 Line.shape。

Extends
OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.9 ]

属性

beginArrowheadLength

表示指定线条始端的箭头长度。
beginArrowheadStyle

表示指定线条始端的箭头样式。
beginArrowheadWidth

表示指定线条始端的箭头宽度。
beginConnectedShape

表示指定线条始端所附加到的形状。
beginConnectedSite

表示连接线始端所连接的连接站点。 null当线条的开头未附加到任何形状时返回 。
connectorType

表示线条的连接器类型。
context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
endArrowheadLength

表示指定线条末端的箭头长度。
endArrowheadStyle

表示指定线条末端的箭头样式。
endArrowheadWidth

表示指定线条末端的箭头宽度。
endConnectedShape

表示指定线条末端所附加到的形状。
endConnectedSite

表示连接线末端所连接的连接站点。 null当线条的末尾未附加到任何形状时返回 。
id

指定形状标识符。
isBeginConnected

指定指定线条的开头是否连接到形状。
isEndConnected

指定指定线条的末尾是否连接到形状。
shape

返回与 Shape 行关联的 对象。

方法

connectBeginShape(shape, connectionSite)

将指定连接线的始端附加到指定形状。
connectEndShape(shape, connectionSite)

将指定连接线的末端附加到指定形状。
disconnectBeginShape()

使指定连接线的始端与形状脱离。
disconnectEndShape()

使指定连接线的末端与形状脱离。
load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties)

基于现有的已加载对象，同时对对象设置多个属性。
toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 而原始 Excel.Line 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.LineData) ，其中包含原始对象中加载的任何子属性的浅表副本。

属性详细信息

beginArrowheadLength

表示指定线条始端的箭头长度。

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

属性值

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

注解

[ API 集：ExcelApi 1.9 ]

beginArrowheadStyle

表示指定线条始端的箭头样式。

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

属性值

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

注解

[ API 集：ExcelApi 1.9 ]

beginArrowheadWidth

表示指定线条始端的箭头宽度。

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

属性值

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

注解

[ API 集：ExcelApi 1.9 ]

beginConnectedShape

表示指定线条始端所附加到的形状。

readonly beginConnectedShape: Excel.Shape;

属性值

Excel.Shape

注解

[ API 集：ExcelApi 1.9 ]

beginConnectedSite

表示连接线始端所连接的连接站点。 null当线条的开头未附加到任何形状时返回 。

readonly beginConnectedSite: number;

属性值

number

注解

[ API 集：ExcelApi 1.9 ]

connectorType

表示线条的连接器类型。

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

属性值

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

注解

[ API 集：ExcelApi 1.9 ]

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

Excel.RequestContext

endArrowheadLength

表示指定线条末端的箭头长度。

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

属性值

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

注解

[ API 集：ExcelApi 1.9 ]

endArrowheadStyle

表示指定线条末端的箭头样式。

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

属性值

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

注解

[ API 集：ExcelApi 1.9 ]

endArrowheadWidth

表示指定线条末端的箭头宽度。

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

属性值

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

注解

[ API 集：ExcelApi 1.9 ]

endConnectedShape

表示指定线条末端所附加到的形状。

readonly endConnectedShape: Excel.Shape;

属性值

Excel.Shape

注解

[ API 集：ExcelApi 1.9 ]

endConnectedSite

表示连接线末端所连接的连接站点。 null当线条的末尾未附加到任何形状时返回 。

readonly endConnectedSite: number;

属性值

number

注解

[ API 集：ExcelApi 1.9 ]

id

指定形状标识符。

readonly id: string;

属性值

string

注解

[ API 集：ExcelApi 1.9 ]

isBeginConnected

指定指定线条的开头是否连接到形状。

readonly isBeginConnected: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.9 ]

isEndConnected

指定指定线条的末尾是否连接到形状。

readonly isEndConnected: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.9 ]

shape

返回与 Shape 行关联的 对象。

readonly shape: Excel.Shape;

属性值

Excel.Shape

注解

[ API 集：ExcelApi 1.9 ]

方法详细信息

connectBeginShape(shape, connectionSite)

将指定连接线的始端附加到指定形状。

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

参数

shape
Excel.Shape

要连接的形状。

connectionSite

number

连接符开头所附加到的形状上的连接站点。 必须是介于 0 (（含) ）和指定形状的连接站点计数 (排他) 之间的整数。

返回

void

注解

[ API 集：ExcelApi 1.9 ]

示例

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

connectEndShape(shape, connectionSite)

将指定连接线的末端附加到指定形状。

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

参数

shape
Excel.Shape

要连接的形状。

connectionSite

number

连接符末端所附加到的形状上的连接站点。 必须是介于 0 (（含) ）和指定形状的连接站点计数 (排他) 之间的整数。

返回

void

注解

[ API 集：ExcelApi 1.9 ]

示例

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

disconnectBeginShape()

使指定连接线的始端与形状脱离。

disconnectBeginShape(): void;

返回

void

注解

[ API 集：ExcelApi 1.9 ]

示例

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

disconnectEndShape()

使指定连接线的末端与形状脱离。

disconnectEndShape(): void;

返回

void

注解

[ API 集：ExcelApi 1.9 ]

示例

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

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

options
Excel.Interfaces.LineLoadOptions

提供要加载对象的属性的选项。

返回

Excel.Line

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

Excel.Line

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。

返回

Excel.Line

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。

set(properties: Interfaces.LineUpdateData, options?: OfficeExtension.UpdateOptions): void;

参数

properties
Excel.Interfaces.LineUpdateData

一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。

options
OfficeExtension.UpdateOptions

提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

返回

void

set(properties)

基于现有的已加载对象，同时对对象设置多个属性。

set(properties: Excel.Line): void;

参数

properties
Excel.Line

返回

void

toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 而原始 Excel.Line 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.LineData) ，其中包含原始对象中加载的任何子属性的浅表副本。

toJSON(): Excel.Interfaces.LineData;

返回

Excel.Interfaces.LineData