Page History

...

高度なAPIツールセットを使用することで、ストーリー組み込み時に利用できるオプションを拡張するため、ニーズに合わせてストーリーのルックアンドフィールを調整することができます。共同編集者を非表示にしたり、組み込まれたストーリーの幅を制限したりすることができますが、これは高度なAPIを使用することで実現できます。

高度なAPI

新しいオブジェクトが、Yellowfin オブジェクトに追加されます。それは、ストーリーです。新しいオブジェクトであるストーリーが、Yellowfin オブジェクトに追加されます。次のコードは、高度なAPIを使用して、ストーリーを読み込む一般的な方法の例です。

<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を返します。

...

このオプションは、組み込みストーリーのヘッダーを表示するかどうかを決定します。

ストーリーのヘッダーには、記事を書いた人とその公開日、記事を読んだ人と拍手の数が表示されます。これらを表示するには、このshowHeaderオプションを含め、trueに設定しなくてはいけません。ストーリーのヘッダーには、記事を書いた人とその公開日、記事を読んだ人と拍手の数が表示されます。これらを表示するには、このshowHeaderオプションを含め、trueに設定しなくてはいけません。こちらのオプションをtrueに設定し、含めることのできる4つの要素をオフにすると、空白のバナーが表示されます。

showAuthor（記事を書いた人の表示）

詳細

埋め込みリンクパラメーター：&showAuthor=true（または、これが文字列で最初の要素の場合、他の文字列のように、接頭辞を&から?に変更します）

...

埋め込みリンクパラメーター：&showLikeButton=true（または、これが文字列で最初の要素の場合、他の文字列のように、接頭辞を&から?に変更します）

デフォルト値：true

説明

このオプションは、ストーリーに拍手ボタンを表示するかどうかを決定します。こちらがtrueに設定されていたとしても、showHeaderオプションもtrueに設定されている場合のみ、拍手ボタンが表示されます。このオプションは、ストーリーに拍手ボタンを表示するかどうかを決定します。こちらがtrueに設定されていたとしても、showHeaderオプションもtrueに設定されている場合のみ、拍手ボタンが表示されます。認証されていないゲストは、このボタンを使用できません。

showReadBy（ストーリーを読んだ人の表示）

...

埋め込みリンクパラメーター：&storyWidth=xxx（xxxには数字が入ります。これが文字列で最初の要素の場合、他の文字列のように、接頭辞を&から?に変更します）

デフォルト値：width（幅）の4分の3

説明

このオプションは、組み込みストーリー本文の幅を設定します。ストーリーの大部分のコンテンツの幅は、最大幅（例：ワイドモードのイメージ）で表示するように設定されていない限り、200pxより小さくなります。このオプションは、組み込みストーリー本文の幅を設定します（バナーは含みません）。ストーリーの大部分のコンテンツの幅は、最大幅（例：ワイドモードのイメージ）で表示するように設定されていない限り、200pxより小さくなります。

bannerImageHeight（バナーイメージの高さ）

...

埋め込みリンクパラメーター：&bannerImageHeight=xxx（xxxには数字が入ります。これが文字列で最初の要素の場合、他の文字列のように、接頭辞を&から?に変更します）

デフォルト値：300px

説明

このオプションは、バナーイメージコンテナに適用されるカスタマイズされた高さを設定します。このオプションは、バナーイメージコンテナに適用されるカスタマイズされた高さを設定します。最適な結果を得るために、この設定を使用する場合は、バナーの幅を設定することも推奨します。

bannerImageWidth（バナーイメージの幅）

...

埋め込みリンクパラメーター：&bannerImageWidth=xxx（xxxには数字が入ります。これが文字列で最初の要素の場合、他の文字列のように、接頭辞を&から?に変更します）

デフォルト値：width（幅）の値

説明

このオプションは、バナーイメージに適用されるカスタマイズされた幅を設定します。このオプションは、バナーイメージに適用されるカスタマイズされた幅を設定します。最適な結果を得るために、この設定を使用する場合は、バナーの高さを設定することも推奨します。

loadStoryAPI()（ストーリーAPIの読み込み）

...