Project Documentation

Summary

Tag name: <tr:chart>
UIComponent class: org.apache.myfaces.trinidad.component.core.data.CoreChart
Component type: org.apache.myfaces.trinidad.CoreChart

The Trinidad Chart is used to display data as a chart.

Code Example(s)

<tr:chart id="chart" verticalMajorSections="8" value="#{chartBean.value}"
          inlineStyle="width:680px; height:400px;"/>

Events

Type Phases Description
org.apache.myfaces.trinidad.event.AttributeChangeEventInvoke Application,
Apply Request Values
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing.

Attributes

Name Type Supports EL? Description
XMajorGridLineCountintYes Default Value: -1

This attribute controls the number of vertical major grid lines displayed in the chart. The default value is -1, which implies that the vertical major grid lines are controlled by the groupLabels in the chart model. This parameter along with the groupLabels provide flexibility in labeling the groups. For e.g. one can display a vertical bar chart with 2 years data. Only quarters may be labeled and XMajorGridLineCount can be 1 for splitting the data into two sections.
YMajorGridLineCountintYes Default Value: 3

This attribute controls the number of horizontal major grid lines displayed in the chart. For horizontal charts(horizontalBar, stackedHorizontalBar) this attribute controls the horizontal major grid lines. The default is 3.
YMinorGridLineCountintYes Default Value: -1

This attribute controls the number of minor grid lines displayed within a major grid section. The default value is -1, which means it varies per chart type. Currently it is used only for gauge charts with a default of 3.
animationDurationintYes Default Value: 1000

The duration of the animation for the chart components in milliseconds. Animation can be turned off if the animationDuration is set to 0. The default value is 1000ms.
attributeChangeListenerjavax.el.MethodExpressionOnly EL a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
bindingorg.apache.myfaces.trinidad.component.core.data.CoreChartOnly EL an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean.
chartDrillDownListenerjavax.el.MethodExpressionOnly EL a method reference to a drill down listener that will be called when the user drills down into the chart data.The method must take a parameter of type org.apache.myfaces.trinidad.event.ChartDrillDownEvent.
gradientsUsedbooleanYes Default Value: true

Specifies if gradients are used to display chart elements. By default the chart elements use gradients.
idStringNo the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML:
  • Must not be a zero-length String.
  • First character must be an ASCII letter (A-Za-z) or an underscore ('_').
  • Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').
inlineStyleStringYes the CSS styles to use for this component.
legendPositionStringYes Valid Values: none, bottom, end, top, start
Default Value: bottom

Specified the location of the legend. The legend can be turned off by setting this attribute to none. Otherwise it can be drawn at top, start, end or bottom.
maxPrecisionintYes Default Value: 0

The maximum precision of the numbers displayed on the yAxis(xAxis for horizontal charts). The default is 0.
partialTriggersString[]Yes the IDs of the components that should trigger a partial update.

This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"

Identifiers must account for NamingContainers. You can use a single colon to start the search from the root, or use multiple colons to move up through the NamingContainer. For example, "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), ":::" will pop out of two naming containers, etc. The search for the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the component with id = commandButton1 after popping out of two naming containers relative to this component. To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".

perspectivebooleanYes Default Value: true

Specifies if the chart is drawn with a perspective (2.5D). By default the chart is draw with a perspective.
renderedbooleanYes Default Value: true

whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client). If you want to change a component's rendered attribute from false to true using PPR, set the partialTrigger attribute of its parent component so the parent refreshes and in turn will render this component.
shortDescStringYes The short description of the component. This text is commonly used by user agents to display tooltip help text.
styleClassStringYes a CSS style class to use for this component.
templateSourceStringYes Specifies URI for the template document from which the chart elements are cloned. If this attribute is null, the chart component uses a default template. The default template is chosen based on whether the useGradient attribute is true or false. The template document is useful for changing the Look and Feel of the chart. Some examples include:1)A developer may want to skin the chart to match its corporate Look and Feel. 2)A developer may want to put water marks/background images inside the chart. 3)A developer may want to change the template for the gauges used in the gauge charts. 4)A developer may want to turn off gradients and instead use filters to set some interesting effects on the chart elements.
tooltipsVisiblebooleanYes Default Value: true

Specifies if tooltips are displayed or not.
typeStringYes Valid Values: verticalBar, horizontalBar, stackedVerticalBar, stackedHorizontalBar, pie, area, stackedArea, line, barLine, XYLine, scatterPlot, radar, radarArea, funnel, circularGauge, semiCircularGauge
Default Value: verticalBar

The type of chart. Possible Values are: verticalBar horizontalBar stackedVerticalBar stackedHorizontalBar pie area stackedArea line barLine XYLine scatterPlot radar radarArea funnel circularGauge semiCircularGauge.
valueObjectYes the data model being used by this component.The specific model class must be derived from org.apache.myfaces.trinidad.model.ChartModel. The derived class must override the abstract methods to provide the required values for chart display.