参数与事件

初始化参数、运行时事件和常见错误码。

以 Markdown 格式查看

初始化参数

字段类型默认值说明
baseUrlstringSDK script 所在域名iframe 资源域名,Partner 页面建议显式传入。
symbolstringBTCUSDT会转成大写并移除 - / _。
themedark | lightdark初始主题参数。
localeen | en-US | zh-CN浏览器或默认语言支持英文和简体中文。
layoutdefault | compactdefault预留布局参数。
displayobjectshowHeader: false, showTicker: false, hidden: []控制 embed shell 区域和交易页大容器显示。
authobject新 SSO 接入建议使用 partner-token。

显示控制

display 用于控制嵌入式交易页的 shell 区域和大容器。Partner 嵌入场景下,PC 顶部栏和底部行情跑马灯默认隐藏。

1display: {
2 showHeader: false,
3 showTicker: false,
4 hidden: ['chart', 'orderBook'],
5}
字段类型默认值说明
showHeaderbooleanfalse是否显示 iframe 内的 PC embed 顶部栏。
showTickerbooleanfalse是否显示 embed shell 底部行情跑马灯。
hiddenstring[][]隐藏交易页的大容器。

display.hidden 支持值:

容器
chart图表容器
orderBook盘口容器
orderForm下单面板容器
positions持仓和当前委托等底部面板
account账户资产容器

display.hidden 只隐藏整块容器,不隐藏容器内部的单个按钮、字段或工具入口。没有对应当前视口容器的值会被忽略。

事件

事件触发时机
readyiframe 初始化完成。
errorSDK、iframe 或鉴权错误。
state_changedSDK 生命周期状态变化。
auth_state_changedpartner-token 鉴权状态变化。
symbol_changediframe 内实际交易对变化。
locale_changediframe 内实际语言变化。
order_created用户在 iframe 内成功创建订单。
order_failed用户下单失败。
destroyedSDK 实例销毁。