motiff.ui

以下为全局对象 motiff.ui 的属性与方法。

show(): void

使插件的 UI 可见。当 UI 是由 motiff.showUI(..., { visible: false }) 所创建，或调用 motiff.ui.hide() 后被隐藏，可使用motiff.ui.show() 显示 UI。

---

hide(): void

隐藏当前的 UI ，使其对用户不可见。隐藏之后， UI 仍将继续运行代码并能够发送和接收消息。

---

resize(width: number, height: number): void

UI 创建之后，可通过此 API 修改 UI 对话框的尺寸。

---

reposition(x: number, y: number): void

UI 创建之后，可通过此 API 修改 UI 对话框的位置。

---

close(): void

销毁 UI 及其中的 <iframe>，执行之后，iframe 中的代码将不再执行，也不可再传递或接受 UI 的消息。

---

postMessage(pluginMessage: any, options?: UIPostMessageOptions): void

发送消息至 UI 的 <iframe> 窗口。

参数

• pluginMessage： 此 API 可传递任意可序列化的数据类型或 plain object。您可以发送对象、数组、数字、字符串、布尔值、null、undefined、日期对象和 Uint8Array 对象，但不包含对象的函数和原型链。此类限制与浏览器的 postMessage 相同：详情请点击 此处 。

• options： 包含以下可选参数的对象。origin: 高阶选项，主要用于实现 OAuth。 若提供 origin 选项，有且仅当 iframe 内文档的 origin 与所提供的 origin 匹配时，消息才会传递到 iframe。 默认值为 "*"，允许将信息传递给任何文档。

---

onmessage: MessageEventHandler | undefined

注册处理来自 UI 内 <iframe> 的事件的处理函数。

---

on(type: 'message', callback: MessageEventHandler): void

注册处理来自 UI 内 <iframe> 的事件的处理函数。

---

once(type: 'message', callback: MessageEventHandler): void

同 motiff.ui.on("message") ，但仅在第一次触发时调用处理函数。

---

off(type: 'message', callback: MessageEventHandler): void

移除 motiff.ui.on 及 mofitt.ui.once 注册的事件处理函数。