Excel.SlicerItemCollection class
Representa una colección de todos los objetos de elemento de segmentación de datos de la segmentación de datos.
- Extends
Comentarios
[ Conjunto de API: ExcelApi 1.10 ]
Propiedades
context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
items | Obtiene los elementos secundarios cargados en esta colección. |
Métodos
get |
Indica el número de elementos de segmentación en la segmentación. |
get |
Obtiene una objeto de elemento de segmentación con su nombre o clave. |
get |
Obtiene un elemento de segmentación basándose en su posición en la colección. |
get |
Obtiene un elemento de segmentación mediante su nombre o la clave. Si el elemento de segmentación de datos no existe, este método devuelve un objeto con su |
load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
toJSON() | Invalida el método JavaScript |
Detalles de las propiedades
context
Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
context: RequestContext;
Valor de propiedad
items
Obtiene los elementos secundarios cargados en esta colección.
readonly items: Excel.SlicerItem[];
Valor de propiedad
Detalles del método
getCount()
Indica el número de elementos de segmentación en la segmentación.
getCount(): OfficeExtension.ClientResult<number>;
Devoluciones
OfficeExtension.ClientResult<number>
Comentarios
getItem(key)
Obtiene una objeto de elemento de segmentación con su nombre o clave.
getItem(key: string): Excel.SlicerItem;
Parámetros
- key
-
string
Clave o nombre del elemento de segmentación de datos.
Devoluciones
Comentarios
getItemAt(index)
Obtiene un elemento de segmentación basándose en su posición en la colección.
getItemAt(index: number): Excel.SlicerItem;
Parámetros
- index
-
number
Valor de índice del objeto que se va a recuperar. Indizado con cero.
Devoluciones
Comentarios
getItemOrNullObject(key)
Obtiene un elemento de segmentación mediante su nombre o la clave. Si el elemento de segmentación de datos no existe, este método devuelve un objeto con su isNullObject
propiedad establecida en true
. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
getItemOrNullObject(key: string): Excel.SlicerItem;
Parámetros
- key
-
string
Clave o nombre de la segmentación de datos que se va a recuperar.
Devoluciones
Comentarios
load(options)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync()
antes de leer las propiedades.
load(options?: Excel.Interfaces.SlicerItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SlicerItemCollection;
Parámetros
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
load(propertyNames)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync()
antes de leer las propiedades.
load(propertyNames?: string | string[]): Excel.SlicerItemCollection;
Parámetros
- propertyNames
-
string | string[]
Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.
Devoluciones
load(propertyNamesAndPaths)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync()
antes de leer las propiedades.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.SlicerItemCollection;
Parámetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select
es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand
es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.
Devoluciones
toJSON()
Invalida el método JavaScript toJSON()
para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify()
. (JSON.stringify
a su vez, llama al toJSON
método del objeto que se le pasa). Mientras que el objeto original Excel.SlicerItemCollection
es un objeto de API, el toJSON
método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.SlicerItemCollectionData
) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.
toJSON(): Excel.Interfaces.SlicerItemCollectionData;