ナビゲーションにスキップ

インスタンスメソッド

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

Markdownとして表示

方法の概要

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

破壊する()

iframe を削除し、リスナーをクリアし、現在のインスタンスに対して破棄されたものを 1 回出力します。

widget.destroy()

getState()

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

const state = widget.getState()

戻り値には、ロード、認証中、準備完了、エラー、および破棄が含まれます。

whenReady()

iframe の初期化が完了するまで待ってから、依存する UI ロジックを実行します。

await widget.whenReady()

setSymbol(シンボル)

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

widget.setSymbol('ETHUSDT')

setTheme(テーマ)

埋め込み取引 iframe で使用されるテーマ パラメータを更新します。

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

setLocale(ロケール)

iframe言語を切り替えます。サポートされている値は、en、en-US、および zh-CN です。

widget.setLocale('en')
widget.setLocale('en-US')
widget.setLocale('zh-CN')

setSize(幅、高さ)

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

widget.setSize('100%', 720)

リロード()

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

widget.reload()

refreshAuth(理由)

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

widget.refreshAuth('manual')

setTokenProvider(プロバイダー)

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

widget.setTokenProvider(async ({ channelId, symbol, reason }) => {
const resp = await fetch('/api/trading/embed-token', {
method: 'POST',
credentials: 'include',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ channelId, symbol, reason }),
})
return resp.json()
})

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

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

const off = widget.on('order_created', (event) => {
console.log(event)
})
off()

関連するウィジェットのガイド

現在の v1 ランタイムの追加メソッド

方法目的
whenRendered()iframe のレンダリングされた通知を待ちます。これは準備完了とは別のものです。
setPage(page)現在のインスタンスでサポートされている製品ページをリクエストします。資金環境は変わりません。
prepareForRecreate()Ready iframe に置き換えの準備を依頼します。 Promise を返し、利用できない場合、ビジーまたはタイムアウトの場合は拒否できます。
cancelRecreate()保留中/準備済みの置換フローをキャンセルします。
TradingWidget.validateOptions(options)インスタンスを作成する前に、初期化オプションを検証してください。

ユーザーまたは実際/デモ環境を変更する場合は、古いインスタンスを破棄し、ターゲットの認証とモードで新しいインスタンスを作成します。 setPage を環境スイッチとして使用しないでください。オプションのメソッドを使用する前に機能を確認してください。

if (TradingWidget.capabilities.methods.includes('whenRendered')) {
await widget.whenRendered();
}
if (TradingWidget.capabilities.pages.includes('up-down')) {
widget.setPage('up-down');
}