フィルターオブジェクト API

フィルターオブジェクト

フィルターオブジェクトは、個別のフィルターを表します。これは、フィルター APIのgetFilter関数を使用して取得できます。

これは多数のプロパティ、リスナー、関数を持ち、開発者はフィルターを操作し、フィルター上で発生するイベントに反応するコードを作成できます。

利用可能なフィルター値

以下に示すように、フィルターオプション「値の入力方法」が「一覧から値を選択」に設定された場合

Yellowfinは、フィルターに利用可能な値の生成を試みます。これらの値は、参照コード値やキャッシュされた値、カスタムクエリーから取得できます。

フロントエンドのフィルターオプションは、以下のようなJavaScript オブジェクトの配列に渡されます。

[{
    value: 'AU', //The value that is actually applied to any queries
    description: 'Australia', //The human readable version of the value
},{
    value: 'NZ',
    description: 'New Zealand'
}]

「value（値）」プロパティは、このフィルターを使用して実行される任意のクエリーに適用される値です。例えばSQLを使用して、上記の一覧の最初の値を選択すると、次のようなSQLクエリーが生成されます。

SELECT Country FROM CountryTable where Country = 'AU'

「description（説明）」プロパティは、ユーザーに表示される値です。これは、フィルタークエリーの一部として使用されることはありません。valueとdescriptionが同じである可能性があります。

プロパティのリファレンス

name（名前）

リターン

String - フィルターの名前です。

説明

フィルターの表示名を返します。これは、フィルターがYellowfin UIに表示されたときに表れる名前です。

読み取り専用

Yes

operator（演算子）

リターン

String - フィルターの大文字演算子です。これは、Yellowfinがクエリー構築時に使用するSQL演算子を決定するために使用する演算子です。

読み取り専用

Yes

利用可能な値

EQUAL - 等しい（=）
NOTEQUAL - と異なる（≠）
GREATER - より大きい（＞）
GREATEREQUAL - 以上（≧）
LESS - より小さい（＜）
LESSEQUAL - 以下（≦）
BETWEEN - の間（～）
NOTBETWEEN - の間でない
INLIST - 一覧に含む
NOTINLIST - 一覧に含まない

例

Demographicフィルターの演算子を表示します。以下の例では、INLIST（一覧に含む）です。

let filter = filter.get('Demographic');
console.log(filter.operator); //outputs 'INLIST'

displayOperator（演算子の表示）

リターン

String - 翻訳された、人間が読めるバージョンのフィルター演算子です。

読み取り専用

Yes

利用可能な値

EQUAL - 等しい（=）
NOTEQUAL - と異なる（≠）
GREATER - より大きい（＞）
GREATEREQUAL - 以上（≧）
LESS - より小さい（＜）
LESSEQUAL - 以下（≦）
BETWEEN - の間（～）
NOTBETWEEN - の間でない
INLIST - 一覧に含む
NOTINLIST - 一覧に含まない

例

let filter = filter.get('Demographic');
console.log(filter.displayOperator); //outputs ‘In List'

注意・制限

これは、人間が読めるバージョンの演算子を取得するヘルパープロパティとして使用されます。演算子に依存する任意のロジックを記述している場合は、代わりにfilter.operatorを使用します。

uuid

リターン

String - フィルターのUUIDです。

読み取り専用

Yes

possibleValues（利用可能な値）

リターン

Array[Object]

説明

フィルターレンダラーが、ユーザーが選択する値を表示するために使用する、利用可能な値のオブジェクト配列です。

[{
    value: 'AU', //The value that is actually applied to any queries
    description: 'Australia', //The human readable version of the value
},{
    value: 'NZ',
    description: 'New Zealand'
}]

このプロパティは、フィルター作成時にフィルタープロパティ「値の入力方法」が「一覧から値を選択」に設定されている場合にのみ値を返します。「一覧から値を選択」以外に設定されている場合、このプロパティはnullを返します。

例

possibleValuesパラメーターを使用して、フィルターのすべての値を選択します。

let possibleValues = filter.possibleValues; //Get the possible values out of the filter
let newFilterValues = []; //Create a new array that will be applied to the valueList function
possibleValues.forEach(valueObject => { //Iterate over the possibleValues and then push the value property to the newFilterValues array
    newFilterValues.push(valueObject.value);
});

filter.setValueList(newFilterValues, true);

between（の間）

リターン

Boolean

説明

