Excel.Slicer class

Referencia

Paquete:: excel

Representa un Slicer objeto en el libro.

Extends: OfficeExtension.ClientObject

Comentarios

Propiedades

caption	Representa el título de la segmentación de datos.
context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
height	Indica el alto, en puntos, de la segmentación. Produce una `InvalidArgument` excepción cuando se establece con un valor negativo o cero como entrada.
id	Representa el identificador único de la segmentación de datos.
isFilterCleared	El valor es `true` si se borran todos los filtros aplicados actualmente en la segmentación de datos.
left	La distancia, en puntos, desde el lado izquierdo de la segmentación hasta el izquierdo de la hoja de cálculo. Produce un `InvalidArgument` error cuando se establece con un valor negativo como entrada.
name	Representa el nombre de la segmentación de datos.
nameInFormula	Indica el nombre de la segmentación usado en la fórmula.
slicerItems	Representa la colección de elementos de segmentación de datos que forman parte de la segmentación de datos.
slicerStyle	Estilo aplicado a la segmentación de datos.
sortBy	Indica el orden de los elementos de la segmentación. Los valores posibles son: "DataSourceOrder", "Ascending", "Descending".
style	Valor constante que representa el estilo de segmentación de datos. 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. Produce un `InvalidArgument` error cuando se establece con un valor negativo como entrada.
width	Indica el ancho, en puntos, de la segmentación. Produce un `InvalidArgument` error cuando se establece con un valor negativo o cero como entrada.
worksheet	Indica la hoja de cálculo que contiene la segmentación.

Métodos

clearFilters()	Borra todos los filtros aplicados actualmente en la segmentación.
delete()	Elimina la segmentación.
getSelectedItems()	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 `context.sync()` antes de leer las propiedades.
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(propertyNamesAndPaths)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a `context.sync()` antes de leer las propiedades.
selectItems(items)	Selecciona los elementos de segmentación en función de sus claves. Se borran 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 de API del mismo tipo.
set(properties)	Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
setStyle(style)	Establece el estilo aplicado a la segmentación de datos.
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 Excel.Slicer original es un objeto de API, el `toJSON` método devuelve un objeto JavaScript sin formato (escrito como `Excel.Interfaces.SlicerData`) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

caption

Representa el título de la segmentación de datos.

caption: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

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

Excel.RequestContext

height

Indica el alto, en puntos, de la segmentación. Produce una InvalidArgument excepción cuando se establece con un valor negativo o cero como entrada.

height: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

id

Representa el identificador único de la segmentación de datos.

readonly id: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

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

[ Conjunto de API: ExcelApi 1.10 ]

left

La distancia, en puntos, desde el lado izquierdo de la segmentación hasta el izquierdo de la hoja de cálculo. Produce un InvalidArgument error cuando se establece con un valor negativo como entrada.

left: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

name

Representa el nombre de la segmentación de datos.

name: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

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.

Indica el nombre de la segmentación usado en la fórmula.

nameInFormula: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

slicerItems

Representa la colección de elementos de segmentación de datos que forman parte de la segmentación de datos.

readonly slicerItems: Excel.SlicerItemCollection;

Valor de propiedad

Excel.SlicerItemCollection

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

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

Excel.SlicerStyle

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

sortBy

Indica el orden de los elementos de la segmentación. Los valores posibles son: "DataSourceOrder", "Ascending", "Descending".

sortBy: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending";

Valor de propiedad

Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending"

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

style

Valor constante que representa el estilo de segmentación de datos. 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. Produce un InvalidArgument error cuando se establece con un valor negativo como entrada.

top: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

width

Indica el ancho, en puntos, de la segmentación. Produce un InvalidArgument error cuando se establece con un valor negativo o cero como entrada.

width: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

worksheet

Indica la hoja de cálculo que contiene la segmentación.

readonly worksheet: Excel.Worksheet;

Valor de propiedad

Excel.Worksheet

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

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

[ Conjunto de API: ExcelApi 1.10 ]

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

options: Excel.Interfaces.SlicerLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Excel.Slicer

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

Excel.Slicer

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

Excel.Slicer

selectItems(items)

Selecciona los elementos de segmentación en función de sus claves. Se borran 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. Nombres de elemento de segmentación especificados que se van a seleccionar.

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 de API del mismo tipo.

set(properties: Interfaces.SlicerUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

properties: Excel.Interfaces.SlicerUpdateData

Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al 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, en función de 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 va a aplicar a la segmentación de datos. Se InvalidArgument produce un error si se proporciona una cadena que no coincide con el nombre de ningún estilo.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

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.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto Excel.Slicer original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.SlicerData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.SlicerData;

Devoluciones

Excel.Interfaces.SlicerData