Page History
| Anchor | ||||
|---|---|---|---|---|
|
| Table of Contents | ||
|---|---|---|
|
...
ヒント
| Styleclass | ||
|---|---|---|
|
...
- 囲み要素は、
divなどのブロックレベル要素である必要があります。 上位要素にはパディングや境界線を使用できません。レポートまたはダッシュボードで境界線やパディングを使用する場合は、その要素を、パディングや境界線を使用する別の要素で囲む必要があります。例：
- The enclosing element should be a block-level element, such as a
div - The enclosing element should have no padding or border. If you want a border or padding around your report or dashboard you should enclose the element in another element that has the padding or border. For example:
If you are using the basic method, and do not pass an elementId to the API, the enclosing element is created automatically. You can enclose the script tag in another element with padding or border styles applied. For example:Code Block html html <div style="padding: 10px; border: 1px solid black;"> <div id="myReport"> </div> </div> <script type="text/javascript"> yellowfin.loadReport({reportUUID: 'e5e5aaf3-c3b8-4f9b-8280-e21e4d848e63', elementId: 'myReport' }); </script>基本の方法を使用していて、elementIdをAPIに渡さない場合、囲み要素が自動的に作成されます。スクリプトタグは、パディングまたは境界線スタイルが適用された別の要素で囲むことができます。例：
Code Block html html <div style="padding: 10px; border: 1px solid black;"> <script type="text/javascript" src="http://localhost/JsAPI?reportUUID=e5e5aaf3-c3b8-4f9b-8280-e21e4d848e63&width=500&width=350"></script> </div> - For reports, the enclosing element should have a fixed height/width.
For chart only reports, the chart will be renedered to fit within the enclosing element. In case a report does not fit within the element, scrollbars will be included, so the rest of your page layout is not affected.
If you do not include a fixed height and width on your element, the browser will choose how to layout the report. This may mean that the report will increase or decrease in size when different options are clicked by the user. This may be preferable in some cases. - Make sure the Javascript API URL is accessible for any end-users. Avoid using
localhostor private IP addresses. - Your HTML should be well-structured where possible. For example, you may have problems with the API if you do not have a
<body>tag.
...
- レポートの場合、囲み要素の高さや幅は固定されている必要があります。
グラフのみのレポートの場合、グラフは囲み要素内に収まるように描画されます。レポートが要素内に収まらない場合は、残りのページレイアウトに影響しないようにスクロールバーが含まれます。
要素に固定の高さや幅を含めない場合、ブラウザーによってレポートのレイアウト方法が選択されます。つまり、ユーザーがさまざまなオプションをクリックしたときに、レポートの大きさが変化する可能性があります。場合によってはこれも良い方法です。 - Javascript APIのURLにすべてのエンドユーザーがアクセスできるようにします。
localhostやプライベートIPアドレスの使用は避けてください。 - HTMLの構造はできるだけ最適化してください。たとえば、
<body>タグを使用しないとAPIで問題が発生する可能性があります。
トラブルシューティング
| Styleclass | ||
|---|---|---|
|
...
window.yellowfin変数を確認すると、Javascript APIが正常にロードされたかどうかを確認できます。たとえば、基本の方法を使用する場合は以下のようになります：As mentioned previously, you can check the window.yellowfin variable to determine if the Javascript API has been loaded successfully. For example, when using the basic method:| Code Block | ||||
|---|---|---|---|---|
| ||||
<script src="http://localhost/JsAPI?reportUUID=e5e5aaf3-c3b8-4f9b-8280-e21e4d848e63&width=500&height=500" type="text/javascript"></script>
<script typt="text/javascript">
if (!window.yellowfin) {
alert('Error loading API');
}
</script>
|
When using the advanced method, you can use this to determine whether or not to attempt to load a report or dashboard:高度な方法を使用する場合は、以下のコードを使用してレポートまたはダッシュボードのロードを試みるかどうかを判断できます：
| Code Block | ||||
|---|---|---|---|---|
| ||||
<script src="http://localhost/JsAPI" type="text/javascript"></script>
<script typt="text/javascript">
if (window.yellowfin) {
yellowfin.loadReport({reportUUID: 'e5e5aaf3-c3b8-4f9b-8280-e21e4d848e63',
elementId: 'myReport' });
} else {
alert('Error loading API');
}
</script>
|
Errors encountered when using the API are generally presented through Javascript alerts. These include a description of the error. Common errors include:
...
Error
...
Description
...
API version requested is not supported
...
The server does not support the API version requested.
...
reportUUID not specified
...
The yellowfin.loadReport function is called without a report identifier (reportUUID, reportId or wsName).
...
Report not found
...
The report specified by the reportUUID, reportId or wsName could not be found.
...
Report not loaded
...
An operation has been attempted on a report that has not yet been loaded.
...
Report is in draft mode
...
The report specified is in draft mode. Only active reports can be accessed through the Javascript API.
...
User does not have access to this report
...
The user logged in does not have access to the requested report.
...
Invalid command specified
Invalid request
...
An invalid request has been made to the API.
...
Error loading report
Error running report
Error running report command
Error loading dashboard
...
A server-side error occurred while running an API command. Check the Yellowfin server logs for more information.
...
dashUUID not specified
...
The yellowfin.loadDash function is called without a dashboard identifier (dashUUID).
...
Dashboard not found
...
The dashboard specified by the dashUUID could not be found.
...
User does not have access to this dashboard
...
The user logged in does not have access to the requested dashboard.
APIを使用していて発生するエラーは、一般にJavascriptのアラートを介して提示されます。アラートにはエラーの説明が含まれています。よくあるエラーは以下のとおりです：
エラー | 説明 |
|---|---|
要求されたAPIのバージョンはサポートされていません | サーバーはリクエストされたAPIバージョンをサポートしていません。 |
reportUUIDが指定されていません |
|
レポートが見つかりませんでした |
|
レポートがロードされていません | ロードされていないレポートでオペレーションが試行されました。 |
レポートはドラフト（編集中）モードです | 指定されたレポートはドラフト（編集中）モードです。Javascript APIを介してアクセスできるのはアクティブなレポートのみです。 |
ユーザーはこのレポートへのアクセス権がありません | ログインしているユーザーは、リクエストされたレポートへのアクセス権がありません。 |
無効なコマンドが指定されました | APIに対して無効なリクエストが行われました。 |
レポートをロード中にエラーが発生しました | APIコマンドを実行中に、サーバー側でエラーが発生しました。詳細については、Yellowfinのサーバーログを確認してください。 |
dashUUIDが指定されていません |
|
ダッシュボードが見つかりませんでした |
|
ユーザーはこのダッシュボードへのアクセス権がありません | ログインしているユーザーは、リクエストされたダッシュボードへのアクセス権がありません。 |
ダッシュボードはドラフト（編集中）モードです | 指定されたダッシュボードはドラフト（編集中）モードです。Javascript APIを介してアクセスできるのはアクティブなダッシュボードのみです。 |
...
Dashboard is in draft mode
...
| horizontalrule |
|---|
| Styleclass | ||
|---|---|---|
| ||
...