フィルターが、「Between（の間）」、または「Not Between（の間ではない）」のような「Between型」の演算子を持つ場合にtrueを返します。これは、カスタム入力要素を記述する場合に、複数の入力要素が必要かどうかを判断する場合に使用できます。これは、フィルターの演算子がBETWEENであるかどうかを確認するための置き換えとして使用してはいけません。

読み取り専用

Yes

list（一覧）

リターン

Boolean

説明

フィルターが、「In List（一覧に含む）」、または「Not In List（一覧に含まない）」のような一覧型の演算子を持つ場合にtrueを返します。これらの演算子は多くの機能を共有するため、その機能を有効にする必要がある場合に便利です。

読み取り専用

Yes

values（値）

リターン

オブジェクト

説明

次のプロパティを含む、オブジェクト内の現在ステージングされている値を持つオブジェクトを返します。

valueOne
valueTwo
valueList

このオブジェクトに含まれるものは、フィルターの演算子に応じて異なります。これは、フィルターのタイプに関連する値のみを返します。

一覧フィルターには、「valueList」のみを含める必要があります。

単一入力フィルターには、「valueOne」のみを含める必要があります。

betweenフィルターには、「valueOne」と「valueTwo」を含める必要があります。

読み取り専用

Yes

例

「in List（一覧に含む）」の例

let filter = filters.getFilter('Demographic');
filter.setValues(['Adventure']);

console.log(filter.values); //Outputs { valueList: ['Adventure'] }

「Between（の間）」の例

let filter = filters.getFilter('Age at Camp');
filter.setValueOne(15);
filter.setValueTwo(35);
console.log(filter.values); //Outputs { valueOne: 15, valueTwo: 35 };

「単一入力」の例

let filter = filters.getFilter('Age at Camp');
filter.setValueOne(15);
console.log(filter.values); //Outputs { valueOne: 15 };

valueOne

リターン

String、またはNumber

説明

フィルターに現在ステージングされているvalueOneを返します。フィルターが一覧フィルターの場合、これはnullを返します。

読み取り専用

True

例

let filter = filters.getFilter('Average Age at Camp');
filter.setValueOne(35);
console.log(filter.valueOne); //Outputs '35' 

valueTwo

リターン

String、またはNumber

説明

フィルターに現在ステージングされているvalueTwoを返します。フィルターが一覧フィルター、または単一入力フィルターの場合、これはnullを返します。

読み取り専用

True

例

let filter = filters.getFilter('Average Age at Camp');
filter.setValueTwo(65);
console.log(filter.valueTwo); //Outputs '65' 

valueList

リターン

Array{String/Number}

説明

フィルターに現在ステージングされているvalueList値を返します。「単一入力」、または「Between」フィルターの場合、これはnullを返します。

読み取り専用

True

例

let filter = filters.getFilter('Demographic');
filter.setValueList['Adventure', 'Luxury']);
console.log(filter.valueList); //Outputs ['Adventure', Luxury']

appliedValues（適用された値）

リターン

オブジェクト

説明

次のプロパティを含むオブジェクトに現在適用されているフィルター値を返します。

valueOne
valueTwo
valueList

このオブジェクトに含まれるものは、フィルターの演算子に応じて異なります。フィルターのタイプに関連する値のみを返します。

一覧フィルターには、「valueList」のみを含める必要があります。

単一入力フィルターには、「valueOne」のみを含める必要があります。

betweenフィルターには、「valueOne」と「valueTwo」を含める必要があります。

読み取り専用

Yes

例

「in List（一覧に含む）」の例

let filter = filters.getFilter('Demographic');
filter.setValues(['Adventure'], true); //Set the value and apply

console.log(filter.appliedValues); //Outputs { valueList: ['Adventure'] }

「Between（の間）」の例

let filter = filters.getFilter('Age at Camp');
filter.setValueOne(15);
filter.setValueTwo(35);
filter.applyFilter(); //Apply the values
console.log(filter.appliedValues); //Outputs { valueOne: 15, valueTwo: 35 };

「単一入力」の例

let filter = filters.getFilter('Age at Camp');
filter.setValueOne(15, true);
console.log(filter.appliedValues); //Outputs { valueOne: 15 };

appliedValueOne

リターン

String、またはNumber

説明

現在valueOneが適用されているフィルターを返します。フィルターが一覧フィルターの場合、これはnullを返します。

読み取り専用

True

例

let filter = filters.getFilter('Average Age at Camp');
filter.setValueTwo(35, true); //Set valueTwo and apply it
console.log(filter.appliedValueOne); //Outputs '35' 

