Excel.SlicerItem class

  • Référence
Paquet:
excel

Représente un élément de segment dans un segment.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Propriétés

context

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

La valeur est true si l’élément de segment contient des données.
isSelected

La valeur est true si l’élément de segment est sélectionné. La définition de cette valeur n’efface pas l’état sélectionné des autres éléments du segment. Par défaut, si l’élément de segment est le seul sélectionné, lorsqu’il est désélectionné, tous les éléments sont sélectionnés.
key

Représente la valeur unique représentant l’élément de segment.
name

Représente le titre affiché dans l’interface utilisateur Excel.

Méthodes

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(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(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.
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 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 Excel.SlicerItem d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.SlicerItemDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

Détails de la propriété

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é

Excel.RequestContext

hasData

La valeur est true si l’élément de segment contient des données.

readonly hasData: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

isSelected

La valeur est true si l’élément de segment est sélectionné. La définition de cette valeur n’efface pas l’état sélectionné des autres éléments du segment. Par défaut, si l’élément de segment est le seul sélectionné, lorsqu’il est désélectionné, tous les éléments sont sélectionnés.

isSelected: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

key

Représente la valeur unique représentant l’élément de segment.

readonly key: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

name

Représente le titre affiché dans l’interface utilisateur Excel.

readonly name: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

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.SlicerItemLoadOptions): Excel.SlicerItem;

Paramètres

options
Excel.Interfaces.SlicerItemLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Excel.SlicerItem

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.SlicerItem;

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

Excel.SlicerItem

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.SlicerItem;

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

Excel.SlicerItem

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.SlicerItemUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties
Excel.Interfaces.SlicerItemUpdateData

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.SlicerItem): void;

Paramètres

properties
Excel.SlicerItem

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.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet Excel.SlicerItem d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.SlicerItemDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.SlicerItemData;

Retours

Excel.Interfaces.SlicerItemData