インスタンスメソッド

TradingWidget.create()の後に作成されたウィジェットインスタンスを制御します。

Markdownとして表示

方法概要

方法目的
破壊()iframeを削除してイベントリスナーを解放してください。
getState()現在の SDK ライフサイクル状態を読んでください。
whenReady()iframeの初期化が終わるまで待ちましょう。
setSymbol(シンボル)iframe内で取引ペアを切り替えます。
setTheme(テーマ)iframeのテーマパラメータを更新してください。
setLocale(地域)iframeの言語を切り替えてください。
setSize(幅、高さ)iframeの寸法を更新してください。
リロード()現在のiframeをリロードしてください。
refreshAuth(理由)ウィジェット認証の更新フローをトリガーします。
setTokenProvider(プロバイダー)パートナートークンモードで使われているプロバイダーを置き換えます。
on(イベント、ハンドラー)ランタイムイベントにサブスクライブすると、購読解除機能を受け取ることができます。

破壊()

iframeを削除し、リスナーをクリアし、現在のインスタンスに対して一度だけ破壊を放出します。

1widget.destroy()

getState()

ウィジェットインスタンスの現在のライフサイクル状態を読みます。

1const state = widget.getState()

返す値は読み込み、認証、準備済み、エラー、破壊などが含まれます。

whenReady()

iframeの初期化が終わるまで待ってから、依存するUIロジックを実行してください。

1await widget.whenReady()

setSymbol(シンボル)

iframe内の取引ペアを切り替えます。iframeがまだ初期化中であれば、 SDK はコマンドをキューに入れて準備完了後に送信します。

1widget.setSymbol('ETHUSDT')

setTheme(テーマ)

埋め込みトレーディングiframeで使われているテーマパラメータを更新してください。

1widget.setTheme('dark')
2widget.setTheme('light')

setLocale(地域)

iframe言語を切り替えてください。対応値はen、en-us、zh-CNです。

1widget.setLocale('en')
2widget.setLocale('en-US')
3widget.setLocale('zh-CN')

setSize(幅、高さ)

iframeの DOM サイズを更新し、新しい外側サイズをiframeに通知します。数値値はpxに変換されます。

1widget.setSize('100%', 720)

リロード()

現在のiframeをリロードして、再度初期化されるのを待ちます。

1widget.reload()

refreshAuth(理由)

iframeに現在の認証フローを更新するよう依頼します。オプションの理由値はログ記録とフロー制御のために転送されます。

1widget.refreshAuth('manual')

setTokenProvider(プロバイダー)

パートナートークンモードで使われていた tokenProvider を置き換えます。 SDK はiframeが新しい埋め込みトークンを要求するとプロバイダーに呼び出します。

1widget.setTokenProvider(async ({ channelId, symbol, reason }) => {
2 const resp = await fetch('/api/trading/embed-token', {
3 method: 'POST',
4 credentials: 'include',
5 headers: { 'Content-Type': 'application/json' },
6 body: JSON.stringify({ channelId, symbol, reason }),
7 })
8
9 return resp.json()
10})

on(イベント、ハンドラー)

ランタイムイベントにサブスクライブします。返される関数はリスナーを削除します。

1const off = widget.on('order_created', (event) => {
2 console.log(event)
3})
4
5off()