| Anchor | ||||
|---|---|---|---|---|
|
| Table of Contents | ||
|---|---|---|
|
概要
2021年まで、こちらのページタイトルは「Base API」でしたが、このページの内容と継続的なJS APIへの改善をより良く反映するために、こちらのページタイトルには「高度なAPI」の方が適切であると判断し、ページタイトルを変更することにしました。現状は移行期間として両方のタイトルを表示していますが、今後は新しいタイトルに統一します。
高度なAPI リファレンス
このAPIは、ページに「JsAPI/v3」JSファイルが含まれているページでのみ使用できます。以下の例を参照してください。
...
| Anchor | ||||
|---|---|---|---|---|
|
yellowfin.newSession(token, org);（Yellowfin新規セッション）
リターン
Promise
説明
この関数は、現在のユーザーをログアウトし、渡されたwebサービスのセッショントークンを使用して、新規ユーザーをログインさせるためのリクエストをYellowfin JS APIに送信します。この関数は、セッショントークンとともに、オプションでクライアント組織IDも受け取ることで、ユーザーが特定のクライアント組織にログインできるようにします。
ログインアクションが正常に完了すると、関数はPromiseを返し、ページ上のすべてのレポートまたはダッシュボードが再実行されます。
loadReport(reportOptions)（レポートのロード）
リターン
Promise
説明
init() promiseがロードするの待ち、渡されたオプションでレポートをロードします。レポートがロードされると、渡されたelement（要素）が追加され、レポートの実行が開始されます。
...
デフォルトでは、明示的にfalseに設定されていないインタラクションはすべて有効と見なされ、レポートで許可されている場合は表示されます。
drillDown
ドリルダウン機能を無効にできます。
drillAnywhere
ドリルエニウェア機能を無効にできます。
drillThrough
ドリルスルー機能を無効にできます。
unitSelection
単位選択機能を無効にできます。
brushing
ブラッシング機能を無効にできます。
timeSlider
タイムスライダー機能を無効にできます。
drillBreadcrumbs
パンくずリスト機能を無効にできます。
seriesSelection
シリーズ選択機能を無効にできます。
annotations
注釈機能を無効にできます。
例
loadReportの使用時にレポート上のすべてのユーザーインタラクションを無効にするには、以下を参照してください。
...
loadDashboard(dashboardOptions)
リターン
Promise
説明
init()promiseがロードされるのを待ち、渡されたオプションでダッシュボードをロードします。ダッシュボードがロードされると、渡されたelement（要素）に追加され、ダッシュボード上のコンテンツの実行が開始されます。
...
高度なAPIツールセットを使用することで、ストーリー組み込み時に利用できるオプションを拡張するため、ニーズに合わせてストーリーのルックアンドフィールを調整することができます。共同編集者を非表示にしたり、組み込まれたストーリーの幅を制限したりすることができますが、これは高度なAPIを使用することで実現できます。
高度なAPI
新しいオブジェクトが、Yellowfin オブジェクトに追加されます。それは、ストーリーです。新しいオブジェクトであるストーリーが、Yellowfin オブジェクトに追加されます。次のコードは、高度なAPIを使用して、ストーリーを読み込む一般的な方法の例です。
| Code Block | ||||
|---|---|---|---|---|
| ||||
<script src="http://yellowfinServer/JsAPI/v3"></script>
<div id="myStoryDiv"></div>
<script>
yellowfin.loadStoryAPI().then(() => {
yellowfin.stories.loadStory({
storyUUID: 'a-story-uuid', //This should be the story's publish uuid
element: document.querySelector('#myStoryDiv') //The div to render the story into
});
}
</script> |
yellowfin.stories
...
リターン：Promise
Promise パラメーター：_story_APIstoryAPI
説明
この関数は、渡されたoptions.storyUUIDに関連するストーリーを読み込み、完了すると解決されたPromiseを返します。
...
埋め込みリンクオプション：?StoryUUID=uuid（これは組み込むストーリーの公開UUIDです。これがクエリー文字列の後ろの方に表示される場合は、忘れずに?を&に変更してください）
説明
このオプションは必須です。これが渡されない場合は、loadStoryの呼び出しは失敗します。
...
埋め込みリンクパラメーター：&showToolbar=ture（または、これが文字列で最初の要素の場合、他の文字列のように、接頭辞を&から?に変更します）
デフォルト値：true
説明
このオプションは、組み込みストーリーでJS API ツールバーを表示するかどうかを決定します。
...
埋め込みリンクパラメーター：&showInfo=true（または、これが文字列で最初の要素の場合、他の文字列のように、接頭辞を&から?に変更します）
デフォルト値：true
説明
このオプションは、組み込みストーリーの詳細ドロップダウンを表示するかどうかを決定します。
...
埋め込みリンクパラメーター：&showExport=true（または、これが文字列で最初の要素の場合、他の文字列のように、接頭辞を&から?に変更します）
デフォルト値：true
説明
このオプションは、ストーリーの閲覧者に、組み込みストーリーのPDFエクスポートオプションを表示するかどうかを決定します。
...
埋め込みリンクパラメーター：&showBannerImage=true（または、これが文字列で最初の要素の場合、他の文字列のように、接頭辞を&から?に変更します）
デフォルト値：true
説明
このオプションは、組み込みストーリーのバナーイメージを表示するかどうかを決定します。
...
埋め込みリンクパラメーター：&showHeader=true（または、これが文字列で最初の要素の場合、他の文字列のように、接頭辞を&から?に変更します）
デフォルト値：true
説明
このオプションは、組み込みストーリーのヘッダーを表示するかどうかを決定します。
ストーリーのヘッダーには、記事を書いた人とその公開日、記事を読んだ人と拍手の数が表示されます。これらを表示するには、このshowHeaderオプションを含め、trueに設定しなくてはいけません。ストーリーのヘッダーには、記事を書いた人とその公開日、記事を読んだ人と拍手の数が表示されます。これらを表示するには、このshowHeaderオプションを含め、trueに設定しなくてはいけません。こちらのオプションをtrueに設定し、含めることのできる4つの要素をオフにすると、空白のバナーが表示されます。
showAuthor（記事を書いた人の表示）
詳細
埋め込みリンクパラメーター：&showAuthor=true（または、これが文字列で最初の要素の場合、他の文字列のように、接頭辞を&から?に変更します）
デフォルト値：true
説明
このオプションは、組み込みストーリーに、その記事を書いた人を表示するかどうかを決定します。こちらがtrueに設定されていたとしても、showHeaderオプションもtrueに設定されている場合のみ、記事を書いた人が表示されます。
...
埋め込みリンクパラメーター：&showDateContainer=true（または、これが文字列で最初の要素の場合、他の文字列のように、接頭辞を&から?に変更します）
デフォルト値：true
説明
このオプションは、組み込みストーリーの公開日を表示するかどうかを決定します。こちらがtrueに設定されていたとしても、showHeaderオプションもtrueに設定されている場合のみ、公開日が表示されます。
...
埋め込みリンクパラメーター：&showLikeButton=true（または、これが文字列で最初の要素の場合、他の文字列のように、接頭辞を&から?に変更します）
デフォルト値：true
説明
このオプションは、ストーリーに拍手ボタンを表示するかどうかを決定します。こちらがtrueに設定されていたとしても、showHeaderオプションもtrueに設定されている場合のみ、拍手ボタンが表示されます。このオプションは、ストーリーに拍手ボタンを表示するかどうかを決定します。こちらがtrueに設定されていたとしても、showHeaderオプションもtrueに設定されている場合のみ、拍手ボタンが表示されます。認証されていないゲストは、このボタンを使用できません。
showReadBy（ストーリーを読んだ人の表示）
...
埋め込みリンクパラメーター：&showReadBy=true（または、これが文字列で最初の要素の場合、他の文字列のように、接頭辞を&から?に変更します）
デフォルト値：true
説明
このオプションは、組み込みストーリーを読んだ人の一覧を表示するかどうかを決定します。こちらがtrueに設定されていたとしても、showHeaderオプションもtrueに設定されている場合のみ、ストーリーを読んだ人の一覧が表示されます。
...
埋め込みリンクパラメーター：&showStoryTitle=true（または、これが文字列で最初の要素の場合、他の文字列のように、接頭辞を&から?に変更します）
デフォルト値：true
説明
このオプションは、組み込みストーリーのタイトルを表示するかどうかを決定します。
...
埋め込みリンクパラメーター：&showFooter=true（または、これが文字列で最初の要素の場合、他の文字列のように、接頭辞を&から?に変更します）
デフォルト値：true
説明
このオプションは、組み込みストーリーのフッターを表示するかどうかを決定します。
...
埋め込みリンクパラメーター：&showContributors=true（または、これが文字列で最初の要素の場合、他の文字列のように、接頭辞を&から?に変更します）
デフォルト値：true
説明
このオプションは、ストーリーの組み込み時に、共同編集者の一覧を表示するかどうかを決定します。こちらがtrueに設定されていたとしても、showFooterオプションもtrueに設定されている場合のみ、共同編集者の一覧が表示されます。
...
埋め込みリンクパラメーター：&width=xxx（xxxには数字が入ります。これが文字列で最初の要素の場合、他の文字列のように、接頭辞を&から?に変更します）
デフォルト値：element（要素）の幅
説明
このオプションは、組み込みストーリー全体の幅を設定します。
...
埋め込みリンクパラメーター：&storyWidth=xxx（xxxには数字が入ります。これが文字列で最初の要素の場合、他の文字列のように、接頭辞を&から?に変更します）
デフォルト値：width（幅）の4分の3
説明
このオプションは、組み込みストーリー本文の幅を設定します。ストーリーの大部分のコンテンツの幅は、最大幅（例：ワイドモードのイメージ）で表示するように設定されていない限り、200pxより小さくなります。このオプションは、組み込みストーリー本文の幅を設定します（バナーは含みません）。ストーリーの大部分のコンテンツの幅は、最大幅（例：ワイドモードのイメージ）で表示するように設定されていない限り、200pxより小さくなります。
bannerImageHeight（バナーイメージの高さ）
...
埋め込みリンクパラメーター：&bannerImageHeight=xxx（xxxには数字が入ります。これが文字列で最初の要素の場合、他の文字列のように、接頭辞を&から?に変更します）
デフォルト値：300px
説明
このオプションは、バナーイメージコンテナに適用されるカスタマイズされた高さを設定します。このオプションは、バナーイメージコンテナに適用されるカスタマイズされた高さを設定します。最適な結果を得るために、この設定を使用する場合は、バナーの幅を設定することも推奨します。
bannerImageWidth（バナーイメージの幅）
...
埋め込みリンクパラメーター：&bannerImageWidth=xxx（xxxには数字が入ります。これが文字列で最初の要素の場合、他の文字列のように、接頭辞を&から?に変更します）
デフォルト値：width（幅）の値
説明
このオプションは、バナーイメージに適用されるカスタマイズされた幅を設定します。このオプションは、バナーイメージに適用されるカスタマイズされた幅を設定します。最適な結果を得るために、この設定を使用する場合は、バナーの高さを設定することも推奨します。
loadStoryAPI()（ストーリーAPIの読み込み）
...