JavaScript でのイベントの操作 | Lightning Aura Components Developer Guide (Lightning Aura コンポーネント開発者ガイド)

イベントはコンポーネント間でデータをやり取りします。イベントは、イベントの起動前に値が設定された属性を含めて、それをイベントの処理時に読み取ることができます。

イベントの起動

コンポーネントに登録されたコンポーネントイベントまたはアプリケーションイベントを起動します。

1//Fire a component event
2var compEvent = cmp.getEvent("sampleComponentEvent");
3compEvent.fire();
4
5//Fire an application event
6var appEvent = $A.get("e.c:appEvent");
7appEvent.fire();

詳細は、以下を参照してください。

イベント名の取得

起動されたイベントの名前を取得するには:

1event.getSource().getName();

イベントパラメータの取得

イベントに渡された属性を取得するには:

1event.getParam("value");

イベントのパラメータの取得

イベントに渡されたすべての属性を取得するには:

1event.getParams();

event.getParams() はすべてのイベントパラメータを含むオブジェクトを返します。

イベントの現在のフェーズの取得

イベントの現在のフェーズを取得するには:

1event.getPhase();

イベントが起動されていない場合、event.getPhase() は undefined を返します。コンポーネントイベントとアプリケーションイベントの有効な戻り値は capture、bubble、default です。値イベントは default を返します。詳細は、以下を参照してください。

参照元コンポーネントの取得

イベントを起動したコンポーネントを取得するには:

1event.getSource();

イベントを起動したコンポーネントで属性を取得するには:

1event.getSource().get("v.myName");

イベントの一時停止

起動したイベントを一時停止するには:

1event.pause();

一時停止した場合、event.resume() がコールされるまでイベントは処理されません。イベントは capture または bubble フェーズでのみ一時停止できます。詳細は、以下を参照してください。

デフォルトのイベント実行の防止

イベントでデフォルトアクションをキャンセルするには:

1event.preventDefault();

たとえば、クリックしたときに lightning:button コンポーネントが��ォームを送信するのを防ぐことができます。

一時停止されたイベントの再開

一時停止されたイベントのイベント処理を再開するには:

1event.resume();

一時停止されたイベントは capture または bubble フェーズでのみ再開できます。詳細は、以下を参照してください。

イベントパラメータの値の設定

イベントパラメータの値を設定するには:

1event.setParam("name", cmp.get("v.myName"));

イベントがすでに起動されている場合、パラメータ値を設定してもイベントに影響を与えません。

イベントパラメータの値の設定

イベントでパラメータの値を設定するには:

1event.setParams({
2    key : value
3});

イベントがすでに起動されている場合、パラメータ値を設定してもイベントに影響を与えません。

イベント伝達を停止する

イベントのさらなる伝達を防止するには:

1event.stopPropagation();

イベントの伝達は capture または bubble フェーズでのみ停止できます。