Excel.Slicer class
Représente un Slicer objet dans le classeur.
- Extends
Remarques
Utilisateur
Propriétés
| caption | Représente la légende du segment. |
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| height | Spécifie la hauteur, en points, du segment. Lève une |
| id | Représente l’ID unique du segment. |
| is |
Valeur si |
| left | Représente la distance, en points, entre le côté gauche du graphique et l’origine de la feuille de calcul. Génère une |
| name | Représente le nom du segment. |
| name |
Spécifie le nom du segment utilisé dans la formule. |
| slicer |
Représente l’ensemble des éléments de segment qui font partie du segment. |
| slicer |
Style appliqué au segment. |
| sort |
Spécifie l’ordre de tri des éléments dans le segment. Les valeurs possibles sont : « DataSourceOrder », « Croissant », « Décroissant ». |
| style | Valeur constante qui représente le style de segment. Les valeurs possibles sont : « SlicerStyleLight1 » à « SlicerStyleLight6 », « TableStyleOther1 » à « TableStyleOther2 », « SlicerStyleDark1 » à « SlicerStyleDark6 ». Vous pouvez également indiquer un style personnalisé présent dans le classeur. |
| top | Représente la distance, en points, du bord supérieur de la section à la partie droite de la feuille de calcul. Génère une |
| width | Représente la largeur, en points, de la forme. Génère une |
| worksheet | Obtenir la feuille de calcul contenant la plage. |
Méthodes
| clear |
Supprime tous les filtres appliqués actuellement sur le tableau. |
| delete() | Supprime le segment. |
| get |
Renvoie une matrice de noms d’éléments sélectionnés. |
| 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 |
| select |
Sélectionne les éléments de segment en fonction de leurs clés. Les sélections précédentes sont effacées. Tous les éléments sont sélectionnés par défaut si le tableau est vide. |
| 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 le style appliqué au segment. |
| toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
caption
Représente la légende du segment.
caption: string;Valeur de propriété
string
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é
height
Spécifie la hauteur, en points, du segment. Lève une InvalidArgument exception lorsqu’une valeur d’entrée est négative ou égale à zéro.
height: number;Valeur de propriété
number
Remarques
id
Représente l’ID unique du segment.
readonly id: string;Valeur de propriété
string
Remarques
isFilterCleared
Valeur si true tous les filtres actuellement appliqués sur le segment sont effacés.
readonly isFilterCleared: boolean;Valeur de propriété
boolean
Remarques
left
Représente la distance, en points, entre le côté gauche du graphique et l’origine de la feuille de calcul. Génère une InvalidArgument erreur lorsqu’il est défini avec une valeur négative comme entrée.
left: number;Valeur de propriété
number
Remarques
name
Représente le nom du segment.
name: string;Valeur de propriété
string
Remarques
nameInFormula
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Spécifie le nom du segment utilisé dans la formule.
nameInFormula: string;Valeur de propriété
string
Remarques
slicerItems
Représente l’ensemble des éléments de segment qui font partie du segment.
readonly slicerItems: Excel.SlicerItemCollection;Valeur de propriété
Remarques
slicerStyle
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Style appliqué au segment.
readonly slicerStyle: Excel.SlicerStyle;Valeur de propriété
Remarques
sortBy
Spécifie l’ordre de tri des éléments dans le segment. Les valeurs possibles sont : « DataSourceOrder », « Croissant », « Décroissant ».
sortBy: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending";Valeur de propriété
Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending"
Remarques
style
Valeur constante qui représente le style de segment. Les valeurs possibles sont : « SlicerStyleLight1 » à « SlicerStyleLight6 », « TableStyleOther1 » à « TableStyleOther2 », « SlicerStyleDark1 » à « SlicerStyleDark6 ». Vous pouvez également indiquer un style personnalisé présent dans le classeur.
style: string;Valeur de propriété
string
Remarques
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml
await Excel.run(async (context) => {
const slicer = context.workbook.slicers.getItem("Fruit Slicer");
slicer.style = "SlicerStyleLight6";
await context.sync();
});
top
Représente la distance, en points, du bord supérieur de la section à la partie droite de la feuille de calcul. Génère une InvalidArgument erreur lorsqu’il est défini avec une valeur négative comme entrée.
top: number;Valeur de propriété
number
Remarques
width
Représente la largeur, en points, de la forme. Génère une InvalidArgument erreur lorsqu’il est défini avec une valeur négative ou zéro comme entrée.
width: number;Valeur de propriété
number
Remarques
worksheet
Obtenir la feuille de calcul contenant la plage.
readonly worksheet: Excel.Worksheet;Valeur de propriété
Remarques
Détails de la méthode
clearFilters()
Supprime tous les filtres appliqués actuellement sur le tableau.
clearFilters(): void;Retours
void
Remarques
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml
await Excel.run(async (context) => {
const slicer = context.workbook.slicers.getItem("Fruit Slicer");
slicer.clearFilters();
await context.sync();
});
delete()
Supprime le segment.
delete(): void;Retours
void
Remarques
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getActiveWorksheet();
sheet.slicers.getItemAt(0).delete();
await context.sync();
});
getSelectedItems()
Renvoie une matrice de noms d’éléments sélectionnés.
getSelectedItems(): OfficeExtension.ClientResult<string[]>;Retours
OfficeExtension.ClientResult<string[]>
Remarques
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.SlicerLoadOptions): Excel.Slicer;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.Slicer;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.Slicer;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
selectItems(items)
Sélectionne les éléments de segment en fonction de leurs clés. Les sélections précédentes sont effacées. Tous les éléments sont sélectionnés par défaut si le tableau est vide.
selectItems(items?: string[]): void;Paramètres
- items
-
string[]
Facultatif. Noms d’éléments de segment spécifiés à sélectionner.
Retours
void
Remarques
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml
await Excel.run(async (context) => {
const slicer = context.workbook.slicers.getItem("Fruit Slicer");
slicer.selectItems(["Lemon", "Lime", "Orange"]);
await context.sync();
});
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.SlicerUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Excel.Interfaces.SlicerUpdateData
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.Slicer): void;Paramètres
- properties
- Excel.Slicer
Retours
void
setStyle(style)
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Définit le style appliqué au segment.
setStyle(style: string | SlicerStyle | BuiltInSlicerStyle): void;Paramètres
- style
-
string | Excel.SlicerStyle | Excel.BuiltInSlicerStyle
Style à appliquer au segment. Une InvalidArgument erreur est générée si une chaîne fournie ne correspond au nom d’aucun style.
Retours
void
Remarques
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.Slicer est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.SlicerDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): Excel.Interfaces.SlicerData;