Custom functions and host objects

Top   Previous   Next

JavaScript plug-in defines two extension points that allows other plug-ins to expose their functions and objects to Shell mode , JavaScript tab or JavaScript documents .

 

ru.biosoft.plugins.javascript.function

This extension point allows plug-in to contribute its JavaScript functions.This JavaScript functions will be shown in Analyses/JavaScript/Functions section in repository tree. Function help will be shown in View/Edit tab when the function item will be selected in repository tree.

 

ru.biosoft.plugins.javascript.hostObject

Using this extension point plug-in can provide access to particular Java objects (host objects) provided by plug-in. Plug-in host oblects will be shown in Analyses/JavaScript/Host objects section in repository tree. Host object description (help) will be shown in View/Edit tab when the host object item will be selected in repository tree.

 

Standard host objects

· R - facade for R usage.
· data - facade for data-manipulations.
· dataFilter - facade for data-filtering.
· microarray - facade for microarray analysis.
· sbw - host object for SBW integration.

 

Documentation

Using described above extension points developer can provide description (documentation) for his functions and host objects.

 

All functions and host objects for which help description is available will be shown in plug-in tree as children of JavaScript plug-in. When corresponding function or host object will be selected, its description will shown in Property Inspector pane.

 

Alternatively user can type function_name or help(function_name) and function description will be printed in JavaScript shell.