クイックビューを使用したカスタムポップアップの作成 using-quickviews-to-create-custom-pop-ups

アップロードしたアセット用にクイックビューを作成します。

通常、クイックビューは、使用しているビューアで使用するアセットを編集するのと同時に作成します。

ビューアの埋め込みコードを取得して、Web サイト内にビューアを統合します。

使用しているビューアが、クイックビューの使用方法を認識する必要があります。

このために、ビューアは QuickViewActive というハンドラーを使用します。

例 Web ページでインタラクティブ画像用に以下のサンプル埋め込みコードを使用しているとします。

ハンドラーは setHandlers を使用してビューアに読み込まれます。

*viewerInstance*.setHandlers({ *handler 1*, *handler 2*}, ...

上記のサンプル埋め込みコードの例を使用すると、以下のようなコードになります。

s7interactiveimageviewer.setHandlers({
    quickViewActivate": function(inData) {
        var sku=inData.sku;
        var genericVariable1=inData.genericVariable1;
        var genericVariable2=inData.genericVariable2;
       loadQuickView(sku,genericVariable1,genericVariable2);
    }
})

setHandlers() メソッドについて詳しくは、以下を参照してください。

• インタラクティブ画像ビューア： setHandlers
• インタラクティブビデオビューア： setHandlers

次に、quickViewActivate ハンドラーを設定する必要があります。

quickViewActivate ハンドラーは、ビューアのクイックビューを制御します。 このハンドラーには、クイックビューで使用する変数のリストと関数呼び出しが含まれています。埋め込みコードは、クイックビューの SKU 変数セット用のマッピングと、サンプルの loadQuickView 関数呼び出しを提供しています。

変数マッピング Web ページで使用する変数を SKU 値とクイックビューに含まれる一般変数にマッピングします。

var *variable1*= inData.*quickviewVariable*

提供された埋め込みコードには、SKU 変数用のサンプルマッピングが含まれています。

var sku=inData.sku

以下のように、クイックビューからの追加変数もマッピングします。

var <i>variable2</i>= inData.<i>quickviewVariable2</i>
 var <i>variable3</i>= inData.<i>quickviewVariable3</i>

関数呼び出し ​ハンドラーには、クイックビューを機能させるために関数呼び出しも必要です。関数は、ホストページからアクセス可能であると想定されます。 埋め込みコードは、次のサンプル関数呼び出しを提供しています。

loadQuickView(sku)

このサンプル関数呼び出しは、関数 loadQuickView() が存在しアクセス可能であることが前提となります。

quickViewActivate メソッドの詳細については、次を参照してください。

• インタラクティブ画像ビューア ‐ イベントコールバック
• インタラクティブビデオビューア ‐ イベントコールバック
• インタラクティブビデオビューアでのインタラクティブデータのサポート ‐ インタラクティブデータのサポート

以下の操作を実行してください。

• 埋め込みコードの setHandlers セクションのコメントを解除します。

• クイックビューに含まれる追加の変数をマッピングします。

  • 変数を追加する場合は、loadQuickView(sku,*var1*,*var2*) 呼び出しを更新します。

• ビューア外でページにシンプルな loadQuickView() 関数を作成します。

  例えば、以下により、ブラウザーのコンソールに sku の値が書き込まれます。

function loadQuickView(sku){
    console.log ("quickview sku value is " + sku);
}

• Web サーバーにテスト HTML ページをアップロードし、開きます。

  クイックビューからの変数がマッピングされ、関数呼び出しが追加された状態で、ブラウザーコンソールは提供されたサンプル関数を使用してブラウザーコンソールに変数値を書き込みます。

これで、関数を使用してクイックビューでシンプルなポップアップを起動できるようになりました。以下の例では、ポップアップに DIV を使用しています。

ポップアップの DIV を以下のようなスタイルにします。必要に応じて独自のスタイルを追加します。

<style type="text/css">
    #quickview_div{
        position: absolute;
        z-index: 99999999;
        display: none;
    }
</style>

HTML ページのボディにポップアップの DIV を配置します。

要素の 1 つに、ユーザーがクイックビューを起動したときに sku 値で更新される ID が設定されます。 この例には、ポップアップを表示後に再び隠すための簡単なボタンも含まれています。

<div id="quickview_div" >
    <table>
        <tr><td><input id="btnClosePopup" type="button" value="Close"        onclick='document.getElementById("quickview_div").style.display="none"' /><br /></td></tr>
        <tr><td>SKU</td><td><input type="text" id="txtSku" name="txtSku"></td></tr>
    </table>
</div>

ポップアップの sku 値を更新する関数を追加します。手順 5 で作成したシンプルな関数を置き換えて、ポップアップを表示できるようにします。 を次のように設定します。

<script type="text/javascript">
    function loadQuickView(sku){
        document.getElementById("txtSku").setAttribute("value",sku); // write sku value
        document.getElementById("quickview_div").style.display="block"; // show popup
    }
</script>

Web サーバーにテスト用の HTML ページをアップロードして開きます。ユーザーがクイックビューを起動すると、ビューアにポップアップの DIV が表示されます。

全画面表示モードでカスタムポップアップを表示する方法

インタラクティブビデオビューアなどの一部のビューアでは、全画面表示モードでの表示をサポートしています。ただし、前の手順で説明したポップアップを使用すると、全画面表示モード中はビューアの背後に表示されるようになります。

標準モードと全画面表示モードの両方でポップアップを表示させるには、ビューアのコンテナにポップアップをアタッチします。それには、2 つ目のハンドラーメソッド initComplete を使用できます。

initComplete ハンドラーは、ビューアの初期化後に起動します。

"initComplete":function() { code block }

init() メソッドについて詳しくは、以下を参照してください。

• インタラクティブ画像ビューア ‐ init
• インタラクティブビデオビューア ‐ init

前の手順で言及したように、ビューアにポップアップをアタッチするには、以下のコードを使用します。

"initComplete":function() {
    var popup = document.getElementById('quickview_div');
    popup.parentNode.removeChild(popup);
    var sdkContainerId = s7interactivevideoviewer.getComponent("container").getInnerContainerId();
    var inner_container = document.getElementById(sdkContainerId);
    inner_container.appendChild(popup);
}

上記のコードでは、次の操作をおこないました。

• カスタムポップアップを特定しました。
• DOM から削除しました。
• ビューアのコンテナを識別しました。
• ビューアのコンテナにポップアップをアタッチしました。

setHandlers コード全体は、次のようになります（インタラクティブビデオビューアを使用していました）。

s7interactivevideoviewer.setHandlers({
    "quickViewActivate": function(inData) {
        var sku=inData.sku;
        loadQuickView(sku);

    },
    "initComplete":function() {
        var popup = document.getElementById('quickview_div'); // get custom quick view container
        popup.parentNode.removeChild(popup); // remove it from current DOM
        var sdkContainerId = s7interactivevideoviewer.getComponent("container").getInnerContainerId();
        var inner_container = document.getElementById(sdkContainerId);
        inner_container.appendChild(popup);
    }
});

ハンドラーを読み込んだ後で、ビューアを初期化します。

*viewerInstance.*init()

例：この例では、インタラクティブ画像ビューアを使用します。

s7interactiveimageviewer.init()

ホストページにビューアを埋め込んだ後で、init() を使用してビューアを起動する前に、ビューアインスタンスが作成され、ハンドラーが読み込まれていることを確認してください。