30日間の無料評価版をお試しいただけます。

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

オプションは、Javascriptオブジェクトとして関数に渡されます。ロードしているレポートのレポート識別子、レポートをロードするHTML要素のelementId(またはelementそのもの)、およびレポートの表示方法を変更するその他のオプションなどがあります。使用可能なオプションは以下のとおりです:

Expand
titleここを展開...

オプション

説明

reportUUID

reportUUIDreportIdwsNameのいずれかが存在する必要があります。
ロードするダッシュボードを識別する固有のIDです。

reportId

reportUUIDreportIdwsNameのいずれかが存在する必要があります。
ロードするレポートを識別する数値のreportIdです。代わりにreportUUIDパラメーターを使用することをお勧めします。

wsName

reportUUIDreportId

...

wsName

...

のいずれかが存在する必要があります。
ロードするレポートを識別するWebサービス名です。代わりにreportUUIDパラメーターを使用することをお勧めします。

elementId

reportUUIDreportIdwsNameのいずれかが存在する必要があります。
レポートをロードするHTML要素のIDです。

element

elementIdelementのいずれかが存在する必要があります。
レポートをロードするHTML要素です。

showTitle

デフォルト:true
falseに設定すると、レポート上部のタイトルバーが省略されます。タイトルバーに含まれるすべての対話型ボタンも省略されます。

showInfo

デフォルト:true
falseに設定すると、タイトルバーの情報ボタンが省略されます。

showFilters

デフォルト:true
falseに設定すると、タイトルバーのフィルターボタンが省略されます。ユーザープロンプトフィルターは表示されません。

showSections

デフォルト:true
falseに設定すると、タイトルバーのセクションボタンが省略されます(タブ形式または複数ページのセクションを使用するレポートの場合)。

showSeries

デフォルト:true
falseに設定すると、タイトルバーのシリーズボタンが省略されます(シリーズ選択オプションを使用するレポートの場合)。

showPageLinks

デフォルト:true
falseに設定すると、タイトルバーの前のページ/次のページボタンが省略されます(複数ページを使用するレポートの場合)。

showExport

デフォルト:true
falseに設定すると、タイトルバーのエクスポートボタンが省略されます。

height

デフォルト:囲み要素の寸法から自動的に検出します。
レポートの高さを上書きするには、数値を設定します。

width

デフォルト:囲み要素の寸法から自動的に検出します。
レポートの幅を上書きするには、数値を設定します。

display

デフォルト:chart
tableに設定すると、レポートの初期状態がテーブルで表示されます。
chartに設定すると、レポートの初期状態がグラフで表示されます。
テーブルとグラフの両方が使用可能でないレポートでは無視されます。

fitTableWidth

デフォルト:true
trueに設定すると、レポートを囲み要素の幅に合わせようとします。

canChangeDisplay

デフォルト:true
falseに設定すると、ユーザーがグラフ表示とテーブル表示を切り替えできるボタンが省略されます。

filters

レポートに渡すフィルター値が格納されているオブジェクトに設定します。

username

これをpasswordパラメーターと共に設定すると、レポートをロードするときに特定のユーザーとして認証されます。ユーザーは制限されているレポートを表示する前に、ログインの詳細を入力する必要がありません。

password

これをusernameパラメーターと共に設定すると、レポートをロードするときに特定のユーザーとして認証されます。

ユニバーサルIDで指定された要素にレポートをロードし、初期の表示オプションをいくつか設定する例を示します:

...

コールバック関数の1番目の引数として返されるフィルターオブジェクトは、レポートで使用されるあらゆるフィルターが格納された配列です。配列の各要素は、そのフィルターに関する情報が格納されたオブジェクトです。これらのフィルターオブジェクトには以下のプロパティがあります:

Expand
titleここを展開...

プロパティ

説明

filterUUID

フィルターの固有識別子です。

filterId

フィルターの数値識別子です。

nativeType

フィルターのネイティブデータタイプです。

description

フィルターの説明です。

operator

フィルターで使用される演算子です。

display

フィルターで使用される表示スタイルです。

dependencies

...

レポートの他のフィルターがこのフィルターに従属している場合は{{true{}}}に設定します。

list

...

フィルターがリストスタイル(複数の値を許可する)の場合は{{true{}}}に設定します。

between

...

フィルターが範囲スタイル(開始値と終了値が必要)の場合は{{true{}}}に設定します。

listValues

フィルターがドロップダウンリストとして表示される場合は、このプロパティに使用可能なオプションのリストが格納されます。

レポートフィルターをロードしてユーザーに表示する例を示します:

...

コールバック関数の1番目の引数として返されるフィルターオブジェクトは、ダッシュボードで使用されるあらゆる分析フィルターと、フィルターグループ区切り文字が格納された配列です。配列の各要素は、そのフィルターまたはフィルターグループに関する情報が格納されたオブジェクトです。これらのオブジェクトには以下のプロパティがあります:

Expand
titleここを展開...

プロパティ

説明

key

このフィルターまたはフィルターグループの固有キーです。

type

...

このオブジェクトがフィルターグループを表す場合は{{FILTERGROUP{}}}に設定します。その他の値は、分析フィルターの種類を示します。

description

フィルターまたはフィルターグループの説明です。

groupId

フィルターグループの場合:グループの数値識別子です。

state

...

フィルターグループの場合:グループが現在オープンの場合は{{OPEN{}}}に設定します。

display

フィルターの場合:フィルターで使用される表示スタイルです。

dependencies

...

フィルターの場合:ダッシュボードの他のフィルターがこのフィルターに従属している場合は{{true{}}}に設定します。

list

...

フィルターの場合:フィルターがリストスタイル(複数の値を許可する)の場合は{{true{}}}に設定します。

between

...

フィルターの場合:フィルターが範囲スタイル(開始値と終了値が必要)の場合は{{true{}}}に設定します。

listValues

フィルターの場合:フィルターがドロップダウンリストとして表示される場合は、このプロパティに使用可能なオプションのリストが格納されます。

Code Block
javascript
javascript
function filterCallback(filters) {

   for (var i = 0; i < filters.length; i++) {
      alert('Filter ' + filters[i].description + ' (' +
         filters[i].key + '), display style: ' +
         filters[i].display);
   }

}

yellowfin.reports.loadReportFilters(1234, filterCallback);

...