Excel.Slicer class
Representa un Slicer objeto del libro.
- Extends
Propiedades
| caption | Representa el subtítulo de la segmentación de datos. |
| context | El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office. |
| height | Especifica la altura, en puntos, de la segmentación de datos. Lanza una |
| id | Representa el identificador único de la segmentación de datos. |
| is |
El valor es |
| left | La distancia, en puntos, desde el lado izquierdo de la segmentación hasta el izquierdo de la hoja de cálculo. Genera un |
| name | Representa el nombre de la segmentación de datos. |
| name |
Especifica el nombre de segmentación de datos utilizado en la fórmula. |
| slicer |
Representa la colección de elementos de segmentación que forman parte del segmentador. |
| slicer |
Estilo aplicado a la segmentación de datos. |
| sort |
Especifica el criterio de ordenación de los elementos de la segmentación de datos. Los valores posibles son: "DataSourceOrder", "Ascending", "Descending". |
| style | Valor constante que representa el estilo de segmentación. Los valores posibles son: "SlicerStyleLight1" a "SlicerStyleLight6", "TableStyleOther1" a "TableStyleOther2", "SlicerStyleDark1" a "SlicerStyleDark6". También puede especificarse un estilo personalizado definido por el usuario presente en el libro. |
| top | La distancia, en puntos, desde el borde superior de la segmentación hasta la parte superior de la hoja de cálculo. Genera un |
| width | Indica el ancho, en puntos, de la segmentación. Genera un |
| worksheet | Indica la hoja de cálculo que contiene la segmentación. |
Métodos
| clear |
Borra todos los filtros aplicados actualmente en la segmentación. |
| delete() | Elimina la segmentación. |
| get |
Devuelve una matriz de claves de los elementos seleccionados. |
| 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 |
| select |
Selecciona los elementos de segmentación en función de sus claves. Se anulan las selecciones anteriores. Todos los elementos se seleccionarán de forma predeterminada si la matriz está vacía. |
| set(properties, options) | Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto API del mismo tipo. |
| set(properties) | Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente. |
| set |
Establece el estilo aplicado a la segmentación de datos. |
| toJSON() | Reemplaza el método JavaScript |
Detalles de las propiedades
caption
Representa el subtítulo de la segmentación de datos.
caption: string;Valor de propiedad
string
Comentarios
context
El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.
context: RequestContext;Valor de propiedad
height
Especifica la altura, en puntos, de la segmentación de datos. Lanza una InvalidArgument excepción cuando se establece con un valor negativo o cero como entrada.
height: number;Valor de propiedad
number
Comentarios
id
Representa el identificador único de la segmentación de datos.
readonly id: string;Valor de propiedad
string
Comentarios
isFilterCleared
El valor es true si se borran todos los filtros aplicados actualmente en la segmentación de datos.
readonly isFilterCleared: boolean;Valor de propiedad
boolean
Comentarios
left
La distancia, en puntos, desde el lado izquierdo de la segmentación hasta el izquierdo de la hoja de cálculo. Genera un InvalidArgument error cuando se establece con un valor negativo como entrada.
left: number;Valor de propiedad
number
Comentarios
name
Representa el nombre de la segmentación de datos.
name: string;Valor de propiedad
string
Comentarios
nameInFormula
Nota
Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.
Especifica el nombre de segmentación de datos utilizado en la fórmula.
nameInFormula: string;Valor de propiedad
string
Comentarios
slicerItems
Representa la colección de elementos de segmentación que forman parte del segmentador.
readonly slicerItems: Excel.SlicerItemCollection;Valor de propiedad
Comentarios
slicerStyle
Nota
Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.
Estilo aplicado a la segmentación de datos.
readonly slicerStyle: Excel.SlicerStyle;Valor de propiedad
Comentarios
sortBy
Especifica el criterio de ordenación de los elementos de la segmentación de datos. Los valores posibles son: "DataSourceOrder", "Ascending", "Descending".
sortBy: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending";Valor de propiedad
Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending"
Comentarios
style
Valor constante que representa el estilo de segmentación. Los valores posibles son: "SlicerStyleLight1" a "SlicerStyleLight6", "TableStyleOther1" a "TableStyleOther2", "SlicerStyleDark1" a "SlicerStyleDark6". También puede especificarse un estilo personalizado definido por el usuario presente en el libro.
style: string;Valor de propiedad
string
Comentarios
Conjunto de API: ExcelApi 1.10
Ejemplos
// 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
La distancia, en puntos, desde el borde superior de la segmentación hasta la parte superior de la hoja de cálculo. Genera un InvalidArgument error cuando se establece con un valor negativo como entrada.
top: number;Valor de propiedad
number
Comentarios
width
Indica el ancho, en puntos, de la segmentación. Genera un InvalidArgument error cuando se establece con un valor negativo o cero como entrada.
width: number;Valor de propiedad
number
Comentarios
worksheet
Indica la hoja de cálculo que contiene la segmentación.
readonly worksheet: Excel.Worksheet;Valor de propiedad
Comentarios
Detalles del método
clearFilters()
Borra todos los filtros aplicados actualmente en la segmentación.
clearFilters(): void;Devoluciones
void
Comentarios
Conjunto de API: ExcelApi 1.10
Ejemplos
// 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()
Elimina la segmentación.
delete(): void;Devoluciones
void
Comentarios
Conjunto de API: ExcelApi 1.10
Ejemplos
// 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()
Devuelve una matriz de claves de los elementos seleccionados.
getSelectedItems(): OfficeExtension.ClientResult<string[]>;Devoluciones
OfficeExtension.ClientResult<string[]>
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.SlicerLoadOptions): Excel.Slicer;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.Slicer;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?: {
select?: string;
expand?: string;
}): Excel.Slicer;Parámetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
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
selectItems(items)
Selecciona los elementos de segmentación en función de sus claves. Se anulan las selecciones anteriores. Todos los elementos se seleccionarán de forma predeterminada si la matriz está vacía.
selectItems(items?: string[]): void;Parámetros
- items
-
string[]
Opcional. Los nombres de elemento de segmentación especificados que se seleccionarán.
Devoluciones
void
Comentarios
Conjunto de API: ExcelApi 1.10
Ejemplos
// 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)
Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto API del mismo tipo.
set(properties: Interfaces.SlicerUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Excel.Interfaces.SlicerUpdateData
Un objeto JavaScript con propiedades que están estructuradas isomorfamente a las propiedades del objeto en el que se llama al método.
- options
- OfficeExtension.UpdateOptions
Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.
Devoluciones
void
set(properties)
Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente.
set(properties: Excel.Slicer): void;Parámetros
- properties
- Excel.Slicer
Devoluciones
void
setStyle(style)
Nota
Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.
Establece el estilo aplicado a la segmentación de datos.
setStyle(style: string | SlicerStyle | BuiltInSlicerStyle): void;Parámetros
- style
-
string | Excel.SlicerStyle | Excel.BuiltInSlicerStyle
Estilo que se aplicará a la segmentación de datos. Se produce un InvalidArgument error si se proporciona una cadena que no coincide con el nombre de ningún estilo.
Devoluciones
void
Comentarios
toJSON()
Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto 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.Slicer es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.SlicerData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.
toJSON(): Excel.Interfaces.SlicerData;