Excel.ChartDataLabels class
Représente une collection de toutes les étiquettes de données associées à un point de graphique.
- Extends
Remarques
[ Ensemble d’API : ExcelApi 1.1 ]
Propriétés
auto |
Spécifie si les étiquettes de données génèrent automatiquement le texte approprié en fonction du contexte. |
context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
format | Spécifie le format des étiquettes de données de graphique, qui inclut la mise en forme de remplissage et de police. |
horizontal |
Spécifie l’alignement horizontal de l’étiquette de données du graphique. Pour plus d’informations, consultez |
link |
Spécifie si le format de nombre est lié aux cellules. Si |
number |
Spécifie le code de format des étiquettes de données. |
position | Valeur qui représente la position de l’étiquette de données. Pour plus d’informations, consultez |
separator | Chaîne représentant le séparateur utilisé pour les étiquettes de données d’un graphique. |
show |
Spécifie si la taille de la bulle d’étiquette de données est visible. |
show |
Spécifie si le nom de la catégorie d’étiquette de données est visible. |
show |
Spécifie si la clé de légende d’étiquette de données est visible. |
show |
Spécifie si le pourcentage d’étiquette de données est visible. |
show |
Spécifie si le nom de la série d’étiquettes de données est visible. |
show |
Spécifie si la valeur de l’étiquette de données est visible. |
text |
Représente l’angle auquel le texte est orienté pour les étiquettes de données. La valeur doit être un entier compris entre -90 et 90 ou l’entier 180 pour le texte orienté verticalement. |
vertical |
Représente l’alignement vertical de l’étiquette de données du graphique. Pour plus d’informations, consultez |
Méthodes
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 passer un objet brut avec les propriétés appropriées ou 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é
autoText
Spécifie si les étiquettes de données génèrent automatiquement le texte approprié en fonction du contexte.
autoText: boolean;
Valeur de propriété
boolean
Remarques
context
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é
format
Spécifie le format des étiquettes de données de graphique, qui inclut la mise en forme de remplissage et de police.
readonly format: Excel.ChartDataLabelFormat;
Valeur de propriété
Remarques
horizontalAlignment
Spécifie l’alignement horizontal de l’étiquette de données du graphique. Pour plus d’informations, consultez Excel.ChartTextHorizontalAlignment
. Cette propriété est valide uniquement lorsque le de l’étiquette TextOrientation
de données est 0.
horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";
Valeur de propriété
Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"
Remarques
linkNumberFormat
Spécifie si le format de nombre est lié aux cellules. Si true
la valeur est , le format numérique change dans les étiquettes lorsqu’il change dans les cellules.
linkNumberFormat: boolean;
Valeur de propriété
boolean
Remarques
numberFormat
Spécifie le code de format des étiquettes de données.
numberFormat: string;
Valeur de propriété
string
Remarques
position
Valeur qui représente la position de l’étiquette de données. Pour plus d’informations, consultez Excel.ChartDataLabelPosition
.
position: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout";
Valeur de propriété
Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout"
Remarques
separator
Chaîne représentant le séparateur utilisé pour les étiquettes de données d’un graphique.
separator: string;
Valeur de propriété
string
Remarques
showBubbleSize
Spécifie si la taille de la bulle d’étiquette de données est visible.
showBubbleSize: boolean;
Valeur de propriété
boolean
Remarques
showCategoryName
Spécifie si le nom de la catégorie d’étiquette de données est visible.
showCategoryName: boolean;
Valeur de propriété
boolean
Remarques
showLegendKey
Spécifie si la clé de légende d’étiquette de données est visible.
showLegendKey: boolean;
Valeur de propriété
boolean
Remarques
showPercentage
Spécifie si le pourcentage d’étiquette de données est visible.
showPercentage: boolean;
Valeur de propriété
boolean
Remarques
showSeriesName
Spécifie si le nom de la série d’étiquettes de données est visible.
showSeriesName: boolean;
Valeur de propriété
boolean
Remarques
showValue
Spécifie si la valeur de l’étiquette de données est visible.
showValue: boolean;
Valeur de propriété
boolean
Remarques
textOrientation
Représente l’angle auquel le texte est orienté pour les étiquettes de données. 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
verticalAlignment
Représente l’alignement vertical de l’étiquette de données du graphique. Pour plus d’informations, consultez Excel.ChartTextVerticalAlignment
. Cette propriété est valide uniquement lorsque TextOrientation
l’étiquette de données est -90, 90 ou 180.
verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";
Valeur de propriété
Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"
Remarques
Détails de la méthode
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.ChartDataLabelsLoadOptions): Excel.ChartDataLabels;
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.ChartDataLabels;
Paramètres
- propertyNames
-
string | string[]
Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.
Retours
Exemples
// Show the series name in data labels and set the position of the data labels to "top".
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.dataLabels.showValue = true;
chart.dataLabels.position = Excel.ChartDataLabelPosition.top;
chart.dataLabels.showSeriesName = true;
await context.sync();
console.log("Data labels shown");
});
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.ChartDataLabels;
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 passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties: Interfaces.ChartDataLabelsUpdateData, options?: OfficeExtension.UpdateOptions): void;
Paramètres
- properties
- Excel.Interfaces.ChartDataLabelsUpdateData
Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des 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 properties 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.ChartDataLabels): void;
Paramètres
- properties
- Excel.ChartDataLabels
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
appelle à son tour la toJSON
méthode de l’objet qui lui est passé.) Alors que l’objet Excel.ChartDataLabels d’origine est un objet API, la toJSON
méthode renvoie un objet JavaScript brut (tapé en tant Excel.Interfaces.ChartDataLabelsData
que ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
toJSON(): Excel.Interfaces.ChartDataLabelsData;