Excel.Filter class

Paquete:

excel

Administra el filtrado de la columna de una tabla.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

Propiedades

context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
criteria	Filtro aplicado actualmente en la columna especificada.

Métodos

apply(criteria)	Aplicar los criterios de filtro especificados en la columna especificada.
applyBottomItemsFilter(count)	Aplicar un filtro de "Elemento inferior" a la columna para el número de elementos especificado.
applyBottomPercentFilter(percent)	Aplicar un filtro de "Porcentaje inferior" a la columna para el porcentaje de elementos especificado.
applyCellColorFilter(color)	Aplicar un filtro de "Color de celda" a la columna para el color especificado.
applyCustomFilter(criteria1, criteria2, oper)	Aplique un filtro "Icon" a la columna para las cadenas de criterios especificadas.
applyCustomFilter(criteria1, criteria2, operString)	Aplique un filtro "Icon" a la columna para las cadenas de criterios especificadas.
applyDynamicFilter(criteria)	Aplicar un filtro "Dinámico" a la columna.
applyDynamicFilter(criteriaString)	Aplicar un filtro "Dinámico" a la columna.
applyFontColorFilter(color)	Aplicar un filtro de "Color de fuente" a la columna para el color especificado.
applyIconFilter(icon)	Aplique un filtro "Icon" a la columna para el icono especificado.
applyTopItemsFilter(count)	Aplicar un filtro de "Elemento superior" a la columna para el número de elementos especificado.
applyTopPercentFilter(percent)	Aplicar un filtro de "Porcentaje superior" a la columna para el porcentaje de elementos especificado.
applyValuesFilter(values)	Aplicar un filtro "Valores" a la columna para los valores especificados.
clear()	Borrar el filtro de la columna especificada.
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 Excel.Filter original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.FilterData) 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

Filtro aplicado actualmente en la columna especificada.

readonly criteria: Excel.FilterCriteria;

Valor de propiedad

Excel.FilterCriteria

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

Detalles del método

apply(criteria)

Aplicar los criterios de filtro especificados en la columna especificada.

apply(criteria: Excel.FilterCriteria): void;

Parámetros

criteria

Excel.FilterCriteria

Criterios que se aplicarán.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

applyBottomItemsFilter(count)

Aplicar un filtro de "Elemento inferior" a la columna para el número de elementos especificado.

applyBottomItemsFilter(count: number): void;

Parámetros

count

number

Número de elementos desde la parte inferior que se van a mostrar.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

applyBottomPercentFilter(percent)

Aplicar un filtro de "Porcentaje inferior" a la columna para el porcentaje de elementos especificado.

applyBottomPercentFilter(percent: number): void;

Parámetros

percent

number

Porcentaje de elementos desde la parte inferior que se van a mostrar.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

applyCellColorFilter(color)

Aplicar un filtro de "Color de celda" a la columna para el color especificado.

applyCellColorFilter(color: string): void;

Parámetros

color

string

Color de fondo de las celdas que se van a mostrar.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

applyCustomFilter(criteria1, criteria2, oper)

Aplique un filtro "Icon" a la columna para las cadenas de criterios especificadas.

applyCustomFilter(criteria1: string, criteria2?: string, oper?: Excel.FilterOperator): void;

Parámetros

criteria1

string

Primera cadena de criterios.

criteria2

string

Opcional. Segunda cadena de criterios.

oper

Excel.FilterOperator

Opcional. El operador que describe cómo se combinan los dos criterios.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

applyCustomFilter(criteria1, criteria2, operString)

Aplique un filtro "Icon" a la columna para las cadenas de criterios especificadas.

applyCustomFilter(criteria1: string, criteria2?: string, operString?: "And" | "Or"): void;

Parámetros

criteria1

string

Primera cadena de criterios.

criteria2

string

Opcional. Segunda cadena de criterios.

operString

"And" | "Or"

Opcional. El operador que describe cómo se combinan los dos criterios.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

applyDynamicFilter(criteria)

Aplicar un filtro "Dinámico" a la columna.

applyDynamicFilter(criteria: Excel.DynamicFilterCriteria): void;

Parámetros

criteria

Excel.DynamicFilterCriteria

Criterios dinámicos que se aplicarán.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

applyDynamicFilter(criteriaString)

Aplicar un filtro "Dinámico" a la columna.

applyDynamicFilter(criteriaString: "Unknown" | "AboveAverage" | "AllDatesInPeriodApril" | "AllDatesInPeriodAugust" | "AllDatesInPeriodDecember" | "AllDatesInPeriodFebruray" | "AllDatesInPeriodJanuary" | "AllDatesInPeriodJuly" | "AllDatesInPeriodJune" | "AllDatesInPeriodMarch" | "AllDatesInPeriodMay" | "AllDatesInPeriodNovember" | "AllDatesInPeriodOctober" | "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | "AllDatesInPeriodSeptember" | "BelowAverage" | "LastMonth" | "LastQuarter" | "LastWeek" | "LastYear" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisQuarter" | "ThisWeek" | "ThisYear" | "Today" | "Tomorrow" | "YearToDate" | "Yesterday"): void;

Parámetros

criteriaString

"Unknown" | "AboveAverage" | "AllDatesInPeriodApril" | "AllDatesInPeriodAugust" | "AllDatesInPeriodDecember" | "AllDatesInPeriodFebruray" | "AllDatesInPeriodJanuary" | "AllDatesInPeriodJuly" | "AllDatesInPeriodJune" | "AllDatesInPeriodMarch" | "AllDatesInPeriodMay" | "AllDatesInPeriodNovember" | "AllDatesInPeriodOctober" | "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | "AllDatesInPeriodSeptember" | "BelowAverage" | "LastMonth" | "LastQuarter" | "LastWeek" | "LastYear" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisQuarter" | "ThisWeek" | "ThisYear" | "Today" | "Tomorrow" | "YearToDate" | "Yesterday"

Criterios dinámicos que se aplicarán.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

applyFontColorFilter(color)

Aplicar un filtro de "Color de fuente" a la columna para el color especificado.

applyFontColorFilter(color: string): void;

Parámetros

color

string

Color de fuente de las celdas que se van a mostrar.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

applyIconFilter(icon)

Aplique un filtro "Icon" a la columna para el icono especificado.

applyIconFilter(icon: Excel.Icon): void;

Parámetros

icon

Excel.Icon

Iconos de las celdas que se van a mostrar.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

applyTopItemsFilter(count)

Aplicar un filtro de "Elemento superior" a la columna para el número de elementos especificado.

applyTopItemsFilter(count: number): void;

Parámetros

count

number

Número de elementos desde la parte superior que se van a mostrar.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

applyTopPercentFilter(percent)

Aplicar un filtro de "Porcentaje superior" a la columna para el porcentaje de elementos especificado.

applyTopPercentFilter(percent: number): void;

Parámetros

percent

number

Porcentaje de elementos desde la parte superior que se van a mostrar.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

applyValuesFilter(values)

Aplicar un filtro "Valores" a la columna para los valores especificados.

applyValuesFilter(values: Array<string | FilterDatetime>): void;

Parámetros

values

Array<string | Excel.FilterDatetime>

Lista de valores que se va a mostrar. Debe ser una matriz de cadenas o una matriz de Excel.FilterDateTime objetos.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

clear()

Borrar el filtro de la columna especificada.

clear(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

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.FilterLoadOptions): Excel.Filter;

Parámetros

options

Excel.Interfaces.FilterLoadOptions

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

Devoluciones

Excel.Filter

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

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

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

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

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

toJSON(): Excel.Interfaces.FilterData;

Devoluciones

Excel.Interfaces.FilterData