Excel.AutoFilter class

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

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

readonly criteria: Excel.FilterCriteria[];

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Especifica si el autofiltro está habilitado.

readonly enabled: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Especifica si autofiltro tiene criterios de filtro.

readonly isDataFiltered: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

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

Devoluciones

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();
});

Borra los criterios de filtro de columna del Autofiltro.

clearColumnCriteria(columnIndex: number): void;

Parámetros

Devoluciones

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();
});

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

clearCriteria(): void;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

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

getRange(): Excel.Range;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

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

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

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

Devoluciones

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

Devoluciones

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

Devoluciones

Aplica el objeto AutoFilter especificado actualmente en el intervalo.

reapply(): void;

Devoluciones

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();
});

Quita el AutoFilter para el intervalo.

remove(): void;

Devoluciones

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();
});

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