目次

• 概要
• 利用方法
• メソッド一覧
• メソッド詳細
• setCustomParams
• 免責事項

概要

OnbCustomLayer はクライアント側へ提供されるAPIです。

本APIを利用することで、独自のパラメータの設定や、アプリケーションの動作をカスタマイズできます。

利用方法

API を利用するには、window.OnbCustomLayer に対してメソッドを呼び出します。

メソッド一覧

メソッド詳細

setCustomParams

概要

クライアント独自のパラメータを引き渡します。

パラメータ

• params: { [key: string]: string | number; } （必須）
• params はキーが文字列で、値が文字列または数値のオブジェクトである必要があります
• 型チェックに失敗した場合、エラーがスローされます

例外

• Error: OnbCustomLayer.setCustomParams: Invalid arguments
• params の型が正しくない場合に発生します。

使用例

if (typeof window.OnbCustomLayer !== 'undefined') {
  window.OnbCustomLayer.setCustomParams({
    customParam1: 123,
    customParam2: "text",
  });
}

免責事項

本APIは予告なく変更される可能性があります。