timePlotComponent
Description
This is a component that can easily generate a timeplot timeseries chart whithout needing a xaction file. The resultset is returned
from a mdx or sql query. In case of mdx queries, a role will be passed to mondrian if the session variable 'role' is
defined, allowing row level security.
Kettle transformations need to use db repository.
Note: Due to security restrictions, sql execution is disabled by default. If you want to enable sql copy the file
"cdf/components/timelinefeeder.xaction.sql" to "cdf/components/timelinefeeder.xaction" in the solutions directory.
All parameters can optionally be functions.
Options
- name
- The name of the component
- type
timePlotComponent- listeners
- Array - Parameters who this component will react to
- chartDefinition
- MetaLayer object with the definition of chart (see MetaLayer options)
- htmlObject
- Id of the component (usually a div or a span tag) to be replaced by the result
- refreshPeriod
- Time in seconds for this component to refresh. Default is 0 (disabled)
- executeAtStart
- True to execute the component at start, false otherwise
- tooltip
- Tooltip to be displayed when mouse hovers
- preExecution
- Function - Function to be called before the component is executed
- postExecution
- Function - Function to be called after the component is executed
MetaLayer options
The options related to charts map the ones described in pentaho wiki.
- columns
- Mandatory. An array of the columns that will be displayed. Unlike jFreeChartComponent, it has to be a fixed list of series
- queryType
- Type of query to read results from. Can be sql or mdx. Default: mdx
- jndi
- Connection to use for the query
- query
- sql or mdx Query to execute
- cube
- Cube name to use when queryType is mdx
- catalog
- Mondrian schema to use when queryType is mdx
- transformation
- Kettle transformation to use
- directory
- Kettle db repository directory
- importStep
- Kettle transformation's import step
- parameterN
- with N being 0 to 10 (eg: parameter0), this are the parameters passed
to the kettle transformation
- width
- Width of the chart. Default: 200
- height
- Height of the chart. Default: 200
- title
- Please check jFreeChart action documentation
- showValues
- Show a tooltip with the values. Default: true
- hideZeroToolTipValues
- Hides the tooltip when value is zero. Default: false
- dots
- Shows a dot for the values. Default: false
- fill
- Shows a color gradient on the plot. Default: false
Sample