Page History
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
<script src="http://localhost/JsAPI" type="text/javascript"></script>
<script type="text/javascript">
if (!window.yellowfin) {
alert('Error loading API');
}
</script>
|
...
サーバー情報
| Styleclass | ||
|---|---|---|
| ||
After loading the API, some server information is made available:APIをロードすると、一部のサーバー情報を使用できるようになります：
| Expand | |||
|---|---|---|---|
| |||
|
...
|
...
|
...
The release version of Yellowfin running on the server (eg. "6.1")
|
...
|
...
|
...
|
...
|
...
|
...
The schema version of the Yellowfin configuration database
|
例
| Code Block | ||||
|---|---|---|---|---|
| ||||
<script src="http://localhost/JsAPI" type="text/javascript"></script>
<script type="text/javascript">
if (window.yellowfin) {
alert('Yellowfin API loaded. Version: ' + yellowfin.apiVersion);
}
</script>
|
...
オプションは、Javascriptオブジェクトとして関数に渡されます。ロードしているレポートのレポート識別子、レポートをロードするHTML要素のelementId（またはelementそのもの）、およびレポートの表示方法を変更するその他のオプションなどがあります。使用可能なオプションは以下のとおりです：
| Expand | |||
|---|---|---|---|
| |||
|
...
|
...
|
...
|
...
|
...
wsName
...
Either reportUUID, reportId or wsName must be present.The Web Service name identifying the report to load. It is recommended to use the reportUUID parameter instead.
...
elementId
...
Either elementId or element must be present.The id of the html element in which to load the report.
...
element
...
Either elementId or element must be present.The html element in which to load the report.
...
showTitle
...
Default: trueSet to false to omit the title bar at the top of the report. All interactive buttons included in the title bar will also be omitted.
...
showInfo
...
Default: trueSet to false to omit the Info button in the title bar.
...
showFilters
...
Default: trueSet to false to omit the Filters button in the title bar. Any user-prompt filters will not be displayed.
...
showSections
...
Default: trueSet to false to omit the Sections button in the title bar (for reports with tabbed or multi-page sections).
...
showSeries
|
例
ユニバーサルIDで指定された要素にレポートをロードし、初期の表示オプションをいくつか設定する例を示します：
| Code Block | ||||
|---|---|---|---|---|
| ||||
var options = {};
options.reportUUID = 'e5e5aaf3-c3b8-4f9b-8280-e21e4d848e63';
options.elementId = 'myReport';
options.showFilters = 'false';
options.showSeries = 'false';
options.display = 'chart';
options.fitTableWidth = 'false';
|
...
Default: trueSet to false to omit the Series button in the title bar (for reports with the series selection option).
...
showPageLinks
...
Default: trueSet to false to omit the previous page/next page button in the title bar (for reports with multiple pages).
...
showExport
...
Default: trueSet to false to omit the Export button in the title bar.
...
height
...
Default: automatically detected from the dimensions of the enclosing elementSet this to a numeric value to override the report height.
...
width
...
Default: automatically detected from the dimensions of the enclosing elementSet this to a numeric value to override the report width.
...
display
...
Default: chartSet to table to display the report initially as a table.Set to chart to display the report initially as a chart.This is ignored for reports that do not have both table and chart available.
...
fitTableWidth
...
Default: trueSet to true to attempt to scale the report to the width of the enclosing element.
...
canChangeDisplay
...
Default: trueSet to false to omit the buttons that allow the user to switch between chart and table display.
...
filters
...
Set to an object containing filter values to pass to the report.
...
username
...
Set this along with the password parameter to authenticate as a particular user when loading the report. This avoids the need for users to enter their login details before viewing restricted reports.
...
password
...
Set this along with the username parameter to authenticate as a particular user when loading the report.
例
ユニバーサルIDで指定された要素にレポートをロードし、初期の表示オプションをいくつか設定する例を示します：
| Code Block | ||
|---|---|---|
| javascript | javascript |
var options = {};
options.reportUUID = 'e5e5aaf3-c3b8-4f9b-8280-e21e4d848e63';
options.elementId = 'myReport';
options.showFilters = 'false';
options.showSeries = 'false';
options.display = 'chart';
options.fitTableWidth = 'false';
yellowfin.loadReport(options);
|
...
コールバック関数の1番目の引数として返されるフィルターオブジェクトは、レポートで使用されるあらゆるフィルターが格納された配列です。配列の各要素は、そのフィルターに関する情報が格納されたオブジェクトです。これらのフィルターオブジェクトには以下のプロパティがあります：
| Expand | |||
|---|---|---|---|
| |||
|
...
|
...
|
...
The native data type of the filter.
...
説明
...
The 説明 of the filter.
...
operator
...
The operator used with the filter.
...
display
...
The display style used by the filter.
...
dependencies
...
Set to true if other filters in the report are dependent on this one.
...
list
...
Set to true if the filter is a list style (allows multiple values).
...
between
...
Set to true if the filter is a between style (requires a start and end value).
...
listValues
|
...
例
レポートフィルターをロードしてユーザーに表示する例を示します：
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
filterValues[filterUUID] = [500, 600]; |
loadReport 関数に渡される options.filters loadReport 関数に渡される おｐ 要素は、 要素は、 filterUUID または filterId でキー設定された値を含む必要があります。可能な限り filterUUID を使用することをお勧めします。
...
オプションは、Javascriptオブジェクトとして関数に渡されます。ロードしているダッシュボードの識別子、ダッシュボードをロードするHTML要素のelementId（またはelementそのもの）、およびダッシュボードの表示方法を変更するその他のオプションなどがあります。使用可能なオプションは以下のとおりです：
| Expand | |||
|---|---|---|---|
| |||
|
...
|
...
|
...
|
...
|
...
showTitle
...
Default: trueSet to false to omit the title bar at the top of the dashboard. All interactive buttons included in the title bar will also be omitted.
...
showInfo
...
Default: trueSet to false to omit the Info button in the title bar.
...
showFilters
...
Default: trueSet to false to omit the Filters button in the title bar. Any analytical filters will not be displayed.
...
showExport
...
Default: trueSet to false to omit the Export button in the title bar.
...
height
...
Default: automatically set from the dimensions of the reports in the dashboard.Set this to a numeric value to override the dashboard height. If the reports in the dashboard require more space, a vertical scrollbar will be added.
...
width
...
Default: automatically set from the logged-in user's preferences or the system configuration settingSet this to a numeric value to override the dashboard width.Set this to auto to use the full width of the enclosing element.
...
filters
...
Set to an object containing filter values to pass to the dashboard.
...
username
...
Set this along with the password parameter to authenticate as a particular user when loading the dashboard. This avoids the need for users to enter their login details before viewing restricted dashboards.
...
password
|
...
例
IDで指定された要素にダッシュボードをロードし、初期の表示オプションをいくつか設定する例を示します。
...
コールバック関数の1番目の引数として返されるフィルターオブジェクトは、ダッシュボードで使用されるあらゆる分析フィルターと、フィルターグループ区切り文字が格納された配列です。配列の各要素は、そのフィルターまたはフィルターグループに関する情報が格納されたオブジェクトです。これらのオブジェクトには以下のプロパティがあります：
| Expand | |||
|---|---|---|---|
| |||
|
...
|
...
Set to FILTERGROUP if this object represents a filter group. Other values indicate a type of analytic filter.
...
説明
...
The 説明 of the filter or filter group.
...
groupId
...
For filter groups: a numeric identifier for the group.
...
state
...
For filter groups: set to OPEN if the group is currently opened.
...
display
...
For filters: the display style used by the filter.
...
dependencies
...
For filters: set to true if other filters in the dashboard are dependent on this one.
...
list
...
For filters: set to true if the filter is a list style (allows multiple values).
...
between
...
For filters: set to true if the filter is a between style (requires a start and end value).
...
listValues
|
...
例
ダッシュボードフィルターをロードしてユーザーに表示する例を示します：
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
filterValues[key] = [500, 600]; |
loadDash 関数に渡される options.filters loadDash 関数に渡される OP 要素は、 ｌｄｆｌ 要素は、 loadDashFilters 関数から返される keys でキー設定された値を含む必要があります。 loadDashFilters
| horizontalrule |
|---|
| Styleclass | ||
|---|---|---|
| ||