deephaven.plugin.js#

class JsPlugin[source]#

Bases: Plugin

A JS plugin is a Plugin that allows adding javascript code under the server’s URL path “js-plugins/”. See https://github.com/deephaven/deephaven-plugins#js-plugins for more details about the underlying construction for JS plugins.

abstract property main#: The main JS file path, specified relative to root. The main JS file must exist. Will be included as the “main” field for the manifest entry in “js-plugins/manifest.json”.

abstract property name#: The JS plugin name. The JS plugin contents will be served via the URL path “js-plugins/{name}/”, as well as included as the “name” field for the manifest entry in “js-plugins/manifest.json”.

abstract path()[source]#

The directory path of the resources to serve. The path must exist.

Return type:: Path

abstract property version#: The JS plugin version. Will be included as the “version” field for the manifest entry in js-plugins/manifest.json”.