Excel.Line class
Représente une ligne à l’intérieur d’une feuille de calcul. Pour obtenir l’objet correspondant Shape , utilisez Line.shape.
- Extends
Propriétés
| begin |
Renvoie ou définit la longueur de la pointe de la flèche au début de la ligne spécifiée. |
| begin |
Représente le style de la pointe de la flèche au début de la ligne spécifiée. |
| begin |
Représente la largeur de la pointe de la flèche au début de la ligne spécifiée. |
| begin |
Représente la forme de la pointe de la flèche au début de la ligne spécifiée. |
| begin |
Représente le site de connexion indiquant le point de connexion auquel le début d'un connecteur est relié. Revient |
| connector |
Représente le type de connecteur pour la ligne. |
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| end |
Représente la longueur de la pointe de la flèche à la fin de la ligne spécifiée. |
| end |
Représente le style de la pointe de la flèche à la fin de ligne spécifée. |
| end |
Représente la largeur de la pointe de la flèche à la fin de la ligne spécifiée. |
| end |
Représente la forme de la pointe de la flèche à la fin de la ligne spécifiée. |
| end |
Représente le site de connexion indiquant le point de connexion auquel la fin d'un connecteur est relié. Retourne |
| id | Spécifie l’identificateur de forme. |
| is |
Indique si le début de la ligne spécifiée est connecté à une forme. |
| is |
Indique si la fin de la ligne spécifiée est connectée à une forme. |
| shape | Renvoie l’objet |
Méthodes
| connect |
Détache le début du connecteur spécifié de la forme à laquelle il est attaché. |
| connect |
Joint la fin du connecteur spécifié à une forme spécifiée. |
| disconnect |
Détache le début du connecteur spécifié de la forme à laquelle il est attaché. |
| disconnect |
Détache la fin du connecteur spécifié de la forme à laquelle il est attaché. |
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| set(properties, options) | Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type. |
| set(properties) | Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant. |
| toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
beginArrowheadLength
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é
Excel.ArrowheadLength | "Short" | "Medium" | "Long"
Remarques
beginArrowheadStyle
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é
Excel.ArrowheadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open"
Remarques
beginArrowheadWidth
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é
Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide"
Remarques
beginConnectedShape
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
beginConnectedSite
Représente le site de connexion indiquant le point de connexion auquel le début d'un connecteur est relié. Revient null lorsque le début de la ligne n’est attaché à aucune forme.
readonly beginConnectedSite: number;Valeur de propriété
number
Remarques
connectorType
Représente le type de connecteur pour la ligne.
connectorType: Excel.ConnectorType | "Straight" | "Elbow" | "Curve";Valeur de propriété
Excel.ConnectorType | "Straight" | "Elbow" | "Curve"
Remarques
context
Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
context: RequestContext;Valeur de propriété
endArrowheadLength
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é
Excel.ArrowheadLength | "Short" | "Medium" | "Long"
Remarques
endArrowheadStyle
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é
Excel.ArrowheadStyle | "None" | "Triangle" | "Stealth" | "Diamond" | "Oval" | "Open"
Remarques
endArrowheadWidth
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é
Excel.ArrowheadWidth | "Narrow" | "Medium" | "Wide"
Remarques
endConnectedShape
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
endConnectedSite
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é
number
Remarques
id
Spécifie l’identificateur de forme.
readonly id: string;Valeur de propriété
string
Remarques
isBeginConnected
Indique si le début de la ligne spécifiée est connecté à une forme.
readonly isBeginConnected: boolean;Valeur de propriété
boolean
Remarques
isEndConnected
Indique si la fin de la ligne spécifiée est connectée à une forme.
readonly isEndConnected: boolean;Valeur de propriété
boolean
Remarques
shape
Renvoie l’objet Shape associé à la ligne.
readonly shape: Excel.Shape;Valeur de propriété
Remarques
Détails de la méthode
connectBeginShape(shape, connectionSite)
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
- shape
- Excel.Shape
Forme à connecter.
- connectionSite
-
number
Site de connexion sur la forme à laquelle le début du connecteur est attaché. Doit être un entier compris entre 0 (inclus) et le nombre de sites de connexion de la forme spécifiée (exclusif).
Retours
void
Remarques
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();
});
connectEndShape(shape, connectionSite)
Joint la fin du connecteur spécifié à une forme spécifiée.
connectEndShape(shape: Excel.Shape, connectionSite: number): void;Paramètres
- shape
- Excel.Shape
Forme à connecter.
- connectionSite
-
number
Site de connexion sur la forme à laquelle l’extrémité du connecteur est attachée. Doit être un entier compris entre 0 (inclus) et le nombre de sites de connexion de la forme spécifiée (exclusif).
Retours
void
Remarques
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();
});
disconnectBeginShape()
Détache le début du connecteur spécifié de la forme à laquelle il est attaché.
disconnectBeginShape(): void;Retours
void
Remarques
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();
});
disconnectEndShape()
Détache la fin du connecteur spécifié de la forme à laquelle il est attaché.
disconnectEndShape(): void;Retours
void
Remarques
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();
});
load(options)
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
- options
- Excel.Interfaces.LineLoadOptions
Fournit des options pour les propriétés de l’objet à charger.
Retours
load(propertyNames)
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
- propertyNames
-
string | string[]
Chaîne délimitée par des virgules ou tableau de chaînes spécifiant les propriétés à charger.
Retours
load(propertyNamesAndPaths)
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
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.
Retours
set(properties, options)
Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.
set(properties: Interfaces.LineUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Excel.Interfaces.LineUpdateData
Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux propriétés de l’objet sur lequel la méthode est appelée.
- options
- OfficeExtension.UpdateOptions
Fournit une option permettant de supprimer les erreurs si l’objet de propriétés tente de définir des propriétés en lecture seule.
Retours
void
set(properties)
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
- properties
- Excel.Line
Retours
void
toJSON()
Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle 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 simple (typé ) Excel.Interfaces.LineDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): Excel.Interfaces.LineData;