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.

To successfully use this component, you will want to be familiar with the chart properties reference.

Inputs

REQUIRED INPUTS

chart-data

...

The chart component expects several chart properties in order to render the proper chart and display your data appropriately. There are several ways to define chart attributes in an action sequence. You can specify the attributes properties in an input, as a resource, or in-line in the component definition section of the action sequence.

Note
titleThe Chart Component and Design Studio

While you can access the chart component through Design Studio's graphical UI, Design Studio does not provide a nice interface for defining all of your attributes properties yet, nor does it provide the appropriate UI for determining how and where you are going to specify your chart attributes properties (as an input or resource - Design Studio puts the chart-attributes element in the component definition by default). These enhancements will come (or you can contribute them!), but for now, you will need to use the XML editing tab of the action sequence to add your chart attributesproperties.

Chart Attributes as an Input

You can specify your chart attributes properties as a String input parameter. The caveat to this input is that the chart attributes properties need to be represented in the string in XML format, inside of a CDATA section.

...

Here is an example of specifying your chart attributes properties as an input string. You of course can also derive this string in a prior action, say, possibly a JavaScript rule.

...

Chart Attributes as a Resource

You can place the chart-attribute XML in a file, then reference that file as a resource in your action sequence.

The resource reference name in the chart component must be chart-attributes. The XML in the file is the chart-attribute XML you would find as an input or as a part of the component definition, starting with a root node of <chart-attributes>. Click here for an example of a file containing valid chart-attribute XML.

The action sequence XML for this looks similar to below:

...

By default, the Design Studio will put the chart-attributes XML node in the component definition. This in-line mode of describing the chart is fine, but can be problematic if you want to dynamically add or change a chart attribute property in the process of your action sequence. Which is why we added the ability to define the chart attributes properties in a resource or input definition.

...