Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • bar charts
  • line charts
  • bar line combination charts
  • pie charts
  • multi-pie charts (also known as pie grids)
  • area charts
  • bubble charts.

Inputs

REQUIRED INPUTS

chart-data

The dataset that you want the chart to render. Often, this is the output of a SQLLookupRule action, but can come from a number of source actions.

...

Code Block
xml
xml
borderStylesolid

   <action-definition> 
      <component-name>ChartComponent</component-name>
      <action-type>Bar Line Chart</action-type>

       ...

      <component-definition>
        <chart-attributes> 
          <chart-type>BarLineChart</chart-type>  
          <border-visible>true</border-visible>  
          <include-legend>false</include-legend>  
          <is-3D>false</is-3D>  
          <markers-visible>false</markers-visible>  

          ... more chart attributes here ...

        </chart-attributes>  
      </component-definition> 
    </action-definition>

OPTIONAL
Chart Row Dimension -- Indicates the chart data is to be aggregated along the row dimensions.
Title -- The chart title.
Subtitle -- The chart subtitle.
Title Font Style -- The font style to be used with the title and subtitle.
Title Font Size -- The font point size to be used with the title and subtitle.
Border Color -- The color of the chart border.
Chart Width -- The chart width.
Chart Height -- The chart height.
Title Position - Describes the position of the chart title. Valid positions are TOP, BOTTOM, LEFT, and RIGHT.
Range Title - Optional node that describes the chart range (usually the y-axis).
Chart Background - The color or image to be used as the chart background. This replaces the background of the chart itself and NOT the plot area. So if you set the image here you will probably see your image under the axis labels and scales and not in the plot area.
Plot Background - The color or image to be used as the plot background. This replaces the background of the plot area only.
Orientation -- The chart orientation. This can be either "Horizontal", "Vertical". Defaults to "Vertical".
Is 3D - If true the charting engine does it best to render a 3-D view of the chart.
Is Stacked - If true the charting engine will create a stacked version of this chart type (if possible).
Color Pallette - Singleton that contains a list of colors that make up the series paletteINPUTS

The following are additional properties that you can specify for the chart as inputs, or as part of the component-definition. Many of these properties duplicate properties that you can set inside of the chart definition (chart-attributes string or file). When these duplicate properties are set as inputs or as part of the component-definition, they override any identical property that exists in the chart-attributes. The hierarchical nature of these properties allows you to dynamically set and override a value, yet also have a default in the chart-attributes.

by-row
Indicates the chart data is to be aggregated along the row dimensions. Defaults to false.

title
Sets the chart title.

width
Sets the chart width.

height
Sets the chart height.

url-template
The template URL to use for a drill point in the chart. This template can have replaceable parameters embedded, whose values will be injected when the chart map is rendered.

paramName
A replaceable parameter for the URL template. Typically the category value from the drill point in the chart, if applicable.

series-name
A replaceable parameter for the URL template. Typically, the series name from the drill point in the chart; also referred to as ParamName2 in some docs.

Outputs

The ChartComponent can return both the chart and its image map (if drill URLs are defined via the URLTemplate) several different ways. Here are the legitimate outputs you can specify, and what the result of each is:

...