JSDoc: Class: PluginBase

Constructor

new PluginBase() → {SG2D.PluginBase}

Конструктор. Переопределяется, обязательно с вызовом super(). В конструкторе должен быть вызван один из статических методов плагина - failed() или success(). В конструкторе можно выполнить некоторую инициализацию, например, сгенерировать графические маски.

Source:

sg2d-plugin-base.js, line 8

Returns:

Type: SG2D.PluginBase

Example

class SG2DTransitions extends SG2D.PluginBase {
	...
	constructor(...args) {
		super(...args);
		...
		if (bError) {
			SG2DTransitions.failed("Error: message error!");
		} else {
			SG2DTransitions.success();
		}
	}
	...
}

Methods

(static) ready(successopt, failedopt) → {Promise}

Промис готовности плагина. Используется для выполнения методов вашего плагина только после успешной загрузки и инициализации плагина.

Parameters:

Name	Type	Attributes	Default	Description
`success`	function	<optional>	void 0
`failed`	function	<optional>	void 0

Source:

sg2d-plugin-base.js, line 22

Returns:

Type: Promise

Example

import SG2DTransitions from "./sg2d/plugins/sg2d-transitions.js";
...
SG2DTransitions.ready(()=>{
	SG2DTransitions.run(sg2dApp.clusters);
});