appliedValueTwo

リターン

String、またはNumber

説明

現在valueTwoが適用されているフィルターを返します。フィルターがbetweenフィルターではない場合、これはnullを返します。

読み取り専用

True

例

let filter = filters.getFilter('Average Age at Camp');
filter.setValueTwo(65, true); //Set valueTwo and apply it
console.log(filter.appliedValueTwo); //Outputs '65' 

appliedValueList

リターン

Array{String/Number}

説明

現在valueListが適用されているフィルターを返します。単一入力、またはBetweenフィルターの場合、これはnullを返します。

読み取り専用

True

例

let filter = filters.getFilter('Demographic');
filter.setValueList['Adventure', 'Luxury']);

filter.applyFilter();
console.log(filter.appliedValueList); //Outputs ['Adventure', Luxury']

defaultValues（デフォルト値）

リターン

オブジェクト

説明

次のプロパティを含むオブジェクトのフィルターデフォルト値を返します。

valueOne
valueTwo
valueList

このオブジェクトに含まれるものは、フィルターの演算子に応じて異なります。フィルターのタイプに関連する値のみを返します。betweenフィルターにデフォルトで下限値は設定されているが上限値は設定されていない場合、valueOneが設定され、valueTwoにはnullが設定されます。

一覧フィルターには、「valueList」のみを含める必要があります。

単一入力フィルターには、「valueOne」のみを含める必要があります。

betweenフィルターには、「valueOne」と「valueTwo」を含める必要があります。

読み取り専用

Yes

例

「in List（一覧に含む）」の例

let filter = filters.getFilter('Demographic');
console.log(filter.defaultValues); //Outputs { valueList: ['Adventure'] }

「Between（の間）」の例

let filter = filters.getFilter('Age at Camp');
console.log(filter.defaultValues); //Outputs { valueOne: 15, valueTwo: 35 };

「単一入力」の例

let filter = filters.getFilter('Age at Camp');
console.log(filter.defaultValues); //Outputs { valueOne: 15 };

defaultValueOne

リターン

String、またはNumber

説明

フィルターのデフォルトvalueOneを返します。これは、コンテンツ作成中にフィルターにデフォルト値が設定された場合にのみ値を返します。フィルターが一覧型の場合は、nullを返します。

読み取り専用

True

例

let filter = filters.getFilter('Average Age at Camp');
console.log(filter.defaultValueOne); 

defaultValueTwo

リターン

String、またはNumber

説明

フィルターのデフォルトvalueTwoを返します。これは、コンテンツ作成中にフィルターにデフォルト値が設定された場合にのみ値を返します。フィルターがbetween型ではない場合、常にnullを返します。

読み取り専用

True

例

let filter = filters.getFilter('Average Age at Camp');
console.log(filter.defaultValueTwo); 

defaultvValueList

リターン

Array{String/Number}

説明

フィルターのデフォルトvalueListを返します。これは、コンテンツ作成中にフィルターにデフォルト値が設定された場合にのみ値を返します。フィルターが一覧型ではない場合、常にnullを返します。

読み取り専用

True

例

let filter = filters.getFilter('Demographic');
console.log(filter.defaultValueList); 

関数のリファンレンス

reset(apply)（リセット）

リターン

なし

説明

現在のフィルターをデフォルト値にリセットします。applyパラメーターがtrueの場合、フィルターが存在するレポート、またはダッシュボードにも即座にフィルターが適用されます。

パラメーター

Apply - Boolean - デフォルト：True

例

「Athlete Country」フィルターは、デフォルト値として['AU','NZ']を持ちます。

filter.setValue(['UK', 'US']);

console.log(filter.values); //Outputs {valueList: ['UK', 'US'] }

filter.reset();

console.log(filter.values); //Outputs {valueList: ['AU', 'NZ']

clear(apply)（クリア）

リターン

なし

説明

フィルターから値をクリアし、applyがtrueの場合はレポート、またはダッシュボードを実行します。すべての値は、未定義に設定されます。

パラメーター

Apply - Boolean - デフォルト：True

例

「Athlete Country」フィルターは、デフォルト値として['AU','NZ']を持ちます。

filter.setValue(['UK', 'US']);

console.log(filter.values); //Outputs {valueList: ['UK', 'US'] }

filter.clear();

console.log(filter.values); //Outputs {valueList: null]}

resetToLastAppliedState()（最後に適用した状態へリセット）

リターン

