Package org.pepstock.charba.client.plugins
Contains all classes to manage the plugin implementations.
- Author:
- Andrea "Stock" Stocchero
-
Interface Summary Interface Description PluginContainer This interface is defining the a container ofPlugin
instance.
This is implemented in order to avoid to expose the public methods of plugin interface to the users.SmartPluginContainer This interface is defining the a container ofSmartPlugin
instance.
This is implemented in order to avoid to expose the public methods of plugin interface to the users. -
Class Summary Class Description AbstractBasePlugin Base plugin class implementation.
It represents the instance to store in CHART.JS configuration.AbstractExtensionPlugin<T extends AbstractPluginOptions> Commons methods of extension, plugins out-of-the-box written in java script, to import and manage by Charba.AbstractPlugin Implements a plugin interface to help who will create a plugin do not create all methods.
The only method not implemented isgetId
which must implemented.
AllonBefore*
cancelable methods returntrue
.AbstractPluginOptions Abstract plugin options where to set all the configuration needed to the plugin.AbstractPluginOptionsFactory<T extends AbstractPluginOptions> Factory to get the plugin options (form chart, from datasets or from default global ones) related to the plugin.GlobalPlugins Global configuration to set plugins at global level.
It maps the CHART.JS object of default,chart.plugins
.NativeHook Enables the capability to create a plugin hook directly in java script language.
This could be helpful when for performance reason, you don't want to wraps all objects.
The hook will receive only 3 arguments, to use in the java script code,"chart"
,"args"
,"options"
.
See CHART.JS doc about the arguments.PluginIdChecker This utility checks if the plug ID is acceptable or not.Plugins Is the manager of plugins which can manage the list of plugins and returns them as java script object to store in the chart configuration.PluginsEnvelop<T> This object is a container of hidden object to pass to other packages.
It can not be instantiated in order that public methods can be invoked in safe mode.SmartPlugin Wraps a plugin, delegating the execution of all hooks to it.
the needed hooks can be added and CHART.JS will invoke only those hooks, improving the drawing performance. -
Enum Summary Enum Description AbstractPluginOptions.Property Name of properties of native object.