Excel.SlicerCollection class

Paquete:

excel

Representa una colección de todos los objetos de segmentación del libro o una hoja de cálculo.

Extends

OfficeExtension.ClientObject

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

add(slicerSource, sourceField, slicerDestination)	Agrega una nueva segmentación al libro.
getCount()	Devuelve el número de segmentaciones incluidas en la colección.
getItem(key)	Obtiene un objeto de segmentación de datos con su nombre o identificador.
getItemAt(index)	Obtiene una segmentación basándose en su posición en la colección.
getItemOrNullObject(key)	Obtiene una segmentación de datos con su nombre o identificador. Si la 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).
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.
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 original Excel.SlicerCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.SlicerCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

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

Excel.RequestContext

items

Obtiene los elementos secundarios cargados en esta colección.

readonly items: Excel.Slicer[];

Valor de propiedad

Excel.Slicer[]

Detalles del método

add(slicerSource, sourceField, slicerDestination)

Agrega una nueva segmentación al libro.

add(slicerSource: string | PivotTable | Table, sourceField: string | PivotField | number | TableColumn, slicerDestination?: string | Worksheet): Excel.Slicer;

Parámetros

slicerSource

string | Excel.PivotTable | Excel.Table

Origen de datos en el que se basará la nueva segmentación de datos. Puede ser un PivotTable objeto, un Table objeto o una cadena. Cuando se pasa un objeto de tabla dinámica, el origen de datos es el origen del PivotTable objeto. Cuando se pasa un Table objeto, el origen de datos es el Table objeto . Cuando se pasa una cadena, se interpreta como el nombre o identificador de una tabla dinámica o tabla.

sourceField

string | Excel.PivotField | number | Excel.TableColumn

Campo del origen de datos por el que se va a filtrar. Puede ser un PivotField objeto, un TableColumn objeto, el identificador de o PivotField el nombre o identificador de un TableColumnobjeto .

slicerDestination

string | Excel.Worksheet

Opcional. Hoja de cálculo en la que se creará la nueva segmentación de datos. Puede ser un Worksheet objeto o el nombre o identificador de una hoja de cálculo. Este parámetro se puede omitir si la colección de segmentación de datos se recupera de una hoja de cálculo.

Devoluciones

Excel.Slicer

La nueva segmentación.

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.getItem("Pivot");
    const slicer = sheet.slicers.add(
        "Farm Sales", /* The slicer data source. For PivotTables, this can be the PivotTable object reference or name. */
        "Type" /* The field in the data source to filter by. For PivotTables, this can be a PivotField object reference or ID. */
    );
    slicer.name = "Fruit Slicer";
    await context.sync();
});

getCount()

Devuelve el número de segmentaciones incluidas en la colección.

getCount(): OfficeExtension.ClientResult<number>;

Devoluciones

OfficeExtension.ClientResult<number>

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

getItem(key)

Obtiene un objeto de segmentación de datos con su nombre o identificador.

getItem(key: string): Excel.Slicer;

Parámetros

key

string

Nombre o identificador de la segmentación de datos.

Devoluciones

Excel.Slicer

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.caption = "Fruit Types";
    slicer.left = 395;
    slicer.top = 15;
    slicer.height = 135;
    slicer.width = 150;
    await context.sync();
});

getItemAt(index)

Obtiene una segmentación basándose en su posición en la colección.

getItemAt(index: number): Excel.Slicer;

Parámetros

index

number

Valor de índice del objeto que se va a recuperar. Indizado con cero.

Devoluciones

Excel.Slicer

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

getItemOrNullObject(key)

Obtiene una segmentación de datos con su nombre o identificador. Si la 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.Slicer;

Parámetros

key

string

Nombre o identificador de la segmentación de datos que se va a recuperar.

Devoluciones

Excel.Slicer

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.SlicerCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SlicerCollection;

Parámetros

options

Excel.Interfaces.SlicerCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

Devoluciones

Excel.SlicerCollection

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

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.SlicerCollection

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

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

Excel.SlicerCollection

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 original Excel.SlicerCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.SlicerCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

toJSON(): Excel.Interfaces.SlicerCollectionData;

Devoluciones

Excel.Interfaces.SlicerCollectionData