Excel.Line class

Renvoie ou définit la longueur de la pointe de la flèche au début de la ligne spécifiée.

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

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Représente le style de la pointe de la flèche au début de la ligne spécifiée.

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

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Représente la largeur de la pointe de la flèche au début de la ligne spécifiée.

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

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Représente la forme de la pointe de la flèche au début de la ligne spécifiée.

readonly beginConnectedShape: Excel.Shape;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Représente le site de connexion indiquant le point de connexion auquel le début d'un connecteur est relié. Retourne null lorsque le début de la ligne n’est attaché à aucune forme.

readonly beginConnectedSite: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Représente le type de connecteur pour la ligne.

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

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Représente la longueur de la pointe de la flèche à la fin de la ligne spécifiée.

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

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Représente le style de la pointe de la flèche à la fin de ligne spécifée.

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

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Représente la largeur de la pointe de la flèche à la fin de la ligne spécifiée.

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

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Représente la forme de la pointe de la flèche à la fin de la ligne spécifiée.

readonly endConnectedShape: Excel.Shape;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Représente le site de connexion indiquant le point de connexion auquel la fin d'un connecteur est relié. Retourne null lorsque la fin de la ligne n’est attachée à aucune forme.

readonly endConnectedSite: number;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Spécifie l’identificateur de forme.

readonly id: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Spécifie si le début de la ligne spécifiée est connecté à une forme.

readonly isBeginConnected: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Spécifie si la fin de la ligne spécifiée est connectée à une forme.

readonly isEndConnected: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Retourne l’objet Shape associé à la ligne.

readonly shape: Excel.Shape;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Détache le début du connecteur spécifié de la forme à laquelle il est attaché.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Exemples

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

Joint la fin du connecteur spécifié à une forme spécifiée.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Exemples

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

Détache le début du connecteur spécifié de la forme à laquelle il est attaché.

disconnectBeginShape(): void;

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Exemples

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

Détache la fin du connecteur spécifié de la forme à laquelle il est attaché.

disconnectEndShape(): void;

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Exemples

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

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

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

Paramètres

Retours

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

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

Paramètres

Retours

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.Line): void;

Paramètres

Retours

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.Line est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.LineDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.LineData;

Retours