なし

説明

フィルター値を現在の値から適用された値のオブジェクトにリセットします、これは、フィルターをコンテンツが実行された最後の状態に戻すことができるため、「アンドゥ（元に戻す）」機能として使用できます。

例

filter.setValue(['UK', 'US']);
filter.apply(); //Set the value on the report

filter.setValue(['DE']);
console.log(filter.values); //Outputs {valueList: ['DE'] }

filter.resetToLastAppliedState();

console.log(filter.values); //Outputs {valueList: ['UK', 'US']}

setValueOne(value, apply)（ValueOneを設定）

リターン

なし

説明

valueOneの値を設定します。applyがtrueの場合は、レポート、またはダッシュボードの実行もします。

値としてNullを指定することもできますが、ユーザーの観点から見ると、これはvalueOneをクリアするだけです。

一覧演算子（In List、またはNot In List）を使用するときにSetValueOneが呼び出された場合、この呼び出し全体は何も実行しません。

パラメーター

value - String, Number

apply - Boolean - デフォルト：false

例

filter.setValueOne('Relaxation'); //Change the value to Relaxtion but don't immediately run the report

console.log(filter.valueOne); //Should return 'Relaxation'

setValueTwo(value, apply)（ValueTwoを設定）

リターン

なし

説明

valueTwoの値を設定します。applyがtrueの場合は、レポート、またはダッシュボードの実行もします。

値としてNullを指定することもできますが、ユーザーの観点から見ると、これはvalueTwoをクリアするだけです。

Between、またはNot Betweenではない演算子を使用するときにSetValueTwoが呼び出された場合、この関数の呼び出しは何も実行しません。

パラメーター

value - String, Number

apply - Boolean - デフォルト：false

例

//Filter is a between filter (Average Age at Camp)
filter.setValueOne(15);
filter.setValueTwo(35);

console.log(filter.valueOne + " to " + filter.valueTwo); //Should output "15 to 35"

setValueList(valueList, apply)（ValueListを設定）

リターン

なし

説明

値オブジェクトのValueListプロパティ設定します。applyパラメーターがtrueの場合は、レポート、またはダッシュボードに即座にフィルターを適用できます。

一覧演算子で使用される場合、配列をそのままフィルターに適用します。

単一の値の演算子で使用される場合、配列の最初に値にvalueOneが設定されます。

between演算子を使用しているフィルターで呼び出された場合、配列の最初の値にvalueOneが設定され、二番目の値にvalueTwoが設定されます。

パラメーター

valueList - Array

apply - Boolean - デフォルト：false

例

//Set the value of the filter "Demographic" to be Adventure, Family, Sport
filter.setValueList(['Adventure', 'Family', 'Sport']);

//Set the values and immediately apply the filter
filter.setValueList(['Adventure', 'Relaxation'], true);

//Can also be used to set the between values in Average Age at Camp
filter.setValueList([15, 35]);

filter.setValueList([15]);

setValue(value, apply)

リターン

なし

説明

渡された値を正確な位置に適用しようとする、すべての関数を取得します。applyがtrueの場合、レポートにも即座に適用されます。

異なるタイプの「value（値）」を渡すときに、様々なことが起こります。

valueがNumber、またはStringの場合

listfilterでは、単一の値を選択した場合と同様に処理されます。これは、次を呼び出すのと同じことです。

filter.setValueList(['single value']);

between、または単一入力フィルターは、渡される値にvalueOneを設定します。これは、次のようになります。

filter.setValueOne('first value');

valueがArrayの場合

一覧フィルターは、配列をそのvalueList属性に直接適用します。

between、または単一入力フィルターは、最初の値を配列から取得し、これをフィルターvalueOne属性に適用します。

betweenフィルターは二番目の値を配列から取得し、これをフィルターvalueTwo属性に適用します。

filter.setValue([15, 35]);

betweenフィルターでは、次と同じ結果になります。

filter.setValueOne(15);
filter.setValueTwo(35);

valueがオブジェクトの場合

between、および単一入力フィルターはオブジェクトの「valueOne」属性を検索し、それを使用してフィルターvalueOne属性を設定します。

betweenフィルターはオブジェクトの「valueTwo」属性も検索し、フィルターvalueTwo属性の設定に使用します。

一覧フィルターはvalueList属性を検索し、これを使用してフィルターvalueList属性を設定します。

パラメーター

value - String, Number, Array, Object

apply - Boolean - デフォルト：false

例

