joplin.views.panels

Allows creating and managing view panels. View panels currently are displayed at the right of the sidebar and allows displaying any HTML content (within a webview) and update it in real-time. For example it could be used to display a table of content for the active note, or display various metadata or graph.

View the demo plugin

Index

Methods

Methods

addScript

addScript(handle: ViewHandle, scriptPath: string): Promise<void>

Adds and loads a new JS or CSS files into the panel.

Parameters
- handle: ViewHandle
- scriptPath: string

create

create(): Promise<ViewHandle>

Creates a new panel

onMessage

onMessage(handle: ViewHandle, callback: Function): Promise<void>

Called when a message is sent from the webview (using postMessage).

Parameters
- handle: ViewHandle
- callback: Function

setHtml

setHtml(handle: ViewHandle, html: string): Promise<string>

Sets the panel webview HTML

Parameters
- handle: ViewHandle
- html: string