Skip to main content

Plugin

interface Plugin

Represents a runtime Canvas Commons plugin.

Properties​

name​

name: string

A unique name of the plugin.

The name should be unique across the entire ecosystem of Canvas Commons. If a plugin with the same name has already been registered, this plugin will be ignored.

If you intend to publish your plugin to npm, it is recommended to prefix this name with the name of your npm package.

Other identifiers defined by the plugin, such as a tab id, will be automatically prefixed with this name and as such don't have to be unique.

Methods​

exporters​

public exportersproject: Project: ExporterClass[]

Provide custom exporters for the project.

Parameters

  • project: Project

    The project instance.

player​

public playerplayer: Player: void

Receive the player instance right after it is initialized.

Parameters

  • player: Player

    The player instance.

presenter​

public presenterpresenter: Presenter: void

Receive the presenter instance right after it is initialized.

Parameters

project​

public projectproject: Project: void

Receive the project instance right after it is initialized.

Parameters

  • project: Project

    The project instance.

renderer​

public rendererrenderer: Renderer: void

Receive the renderer instance right after it is initialized.

Parameters

  • renderer: Renderer

    The renderer instance.

settings​

public settingssettings: ProjectSettings: voidProjectSettings

Modify the project settings before the project is initialized.

Parameters

  • settings: ProjectSettings

    The project settings.