SparklineModule (classic-extensions 9.3.0.0-424 API)

java.lang.Object
- org.pentaho.reporting.libraries.base.boot.DefaultModuleInfo
- - org.pentaho.reporting.libraries.base.boot.AbstractModule
  - - org.pentaho.reporting.engine.classic.extensions.modules.sparklines.SparklineModule

All Implemented Interfaces:

org.pentaho.reporting.libraries.base.boot.Module, org.pentaho.reporting.libraries.base.boot.ModuleInfo
```
public class SparklineModule
extends org.pentaho.reporting.libraries.base.boot.AbstractModule
```
This module adds support for Sparkline graphs. Sparkline graphs are tiny word sized graphs allowing a rather fast reading of data evolution over the time (usual case).
Such graphs can be seen as tiny linecharts or barcharts.
For additional reading check out Sparklines: theory and practice thread.
This module adds BarSparkline and LineSparkline graph element types to the reporting engine.

Author:

Thomas Morgner

Field Summary

Fields
Modifier and Type Field Description

static String NAMESPACE

Constructor Summary

Constructors
Constructor Description

SparklineModule()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`initialize(org.pentaho.reporting.libraries.base.boot.SubSystem subSystem)`	Initializes the module.

Methods inherited from class org.pentaho.reporting.libraries.base.boot.AbstractModule
configure, getDescription, getName, getOptionalModules, getProducer, getRequiredModules, getSubSystem, isClassLoadable, loadModuleInfo, loadModuleInfo, performExternalInitialize, performExternalInitialize, setDescription, setName, setOptionalModules, setProducer, setRequiredModules, setSubSystem, toString

Methods inherited from class org.pentaho.reporting.libraries.base.boot.DefaultModuleInfo
equals, getMajorVersion, getMinorVersion, getModuleClass, getPatchLevel, hashCode, setMajorVersion, setMinorVersion, setModuleClass, setPatchLevel

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pentaho.reporting.libraries.base.boot.ModuleInfo
getMajorVersion, getMinorVersion, getModuleClass, getPatchLevel

- Field Detail
  - NAMESPACE
```
public static final String NAMESPACE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SparklineModule
```
public SparklineModule()
                throws org.pentaho.reporting.libraries.base.boot.ModuleInitializeException
```
    Throws:
    
    org.pentaho.reporting.libraries.base.boot.ModuleInitializeException
- Method Detail
  - initialize
```
public void initialize(org.pentaho.reporting.libraries.base.boot.SubSystem subSystem)
                throws org.pentaho.reporting.libraries.base.boot.ModuleInitializeException
```
    Initializes the module. Use this method to perform all initial setup operations. This method is called only once in a modules lifetime. If the initializing cannot be completed, throw a ModuleInitializeException to indicate the error,. The module will not be available to the system.
    
    Parameters:
    
    subSystem - the subSystem.
    
    Throws:
    
    org.pentaho.reporting.libraries.base.boot.ModuleInitializeException - if an error occurred while initializing the module.