Excel.Line class

Stellt eine Zeile innerhalb eines Arbeitsblatts dar. Um das entsprechende Shape Objekt zu erhalten, verwenden Sie Line.shape.

Extends

Hinweise

API-Satz: ExcelApi 1.9

Verwendet von

Eigenschaften

beginArrowheadLength

Stellt die Länge der Pfeilspitze am Anfang der angegebenen Linie dar.

beginArrowheadStyle

Stellt das Format der Pfeilspitze am Anfang der angegebenen Linie dar.

beginArrowheadWidth

Stellt die Breite der Pfeilspitze am Anfang der angegebenen Linie dar.

beginConnectedShape

Stellt die Form dar, an die der Anfang der angegebenen Linie angefügt ist.

beginConnectedSite

Stellt die Verbindungsseite dar, mit der der Anfang einer Verbindung verbunden ist. Gibt zurück null , wenn der Anfang der Linie an kein Shape angefügt ist.

connectorType

Stellt den Verbindertyp für die Linie dar.

context

Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

endArrowheadLength

Stellt die Länge der Pfeilspitze am Ende der angegebenen Linie dar.

endArrowheadStyle

Stellt das Format der Pfeilspitze am Ende der angegebenen Linie dar.

endArrowheadWidth

Stellt die Breite der Pfeilspitze am Ende der angegebenen Linie dar.

endConnectedShape

Stellt die Form dar, an die das Ende der angegebenen Linie angefügt ist.

endConnectedSite

Stellt die Verbindungsseite dar, mit der das Ende einer Verbindung verbunden ist. Gibt zurück null , wenn das Zeilenende an kein Shape angefügt ist.

id

Gibt den Formbezeichner an.

isBeginConnected

Gibt an, ob der Anfang der angegebenen Linie mit einem Shape verbunden ist.

isEndConnected

Gibt an, ob das Ende der angegebenen Linie mit einem Shape verbunden ist.

shape

Gibt das Shape mit der Linie verbundene Objekt zurück.

Methoden

connectBeginShape(shape, connectionSite)

Fügt den Anfang der angegebenen Verbindung an eine angegebene Form an.

connectEndShape(shape, connectionSite)

Fügt das Ende der angegebenen Verbindung an eine angegebene Form an.

disconnectBeginShape()

Löst den Anfang der angegebenen Verbindung von einer Form.

disconnectEndShape()

Löst das Ende der angegebenen Verbindung von einer Form.

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

set(properties, options)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

set(properties)

Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche Excel.Line Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.LineData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

Details zur Eigenschaft

beginArrowheadLength

Stellt die Länge der Pfeilspitze am Anfang der angegebenen Linie dar.

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

Eigenschaftswert

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

Hinweise

API-Satz: ExcelApi 1.9

beginArrowheadStyle

Stellt das Format der Pfeilspitze am Anfang der angegebenen Linie dar.

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

Eigenschaftswert

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

Hinweise

API-Satz: ExcelApi 1.9

beginArrowheadWidth

Stellt die Breite der Pfeilspitze am Anfang der angegebenen Linie dar.

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

Eigenschaftswert

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

Hinweise

API-Satz: ExcelApi 1.9

beginConnectedShape

Stellt die Form dar, an die der Anfang der angegebenen Linie angefügt ist.

readonly beginConnectedShape: Excel.Shape;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.9

beginConnectedSite

Stellt die Verbindungsseite dar, mit der der Anfang einer Verbindung verbunden ist. Gibt zurück null , wenn der Anfang der Linie an kein Shape angefügt ist.

readonly beginConnectedSite: number;

Eigenschaftswert

number

Hinweise

API-Satz: ExcelApi 1.9

connectorType

Stellt den Verbindertyp für die Linie dar.

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

Eigenschaftswert

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

Hinweise

API-Satz: ExcelApi 1.9

context

Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

endArrowheadLength

Stellt die Länge der Pfeilspitze am Ende der angegebenen Linie dar.

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

Eigenschaftswert

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

Hinweise

API-Satz: ExcelApi 1.9

endArrowheadStyle

Stellt das Format der Pfeilspitze am Ende der angegebenen Linie dar.

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

Eigenschaftswert

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

Hinweise

API-Satz: ExcelApi 1.9

endArrowheadWidth

Stellt die Breite der Pfeilspitze am Ende der angegebenen Linie dar.

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

Eigenschaftswert

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

Hinweise

API-Satz: ExcelApi 1.9

endConnectedShape

Stellt die Form dar, an die das Ende der angegebenen Linie angefügt ist.

readonly endConnectedShape: Excel.Shape;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.9

endConnectedSite

Stellt die Verbindungsseite dar, mit der das Ende einer Verbindung verbunden ist. Gibt zurück null , wenn das Zeilenende an kein Shape angefügt ist.

readonly endConnectedSite: number;

Eigenschaftswert

number

Hinweise

API-Satz: ExcelApi 1.9

id

Gibt den Formbezeichner an.

readonly id: string;

Eigenschaftswert

string

Hinweise

API-Satz: ExcelApi 1.9

isBeginConnected

Gibt an, ob der Anfang der angegebenen Linie mit einem Shape verbunden ist.

readonly isBeginConnected: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.9

isEndConnected

Gibt an, ob das Ende der angegebenen Linie mit einem Shape verbunden ist.

readonly isEndConnected: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.9

shape

Gibt das Shape mit der Linie verbundene Objekt zurück.

readonly shape: Excel.Shape;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.9

Details zur Methode

connectBeginShape(shape, connectionSite)

Fügt den Anfang der angegebenen Verbindung an eine angegebene Form an.

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

Parameter

shape
Excel.Shape

Das zu verbindende Shape.

connectionSite

number

Die Verbindungsstelle auf dem Shape, an dem der Anfang des Verbinders befestigt ist. Muss eine ganze Zahl zwischen 0 (einschließlich) und der Anzahl der Verbindungsstandorte der angegebenen Form (ausschließlich) sein.

Gibt zurück

void

Hinweise

API-Satz: ExcelApi 1.9

Beispiele

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

Fügt das Ende der angegebenen Verbindung an eine angegebene Form an.

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

Parameter

shape
Excel.Shape

Das zu verbindende Shape.

connectionSite

number

Die Verbindungsstelle auf dem Shape, an das das Ende des Verbinders angefügt ist. Muss eine ganze Zahl zwischen 0 (einschließlich) und der Anzahl der Verbindungsstandorte der angegebenen Form (ausschließlich) sein.

Gibt zurück

void

Hinweise

API-Satz: ExcelApi 1.9

Beispiele

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

Löst den Anfang der angegebenen Verbindung von einer Form.

disconnectBeginShape(): void;

Gibt zurück

void

Hinweise

API-Satz: ExcelApi 1.9

Beispiele

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

Löst das Ende der angegebenen Verbindung von einer Form.

disconnectEndShape(): void;

Gibt zurück

void

Hinweise

API-Satz: ExcelApi 1.9

Beispiele

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

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

options
Excel.Interfaces.LineLoadOptions

Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.

Gibt zurück

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

propertyNamesAndPaths

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

propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

set(properties, options)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

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

Parameter

properties
Excel.Interfaces.LineUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options
OfficeExtension.UpdateOptions

Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt versucht, schreibgeschützte Eigenschaften festzulegen.

Gibt zurück

void

set(properties)

Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Excel.Line): void;

Parameter

properties
Excel.Line

Gibt zurück

void

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche Excel.Line Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.LineData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): Excel.Interfaces.LineData;

Gibt zurück