360Works Charts 2/Documentation

From 360Works Product Documentation Wiki
Jump to: navigation, search

Contents

360Works Charts 2 User Guide

360Works Plugin Setup Guides

See Plugins_101 for Error reporting, installation, registration, and more.

Function Summary

  • ChartCreate ( chartDefinition ) — Creates a chart for the given definition and found set, and returns the chart image as container data.
  • ChartLastError ( ) — Returns the last Chart-related error which occurred.
  • ChartLicenseInfo ( ) — Returns information about the license used.
  • ChartRegister ( licenseKey ; registeredTo ) — Registers the plugin.
  • chartSetErrorCapture ( errorCapture ) — Toggles error dialogs on or off.
  • ChartVersion ( ) — Returns the version of the plugin which is installed.
  • ChartWizard ( chartDefinition ) — Opens a GUI wizard for generating a chart from the foudn set and chartDefinition parameter.

Function Detail

ChartCreate ( chartDefinition )

Creates a chart for the given definition and found set, and returns the chart image as container data.

Parameters:

chartDefinition
A chartDefinition, as obtained from a call to {@link #ChartWizard}.

Returns: A chart graphic displaying data for the current found set and chartDefinition.

ChartLastError ( )

Returns the last Chart-related error which occurred. This should be called any time that a plugin function returns "ERROR" to get a user-readable description of the error.

Returns: Error text, or "" if there was no error.

ChartLicenseInfo ( )

Returns information about the license used.


ChartRegister ( licenseKey ; registeredTo )

Registers the plugin.

Parameters:

licenseKey
a valid license key
registeredTo
the company the plugin is registered to

Returns: 1 on success, or "ERROR" on failure.

chartSetErrorCapture ( errorCapture )

Toggles error dialogs on or off. When something unexpected happens, the plug-in will pop up a dialog displaying the error message. This makes it easy to see what went wrong. However, in some cases, you (the developer) may prefer to show your own message to the user, or possibly not show a message at all. In that case, you can call chartSetErrorCapture with a parameter of true. That will suppress the error dialog from appearing to the user.

Parameters:

errorCapture
set to true to suppress the default popups.


ChartVersion ( )

Returns the version of the plugin which is installed.


ChartWizard ( chartDefinition )

Opens a GUI wizard for generating a chart from the foudn set and chartDefinition parameter.

Parameters:

chartDefinition
optional chart definition

Returns: updated chartDefinition if the "OK" button is clicked on the wizard, or the original chartDefinition if the user clicks "Cancel"
Personal tools
Namespaces

Variants
Actions
Plug-in Products
Other Products
Navigation
Toolbox