オブジェクトでbetweenフィルターを使用する場合

let filter = filters.getFilter('Age at Camp');
filter.setValue({
valueOne: 15, //Sets valueOne to 15
valueTwo: 35 //Sets valueTwo to 35
valueList: [1,2,3,4,5] //Ignored
});

filter.setValue({
valueOne: 15, //Sets valueOne to 15
valueTwo: 35 //Sets valueTwo to 35
});

一覧フィルターでオブジェクトと配列を使用する場合

let filter = filters.getFilter('Demographic');
filter.setValue(['Adventure']); //Using an array

filter.setValue({ valueList: ['Adventure'] }); //Using an object

applyFilter()（フィルターの適用）

リターン

なし

説明

フィルターの現在のステージング値、valueOne、valueTwo、valueListを、これらのオブジェクトに対応する値にコピーします。valueOneとappliedValueOne、valueTwoとappliedValueTwo、およびvalueListとappliedValueListに変更があった場合は、変更された値を使用して「applied」イベントがトリガーされます。詳細は、こちらを参照してください。

例

Demographicフィルターに、値Adventureを適用します。

let filter = filters.getFilter('Demographic');
filter.setValue(['Adventure']);
filter.applyFilter();

setPossibleValues(values)（利用可能な値の設定）

リターン

なし

説明

フィルターの「possiblevalues」を渡された配列に更新します。配列が渡されると、フィルターはその値を更新し、それに応じてYellowfin UIウィジェットも更新されます。nullが渡された場合、利用可能な値はクリアされます。他のタイプのオブジェクトが渡された場合は、無視されます。

渡される配列は、「value」と「description」プロパティを含むオブジェクトの配列である必要があります。

「value」プロパティは、フィルター値が選択されたときに、SQLクエリーの一部として適用されます。「description」プロパティは、ユーザーに表示されます。多くの場合、これらは同じである可能性があります。しかし、「description」プロパティを使用して翻訳を処理したり、値を人間が読める形式にすることができます。

[{
    value: {Number, String},
    description: {String}
}]

値は、一覧に追加された順序で表示されます。

例

Demographicフィルターの現在のフィルターオプションにDemographicを追加します。

let possibleValues = filter.possibleValues;
possibleValues.push({
    value: 'Relaxation',
    description: 'Relaxation'
});
filter.setPossibleValues(possibleValues);

独自の値を使用して、利用可能な値の配列全体を上書きます。

let possibleValues = [];
possibleValues.push({
    value: 'FIRST', //The data that is stored in the table for this filter is upper case.
    description: 'First' //Upper case can be painful to read, so put a more readable version to be displayed in the description
});

possibleValues.push({
  value: 'SECOND',
  description: 'Second'
});

filter.setPossibleValues(possibleValues);

注意・制限

フィルターがフィルター階層の一部である場合、親フィルターが変更されてこのフィルターに新しい値が送られると、このプロパティで設定した値は上書きされます。

addEventListener(eventName, callbackFunction)（イベントリスナーの追加）

リターン

Number

説明

特定のイベントが発生するたびにcallbackFunctionを呼び出すイベントにリスナーを作成します。

イベントが設定されると、一意のIDが割り当てられ、この関数の結果として返されます。このIDは、removeEventListener関数によって使用され、コールバックの使用が終了したときにこれを削除します。レポートのロードおよびアンロードを必要とするアプリケーションを作成する場合は、これらのリスナーIDをトラッキングして、不要になったときに削除できるようにすることをお勧めします。

このAPIが自身をトリガーするイベントの詳細について、イベントのリファレンス項目を参照してください。

また、開発者が独自のイベント（.trigger()を参照）をトリガーすることも可能であり、この関数を使用してリッスンすることができます。

例

変更されたオブジェクトのリスナーを作成し、イベントが発生したら、これを削除します。

let eventListenerId = filter.addEventListener('changed', function(event) {
console.log(event.filter.name + ' changed value');
filter.removeEventListener(eventListenerId);
});

removeEventListener(listenedId)（イベントリスナーの削除）

リターン

なし

説明

渡されたリスナーIDに関連するコールバック関数を削除します。これは、コールバック関数に関連付けられたイベントが発生したときに、そのコールバックが起動されなくなることを意味します。

例

let eventListenerId = filters.addEventListener('changed', function(event) {
    console.log('One of my filters changed');
    filters.removeEventListener(eventListenerId);
});

trigger(eventName, eventData)

リターン

なし

説明

