VisualizationAPIComponent

Description

This is a component that can execute visualizations that are registered in Pentaho Visualization API.

Options

name: The name of the component
type: visualizationAPIComponent
vizId: Id of the visualization to be rendered
listeners: Array - Parameters who this component will react to
vizOptions: Array - Parameters to pass as options to the visualization. This includes visual roles and other options for the visualization
queryDefinition: MetaLayer object with the query definition (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
preChange: Function - Function to be called before the component is executed. The component will be executed only if the result of preChange equals true.
postChange: Function - Function to be called after the component is executed
height: Display Height of the visualization - this is a required argument
width: Display Width of the visualization - this is a required argument

MetaLayer options

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

require([
  'cdf/Dashboard.Blueprint',
  'cdf/components/VisualizationAPIComponent'
], function(Dashboard, VisualizationAPIComponent) {

var dashboard = new Dashboard();

dashboard.setParameter("optionParam", "max");
  dashboard.setParameter("levelsParam", {fields: ["Country"]});
  dashboard.setParameter("measureParam", {fields: ["Quantity"]});

dashboard.addComponent(new VisualizationAPIComponent({
    name: "sampleVisualization",
    type: "visualizationAPIComponent",
    listeners: [],
    queryDefinition: {
      dataAccessId: "viz-query",
      path: "/public/plugin-samples/pentaho-cdf/legacy/actions/data-for-samples.cda",
      opts: {}
    },
    vizId: "pentaho/visual/samples/calc/Model",
    height: 200,
    width: 400,
    vizOptions: [["operation", "optionParam"],["levels", "levelsParam"],["measure", "measureParam"]],
    htmlObject: "sampleObject",
    executeAtStart: true,
    postFetch: function(data) {
      // Using postFetch to convert data types, because the query is passing
      // a Numeric field as String and that breaks the sample visualization
      data.metadata[0].colName = "Country";

data.metadata[1].colName = "Quantity";
      data.metadata[1].colType = "Numeric";
    }
  }));

dashboard.init();

dashboard.finishedInit = false;
});