Excel.Filter class
テーブルの列のフィルター処理を管理します。
- Extends
注釈
プロパティ
context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
criteria | 指定した列に現在適用されているフィルターです。 |
メソッド
apply(criteria) | 指定の列に、指定したフィルター条件を適用します。 |
apply |
指定した数の要素の列に "下位アイテム" フィルターを適用します。 |
apply |
指定した割合の要素の列に "下位パーセント" フィルターを適用します。 |
apply |
指定した色の列に "セルの色" フィルターを適用します。 |
apply |
指定した条件文字列の列に "アイコン" フィルターを適用します。 |
apply |
指定した条件文字列の列に "アイコン" フィルターを適用します。 |
apply |
列に "動的" フィルターを適用します。 |
apply |
列に "動的" フィルターを適用します。 |
apply |
指定した色の列に "フォントの色" フィルターを適用します。 |
apply |
指定したアイコンの列に "アイコン" フィルターを適用します。 |
apply |
指定した数の要素の列に "上位アイテム" フィルターを適用します。 |
apply |
指定した割合の要素の列に "上位パーセント" フィルターを適用します。 |
apply |
指定した値の列に "値" フィルターを適用します。 |
clear() | 指定した列に適用されているフィルターをクリアします。 |
load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;
プロパティ値
criteria
指定した列に現在適用されているフィルターです。
readonly criteria: Excel.FilterCriteria;
プロパティ値
注釈
メソッドの詳細
apply(criteria)
指定の列に、指定したフィルター条件を適用します。
apply(criteria: Excel.FilterCriteria): void;
パラメーター
- criteria
- Excel.FilterCriteria
適用する基準。
戻り値
void
注釈
applyBottomItemsFilter(count)
指定した数の要素の列に "下位アイテム" フィルターを適用します。
applyBottomItemsFilter(count: number): void;
パラメーター
- count
-
number
表示する下位からの要素の数。
戻り値
void
注釈
applyBottomPercentFilter(percent)
指定した割合の要素の列に "下位パーセント" フィルターを適用します。
applyBottomPercentFilter(percent: number): void;
パラメーター
- percent
-
number
表示する下位からの要素のパーセンテージ。
戻り値
void
注釈
applyCellColorFilter(color)
指定した色の列に "セルの色" フィルターを適用します。
applyCellColorFilter(color: string): void;
パラメーター
- color
-
string
表示するセルの背景色です。
戻り値
void
注釈
applyCustomFilter(criteria1, criteria2, oper)
指定した条件文字列の列に "アイコン" フィルターを適用します。
applyCustomFilter(criteria1: string, criteria2?: string, oper?: Excel.FilterOperator): void;
パラメーター
- criteria1
-
string
最初の条件の文字列です。
- criteria2
-
string
省略可能。 2 つ目の条件の文字列です。
- oper
- Excel.FilterOperator
省略可能。 2 つの条件を結合する方法を記述する演算子です。
戻り値
void
注釈
applyCustomFilter(criteria1, criteria2, operString)
指定した条件文字列の列に "アイコン" フィルターを適用します。
applyCustomFilter(criteria1: string, criteria2?: string, operString?: "And" | "Or"): void;
パラメーター
- criteria1
-
string
最初の条件の文字列です。
- criteria2
-
string
省略可能。 2 つ目の条件の文字列です。
- operString
-
"And" | "Or"
省略可能。 2 つの条件を結合する方法を記述する演算子です。
戻り値
void
注釈
applyDynamicFilter(criteria)
列に "動的" フィルターを適用します。
applyDynamicFilter(criteria: Excel.DynamicFilterCriteria): void;
パラメーター
- criteria
- Excel.DynamicFilterCriteria
適用する動的条件。
戻り値
void
注釈
applyDynamicFilter(criteriaString)
列に "動的" フィルターを適用します。
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;
パラメーター
- 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
注釈
applyFontColorFilter(color)
指定した色の列に "フォントの色" フィルターを適用します。
applyFontColorFilter(color: string): void;
パラメーター
- color
-
string
表示するセルのフォントの色です。
戻り値
void
注釈
applyIconFilter(icon)
指定したアイコンの列に "アイコン" フィルターを適用します。
applyIconFilter(icon: Excel.Icon): void;
パラメーター
- icon
- Excel.Icon
表示するセルのアイコンです。
戻り値
void
注釈
applyTopItemsFilter(count)
指定した数の要素の列に "上位アイテム" フィルターを適用します。
applyTopItemsFilter(count: number): void;
パラメーター
- count
-
number
表示する上位からの要素の数。
戻り値
void
注釈
applyTopPercentFilter(percent)
指定した割合の要素の列に "上位パーセント" フィルターを適用します。
applyTopPercentFilter(percent: number): void;
パラメーター
- percent
-
number
表示する上位からの要素のパーセンテージ。
戻り値
void
注釈
applyValuesFilter(values)
指定した値の列に "値" フィルターを適用します。
applyValuesFilter(values: Array<string | FilterDatetime>): void;
パラメーター
- values
-
Array<string | Excel.FilterDatetime>
表示する値のリスト。 これは、文字列の配列、または Excel.FilterDateTime
オブジェクトの配列である必要があります。
戻り値
void
注釈
clear()
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync()
を呼び出す必要があります。
load(options?: Excel.Interfaces.FilterLoadOptions): Excel.Filter;
パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync()
を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.Filter;
パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync()
を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Filter;
パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select
は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand
は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
toJSON()
API オブジェクトがJSON.stringify()
に渡されたときにより便利な出力を提供するために、JavaScript toJSON()
メソッドをオーバーライドします。 (JSON.stringify
、それに渡されるオブジェクトの toJSON
メソッドを呼び出します)。元の Excel.Filter
オブジェクトは API オブジェクトですが、 toJSON
メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.FilterData
として型指定) を返します。
toJSON(): Excel.Interfaces.FilterData;
戻り値
Office Add-ins