フィルターオブジェクト上でイベントをトリガーし、そのイベントに作成されたリスナー関数を呼び出します。これを使用して、アプリケーションに設定したカスタムイベントをトリガーできます。

例

カスタムフィルター入力を使用する場合、フィルタークリックイベントをトリガーできます。これにより、アプリケーションの他の部分が反応できます。

//Add a 'userClick' listener to the filter object, which we will set up a trigger for later on.
filters.addEventListener('userClick', function(event) {
    console.log('A user clicked on the element ' + event.element + ' which is tied to this filter');
});
//Get the custom filter list from the DOM and create a click listener on that which will trigger userClicked events on the filter
let myCustomFilterList = document.querySelector(‘div#customFilterList’)
myCustomFilterList .addEventListener('click', function(e) {
    filters.trigger('userClicked', { element: e.currentTarget } );
});

イベントのリファンレンス

ユーザーや、コードの一部が特定のアクションを実行したときに、フィルターオブジェクト上でトリガーされる様々なイベントがあります。

フィルターオブジェクトを通してトリガーされるイベントは、フィルターUUIDとフィルターオブジェクト自体を含むオブジェクトを持ちます。

filter.addEventListener('changed', function(event) {
      console.log(event.uuid); //The filters UUID that the event was triggered from
      console.log(event.filter);//The FilterObject that the event was triggered from
});

changed（変更）

説明

任意のフィルター値を変更することで発生します。変更された値と、それらすべての値の以前の値を含むオブジェクトがトリガーされます。

パラメーター

Event - Object

次を含みます。

uuid - String - イベントをトリガーしたフィルターのUUIDです。
filter - FilterObject - イベントをトリガーしたフィルターのフィルターオブジェクトです。
changed - Object - 変更された値を含むオブジェクトです。valueOne、valueTwo、valueListを含めることができます。
Previous - Object - 変更されたすべての値の以前の値を含むオブジェクトです。valueOne、valueTwo、valueListを含めることができます。

例

filter.addEventListener('applied', function(event) {
console.log(event.filter.name + " has just been applied with the following changed values " + JSON.stringify(event.changed));
});

applied（適用）

説明

フィルターがリンクされたコンテンツ（レポート・ダッシュボード）に適用されることで発生します。そして、適用された値を変更します。

パラメーター

Event - Object

次を含みます。

uuid - String - イベントをトリガーしたフィルターのUUIDです。
filter - FilterObject - イベントをトリガーしたフィルターのフィルターオブジェクトです。
changed - Object - 変更された値を含むオブジェクトです。valueOne、valueTwo、valueListを含めることができます。
Previous - Object - 変更されたすべての値の以前の値を含むオブジェクトです。valueOne、valueTwo、valueListを含めることができます。

例

filter.addEventListener('applied', function(event) {
console.log(event.filter.name + " has just been applied with the following changed values " + JSON.stringify(event.changed));
});

注意・制限

適用されたイベントは、以下のような場合にトリガーされる可能性があります。

let filter = filters.getFilter('Demographic');
filter.setValue(['Adventure']);
filter.apply();

filter.setValue(['Adventure']);
filter.apply();

コードがsetValueを呼び出すときに、新しい配列を作成するためです。そのため、比較が行われるのは配列から配列です。

正しい値がレポートに適用されます。

reset（リセット）

説明

フィルターでリセット関数が呼び出されることで発生します。これは、ユーザーインタラクション、フィルターメニューのリセットボタンのクリック、開発者が明示的に呼び出した場合に発生します。

例

filter.addEventListener('reset', function(event) {
console.log(event.filter.name + " has just been reset");
});

パラメーター

Event - Object

次を含みます。

uuid - String - イベントをトリガーしたフィルターのUUIDです。
filter - FilterObject - イベントをトリガーしたフィルターのフィルターオブジェクトです。

cleared（クリア）

説明

フィルターでクリア関数が呼び出されることで発生します。これは、ユーザーインタラクション、または開発者が明示的に呼び出した場合に発生します。

clearedとresetの違い

フィルターをリセットすると、デフォルト値にリセットされます。フィルターをクリアすると、値を持たないように設定されます。

パラメーター

Event - Object

次を含みます。

uuid - String - イベントをトリガーしたフィルターのUUIDです。
filter - FilterObject - イベントをトリガーしたフィルターのフィルターオブジェクトです。

例

filter.addEventListener(cleared, function(event) {
console.log(event.filter.name + " has just had its values cleared");
});