Excel.AutoFilter class

Paquete:

excel

Representa el AutoFilter objeto . Autofiltro convierte los valores de la columna de Excel en filtros específicos basados en el contenido de la celda.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Propiedades

context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
criteria	Matriz que contiene todos los criterios de filtro de un intervalo autofiltrado.
enabled	Especifica si el autofiltro está habilitado.
isDataFiltered	Especifica si autofiltro tiene criterios de filtro.

Métodos

apply(range, columnIndex, criteria)	Aplica el objecto AutoFilter a un rango. Esto filtra la columna si se especifican el índice de columna y los criterios de filtro.
clearColumnCriteria(columnIndex)	Borra los criterios de filtro de columna del Autofiltro.
clearCriteria()	Borra los criterios de filtro y el estado de ordenación del Autofiltro.
getRange()	Devuelve el Range objeto que representa el intervalo al que se aplica el Autofiltro.
getRangeOrNullObject()	Devuelve el Range objeto que representa el intervalo al que se aplica el Autofiltro. Si no hay ningún Range objeto asociado al Autofiltro, 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.
reapply()	Aplica el objeto AutoFilter especificado actualmente en el intervalo.
remove()	Quita el AutoFilter para el intervalo.
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.AutoFilter original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.AutoFilterData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

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

criteria

Matriz que contiene todos los criterios de filtro de un intervalo autofiltrado.

readonly criteria: Excel.FilterCriteria[];

Valor de propiedad

Excel.FilterCriteria[]

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

enabled

Especifica si el autofiltro está habilitado.

readonly enabled: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

isDataFiltered

Especifica si autofiltro tiene criterios de filtro.

readonly isDataFiltered: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Detalles del método

apply(range, columnIndex, criteria)

Aplica el objecto AutoFilter a un rango. Esto filtra la columna si se especifican el índice de columna y los criterios de filtro.

apply(range: Range | string, columnIndex?: number, criteria?: Excel.FilterCriteria): void;

Parámetros

range

Excel.Range | string

Intervalo en el que se aplicará el Autofiltro.

columnIndex

number

Índice de columna de base cero al que se aplica el Autofiltro.

criteria

Excel.FilterCriteria

Criterios de filtro.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml

// This function adds a percentage AutoFilter to the active worksheet 
// and applies the filter to a column of the used range.
await Excel.run(async (context) => {
    // Retrieve the active worksheet and the used range on that worksheet.
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const farmData = sheet.getUsedRange();

    // Add a filter that will only show the rows with the top 50% of values in column 3.
    sheet.autoFilter.apply(farmData, 3, {
        criterion1: "50",
        filterOn: Excel.FilterOn.topPercent
    });

    await context.sync();
});

clearColumnCriteria(columnIndex)

Borra los criterios de filtro de columna del Autofiltro.

clearColumnCriteria(columnIndex: number): void;

Parámetros

columnIndex

number

Índice de columna de base cero, que representa qué filtro de columna debe borrarse. Si no se admite el valor de índice (por ejemplo, si el valor es un número negativo o si el valor es mayor que el número de columnas disponibles en el intervalo), se producirá un InvalidArgument error.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.14 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml

// This function clears the AutoFilter setting from one column.
await Excel.run(async (context) => {
    // Retrieve the active worksheet.
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // Clear the filter from only column 3.
    sheet.autoFilter.clearColumnCriteria(3);
    await context.sync();
});

clearCriteria()

Borra los criterios de filtro y el estado de ordenación del Autofiltro.

clearCriteria(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

getRange()

Devuelve el Range objeto que representa el intervalo al que se aplica el Autofiltro.

getRange(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

getRangeOrNullObject()

Devuelve el Range objeto que representa el intervalo al que se aplica el Autofiltro. Si no hay ningún Range objeto asociado al Autofiltro, 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).

getRangeOrNullObject(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

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.AutoFilterLoadOptions): Excel.AutoFilter;

Parámetros

options

Excel.Interfaces.AutoFilterLoadOptions

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

Devoluciones

Excel.AutoFilter

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

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

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

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

reapply()

Aplica el objeto AutoFilter especificado actualmente en el intervalo.

reapply(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml

// This function refreshes the AutoFilter to ensure that changes are captured.
await Excel.run(async (context) => {
    // Retrieve the active worksheet.
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // Reapply the filter to capture changes.
    sheet.autoFilter.reapply();
    await context.sync();
});

remove()

Quita el AutoFilter para el intervalo.

remove(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml

// This function removes all AutoFilters from the active worksheet.
await Excel.run(async (context) => {
    // Retrieve the active worksheet.
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // Remove all filters.
    sheet.autoFilter.remove();
    await context.sync();
});

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.AutoFilter original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.AutoFilterData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.AutoFilterData;

Devoluciones

Excel.Interfaces.AutoFilterData