Excel.ChartTitle class
Représente un objet de titre pour un graphique.
- Extends
Remarques
[Jeu d’API : ExcelApi 1.1]
Propriétés
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| format | Représente le format du titre d’un graphique, à savoir le format de remplissage et de la police. |
| height | Représente la hauteur, exprimée en points, du titre du graphique. Valeur si |
| horizontal |
Spécifie l’alignement horizontal du titre du graphique. |
| left | Spécifie la distance, en points, entre le bord gauche du titre du graphique et le bord gauche de la zone du graphique. Valeur si |
| overlay | Indique si le titre du graphique doit être superposé au graphique. |
| position | Représente la position du titre du graphique. Pour |
| show |
Représente une valeur booléenne qui détermine si le titre du graphique a une ombre. |
| text | Spécifie le texte du titre du graphique. |
| text |
Spécifie l’angle d’orientation du texte pour le titre du graphique. La valeur doit être un entier compris entre -90 et 90 ou l’entier 180 pour le texte orienté verticalement. |
| top | Spécifie la distance, en points, entre le bord supérieur du titre du graphique et le haut de la zone du graphique. Valeur si |
| vertical |
Spécifie l’alignement vertical du titre du graphique. Pour |
| visible | Indique si le titre du graphique est visible. |
| width | Spécifie la largeur, en points, du titre du graphique. Valeur si |
Méthodes
| get |
Obtenir la sous-chaîne d’un titre de graphique. Le saut de ligne 'n' compte un\ caractère. |
| 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. |
| set |
Définit une valeur de chaîne qui représente la formule de titre de graphique à l’aide de la notation de style A1. |
| toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
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é
format
Représente le format du titre d’un graphique, à savoir le format de remplissage et de la police.
readonly format: Excel.ChartTitleFormat;Valeur de propriété
Remarques
[Jeu d’API : ExcelApi 1.1]
height
Représente la hauteur, exprimée en points, du titre du graphique. Valeur si null le titre du graphique n’est pas visible.
readonly height: number;Valeur de propriété
number
Remarques
[Jeu d’API : ExcelApi 1.7]
horizontalAlignment
Spécifie l’alignement horizontal du titre du graphique.
horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";Valeur de propriété
Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"
Remarques
[Jeu d’API : ExcelApi 1.7]
left
Spécifie la distance, en points, entre le bord gauche du titre du graphique et le bord gauche de la zone du graphique. Valeur si null le titre du graphique n’est pas visible.
left: number;Valeur de propriété
number
Remarques
[Jeu d’API : ExcelApi 1.7]
overlay
Indique si le titre du graphique doit être superposé au graphique.
overlay: boolean;Valeur de propriété
boolean
Remarques
[Jeu d’API : ExcelApi 1.1]
position
Représente la position du titre du graphique. Pour Excel.ChartTitlePosition plus de détails.
position: Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right";Valeur de propriété
Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right"
Remarques
[Jeu d’API : ExcelApi 1.7]
showShadow
Représente une valeur booléenne qui détermine si le titre du graphique a une ombre.
showShadow: boolean;Valeur de propriété
boolean
Remarques
[Jeu d’API : ExcelApi 1.7]
text
Spécifie le texte du titre du graphique.
text: string;Valeur de propriété
string
Remarques
[Jeu d’API : ExcelApi 1.1]
textOrientation
Spécifie l’angle d’orientation du texte pour le titre du graphique. La valeur doit être un entier compris entre -90 et 90 ou l’entier 180 pour le texte orienté verticalement.
textOrientation: number;Valeur de propriété
number
Remarques
[Jeu d’API : ExcelApi 1.7]
top
Spécifie la distance, en points, entre le bord supérieur du titre du graphique et le haut de la zone du graphique. Valeur si null le titre du graphique n’est pas visible.
top: number;Valeur de propriété
number
Remarques
[Jeu d’API : ExcelApi 1.7]
verticalAlignment
Spécifie l’alignement vertical du titre du graphique. Pour Excel.ChartTextVerticalAlignment plus de détails.
verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";Valeur de propriété
Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"
Remarques
[Jeu d’API : ExcelApi 1.7]
visible
Indique si le titre du graphique est visible.
visible: boolean;Valeur de propriété
boolean
Remarques
[Jeu d’API : ExcelApi 1.1]
width
Spécifie la largeur, en points, du titre du graphique. Valeur si null le titre du graphique n’est pas visible.
readonly width: number;Valeur de propriété
number
Remarques
[Jeu d’API : ExcelApi 1.7]
Détails de la méthode
getSubstring(start, length)
Obtenir la sous-chaîne d’un titre de graphique. Le saut de ligne 'n' compte un\ caractère.
getSubstring(start: number, length: number): Excel.ChartFormatString;Paramètres
- start
-
number
Position initiale de la sous-chaîne à récupérer. Avec indice zéro.
- length
-
number
Longueur de la sous-chaîne à récupérer.
Retours
Remarques
[Jeu d’API : ExcelApi 1.7]
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.ChartTitleLoadOptions): Excel.ChartTitle;Paramètres
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.ChartTitle;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.ChartTitle;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.ChartTitleUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Excel.Interfaces.ChartTitleUpdateData
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.ChartTitle): void;Paramètres
- properties
- Excel.ChartTitle
Retours
void
setFormula(formula)
Définit une valeur de chaîne qui représente la formule de titre de graphique à l’aide de la notation de style A1.
setFormula(formula: string): void;Paramètres
- formula
-
string
Chaîne qui représente la formule à définir.
Retours
void
Remarques
[Jeu d’API : ExcelApi 1.7]
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.ChartTitle est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.ChartTitleDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): Excel.Interfaces.ChartTitleData;