データ・アクション・サービス・クラス

DataActionManager

DataActionManagerとのすべての通信では、ClientEventsが使用されます。DataActionManagerは次の目的でイベント・ハンドラを実装しています:

DataActionContext、EnvironmentContext

データ・アクションが起動されると、DataActionContextクラスには、ターゲットに渡されるコンテキストが含まれます。

getColumnValueMap()
属性列名をキーとした属性列値のマップを返します。これらは、データ・アクションの起動元となるデータ・ポイントの修飾データ参照を定義します。
getLogicalFilterTrees()
データ・アクションが起動される特定のデータ・ポイントの修飾データ参照を記述するLogicalFilterTreesオブジェクトを戻します(詳細は、InteractionServiceを参照してください)。
getEnvironmentContext()
次のようなソース環境を記述したEnvironmentContextクラスのインスタンス:
- getProjectPath()
- getCanvasName()
- getUserID()
- getUserName()
getReport()
データ・アクションが起動されるレポートを返します。

DataActionHandler

DataActionHandlerクラスは、様々なデータ・アクション拡張を登録します。そのAPIは、他の拡張ハンドラ(たとえば、VisualizationHandler)と幅広く一貫しています。

DataActionHandlerクラスには、次のパブリック・メソッドがあります:

getClassName(sPluginType:String) : String
指定されたデータ・アクション・タイプの完全修飾クラス名を返します。
getDisplayName(sPluginType:String) : String
指定したデータ・アクション・タイプの変換済表示名を返します。
getOrder(sPluginType:String) : Number
データ・アクションのタイプのリストを優先順序にソートする際に使用する数値を返します。

DataActionHandlerクラスは、次のstaticメソッドを提供します:

getDependencies(oPluginRegistry:Object) : Object.<String, Array>
すべての登録済データ・アクション・タイプをカバーする依存性マップを返します。
getHandler(oPluginRegistry:Object, sExtensionPointName:String, oConfig:Object) : DataActionPluginHandler
DataActionHandlerクラスの新しいインスタンスを構成し、戻します。

DataActionUpgradeHandler

DataActionUpgradeHandlerクラスは、レポートを開くときにUpgradeServiceによってコールされます。

DataActionHandlerクラスには、次の2つの主要なメソッドがあります:

deferredNeedsUpgrade(sCurrentVersion, sUpgradeTopic, oDataActionJS, oActionContext) : Promise
Promiseを返します。このブール値は、指定したデータ・アクションをアップグレードする必要があるのか(true)、アップグレードしないのか(false)を示します。このメソッドは、データ・アクション・インスタンスを、データ・アクションのコンストラクタと比較して、データ・アクションをアップグレードする必要があるかどうかを決定します。
performUpgrade(sCurrentVersion, sUpgradeTopic, oDataActionJS, oActionContext, oUpgradeContext) : Promise
指定されたデータ・アクションでアップグレードを実行し、Promiseを解決します。アップグレード自体は、データ・アクションでupgrade()メソッドをコールすることによって実行されます(アップグレードされるデータ・アクションの特定のサブクラスのみがアップグレード自体に対して適格です)。
getOrder(sPluginType:String) : Number
データ・アクションのタイプのリストを優先順序にソートする際に使用する数値を返します。