データ・アクション・サービス・クラス
いくつかの異なるデータ・アクション・サービス・クラスがあります。
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
クラスは、次の静的メソッドを提供しています:
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
指定されたデータ・アクションをアップグレードするか(
true
)、アップグレードしないか(false
)を示すブールに解決されるPromise
を返します。このメソッドは、データ・アクション・インスタンスを、データ・アクションのコンストラクタと比較して、データ・アクションをアップグレードする必要があるかどうかを決定します。performUpgrade(sCurrentVersion, sUpgradeTopic, oDataActionJS, oActionContext, oUpgradeContext) : Promise
指定されたデータ・アクションでアップグレードを実行し、
Promise
を解決します。アップグレード自体は、データ・アクションのupgrade()
メソッドをコールすることで実行されます(アップグレード自体の要件を満たすのは、アップグレードされるデータ・アクションの特定のサブクラスのみです)。getOrder(sPluginType:String) : Number
データ・アクション・タイプのリストを優先順序にソートするために使用される数値を返します。