Excel.AutoFilter class

オートフィルターオブジェクトを表します。Represents the AutoFilter object. オートフィルターは、Excel の列の値を、セルの内容に基づいて特定のフィルターに変換します。AutoFilter turns the values in Excel column into specific filters based on the cell contents.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

Extends

プロパティ

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

criteria

オートフィルター範囲のすべてのフィルター条件を含む配列を指定します。An array that holds all the filter criteria in the autofiltered range. 読み取り専用です。Read-Only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

enabled

AutoFilter が有効かどうかを示します。Indicates if the AutoFilter is enabled or not. 読み取り専用です。Read-Only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

isDataFiltered

AutoFilter にフィルター条件が与えられているかどうかを示します。Indicates if the AutoFilter has filter criteria. 読み取り専用です。Read-Only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

メソッド

apply(range, columnIndex, criteria)

指定範囲にオートフィルターを適用します。Applies the AutoFilter to a range. 列インデックスおよびフィルター条件が指定されている場合は、列をフィルター処理します。This filters the column if column index and filter criteria are specified.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

clearCriteria()

オートフィルターのフィルター条件をクリアします。Clears the filter criteria of the AutoFilter.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getRange()

AutoFilter が適用される範囲を表す Range オブジェクトを返します。Returns the Range object that represents the range to which the AutoFilter applies.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getRangeOrNullObject()

AutoFilter が適用される範囲を表す Range オブジェクトを返します。Returns the Range object that represents the range to which the AutoFilter applies. オートフィルターに関連付けられた Range オブジェクトがない場合、このメソッドは null オブジェクトを返します。If there is no Range object associated with the AutoFilter, this method returns a null object.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

reapply()

その範囲で現在指定されている Autofilter オブジェクトを適用します。Applies the specified Autofilter object currently on the range.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

remove()

範囲の AutoFilter を削除します。Removes the AutoFilter for the range.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の Excel のオートフィルターオブジェクトは API オブジェクトですが、 toJSONこのメソッドは、プレーンな JavaScript オブジェクト (として型指定されます) を返します。Excel.Interfaces.AutoFilterData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.AutoFilter object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.AutoFilterData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

プロパティの詳細

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

context: RequestContext;

プロパティ値

RequestContext

criteria

オートフィルター範囲のすべてのフィルター条件を含む配列を指定します。An array that holds all the filter criteria in the autofiltered range. 読み取り専用です。Read-Only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly criteria: Excel.FilterCriteria[];

プロパティ値

Excel.FilterCriteria[]

enabled

AutoFilter が有効かどうかを示します。Indicates if the AutoFilter is enabled or not. 読み取り専用です。Read-Only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly enabled: boolean;

プロパティ値

boolean

isDataFiltered

AutoFilter にフィルター条件が与えられているかどうかを示します。Indicates if the AutoFilter has filter criteria. 読み取り専用です。Read-Only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly isDataFiltered: boolean;

プロパティ値

boolean

メソッドの詳細

apply(range, columnIndex, criteria)

指定範囲にオートフィルターを適用します。Applies the AutoFilter to a range. 列インデックスおよびフィルター条件が指定されている場合は、列をフィルター処理します。This filters the column if column index and filter criteria are specified.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

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

パラメーター

range
Range | string

オートフィルターが適用される範囲を指定します。The range over which the AutoFilter will apply on.

columnIndex
number

オートフィルターが適用される0から始まる列インデックス。The zero-based column index to which the AutoFilter is applied.

criteria
Excel.FilterCriteria

フィルター条件を選択します。The filter criteria.

戻り値

void

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const farmData = sheet.getUsedRange();

    // This filter will only show the rows with the top 25% of values in column 3.
    sheet.autoFilter.apply(farmData, 3, { criterion1: "25", filterOn: Excel.FilterOn.topPercent });
    await context.sync();
});

clearCriteria()

オートフィルターのフィルター条件をクリアします。Clears the filter criteria of the AutoFilter.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

clearCriteria(): void;

戻り値

void

getRange()

AutoFilter が適用される範囲を表す Range オブジェクトを返します。Returns the Range object that represents the range to which the AutoFilter applies.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getRange(): Excel.Range;

戻り値

getRangeOrNullObject()

AutoFilter が適用される範囲を表す Range オブジェクトを返します。Returns the Range object that represents the range to which the AutoFilter applies. オートフィルターに関連付けられた Range オブジェクトがない場合、このメソッドは null オブジェクトを返します。If there is no Range object associated with the AutoFilter, this method returns a null object.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getRangeOrNullObject(): Excel.Range;

戻り値

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(option?: Excel.Interfaces.AutoFilterLoadOptions): Excel.AutoFilter;

パラメーター

戻り値

注釈

このシグネチャに加えて、このメソッドのシグネチャは次のとおりです。In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.AutoFilter-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.AutoFilter - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.AutoFilter-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.AutoFilter - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.AutoFilter-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.AutoFilter - Only available on collection types. これは、前述の署名に似ています。It is similar to the preceding signature. Top は、結果に含めることができるコレクション項目の最大数を指定します。Option.top specifies the maximum number of collection items that can be included in the result. 省略すると、スキップされ、結果に含まれないアイテムの数を指定します。Option.skip specifies the number of items that are to be skipped and not included in the result. Option を指定すると、指定した数のアイテムをスキップした後に結果セットが開始されます。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Excel.AutoFilter;

パラメーター

propertyNames
string | string[]

読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列。A comma-delimited string or an array of strings that specify the properties to load.

戻り値

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.AutoFilter;

パラメーター

propertyNamesAndPaths
{ select?: string; expand?: string; }

ここで、は、読み込むプロパティを指定するコンマで区切られた文字列を指定します。 expand は、読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

戻り値

reapply()

その範囲で現在指定されている Autofilter オブジェクトを適用します。Applies the specified Autofilter object currently on the range.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

reapply(): void;

戻り値

void

remove()

範囲の AutoFilter を削除します。Removes the AutoFilter for the range.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

remove(): void;

戻り値

void

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の Excel のオートフィルターオブジェクトは API オブジェクトですが、 toJSONこのメソッドは、プレーンな JavaScript オブジェクト (として型指定されます) を返します。Excel.Interfaces.AutoFilterData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.AutoFilter object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.AutoFilterData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.AutoFilterData;

戻り値