ICEfaces ACE Components
Tag chart


Render a HTML <canvas&rt; data visualization using a Java interface to the jqPlot charting API. A List of ChartSeries subclasses define the data and its representation in the visualization.

For more information, see the Chart Wiki Documentation.


Client Events
NameDescriptionSupported Classes for ArgumentDefault Event Scopes
clickFired when data point is clicked plot.javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
dragStartFired when a drag has begun on a particular drag-enabled plot data point.javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
dragStopFired when a drag has ceased on a particular drag-enabled plot data point.javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
mouseInDataFired when the mouse is inside a filled plot region.javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
mouseOutDataFired when the mouse is outside a filled plot region.javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
showHighlighterFired when the highlighter is being displayed by the mouse being near an enabled data point.javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
hideHighlighterFired when the highlighter is being hidden by the mouse moving away from an enabled data point.javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
Client events can be used with Client Behaviors and the ace:ajax tag.


Tag Information
Tag Classorg.icefaces.ace.component.chart.ChartTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
animatednotruejava.lang.BooleanEnables the draw animation behaviour of the chart. By default is enabled for all browsers but IE8 and lower for performanceconcerns.
bindingnotruejavax.el.ValueExpressionUsing an EL expression, bind the component reference to a bean property, so that the component may be accessed in the bean.
cursornotruejava.lang.BooleanEnable a crosshair cursor on the chart.
defaultAxesConfignotrueorg.icefaces.ace.component.chart.AxisDefine a Axis whose configuration is used where other axes have not made an explicit configuration.
defaultSeriesColorsnotruejava.lang.String[]Allows users to specify default color series for all graphs, rather than by specifying per chart. See 'seriesColors' attribute in CartesianSeries to override the colors used per chart. If there are more series than colors, colors will wrap around and start at the beginning again. If empty will use default colors from jqPlot.
defaultSeriesConfignotrueorg.icefaces.ace.model.chart.ChartSeriesDefine a ChartSeries whose configuration is used where other ChartSeries have not made an explicit configuration. The data of this ChartSeries is irrelevant. If defined, this ChartSeries should explicitly have the typefield set, this will be used as the default type for all series which have not explicitly defined a type. If undefined the default type is determined by theChartSeries.getDefaultType() of the first attached series.
heightnotruejava.lang.IntegerDefine the height of the entire chart region in pixels.
hiddenInitPollingnotruejava.lang.BooleanEnable the default handling of the chart when rendered into a hidden page region. Thechart polls its hidden status, looking for when it is shown, and then completes its initialization.This can be expensive in environments of reduced JavaScript performance with many charts and a complex DOM.When this is disabled, upon revealing a chart, to ensure it is correctly displayed, 'ice.ace.instance('chartId').replot()' must be called. Default = 'true'.
highlighternotruejava.lang.BooleanEnables drawing an info string at the cursor position when hovering at data points. Default configuration displays x, y values.
highlighterAxesnotrueorg.icefaces.ace.component.chart.HighlighterTooltipAxesDefines the point values passed to the highlighter tooltip, either X, Y, XY or YX. Default is XY.
highlighterBringSeriesToFrontnotruejava.lang.BooleanEnables the highlighted series being temporarily reordered to be entirely visible.
highlighterFormatStringnotruejava.lang.StringDefines a format string populated with the x, y values indicated by the highlighterAxes. Takes C-style string format options ex. 'Date: %s, number of cats: %d'
highlighterLocationnotrueorg.icefaces.ace.component.chart.LocationDefines the direction the highlighter tooltip is located relative to the cursor. Is 'NW' by default.
highlighterShowMarkernotruejava.lang.BooleanEnables drawing an 'active' styled point marker while the highlighter tooltip is shown. Is true by default.
highlighterYValueCountnotruejava.lang.IntegerDefines how many Y values a highlighter should expect in the data points array. Typically this is 1. Certain plots, like OHLC, will have more y values in each data point array and will need this property adjusted to parse correctly.
idnotruejava.lang.StringThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.
imageExportListenernotruejavax.el.MethodExpressionMethodExpression reference called whenever an exportToServer() call is made for this chart in the client side. The method receives a single argument, ChartImageExportEvent. The bytes representing the PNG image are obtained as a byte array by calling getBytes() on the ChartImageExportEvent object.
legendnotruejava.lang.BooleanEnabling displays the legend.
legendLocationnotrueorg.icefaces.ace.component.chart.LocationDefines the location of legend relative to the bounds of the chart. All of the cardinal directions are available in the following format: N, NE, E, SE, S, etc.
legendPlacementnotrueorg.icefaces.ace.component.chart.LegendPlacementDefines the placement of the legend relative to the content of the chart. The available configurations are: INSIDE_GRID, OUTSIDE_GRID and OUTSIDE
pointChangeListenernotruejavax.el.MethodExpressionMethodExpression reference called whenever a series element is dragged to a new x or y value. The method receives a single argument, PointValueChangeEvent.
renderednotruebooleanReturn true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. Default = 'true'.
selectListenernotruejavax.el.MethodExpressionMethodExpression reference called whenever a series element is selected. The method receives a single argument, SeriesSelectionEvent.
showTooltipnotruejava.lang.BooleanEnable display of a legend regarding the coordinates of the cursor. The 'cursor' property must be enabled to use this property.
stackSeriesnotruejava.lang.BooleanEnables a stack or "mountain" plot. Not all types of series may support this mode. Default = 'false'.
stylenotruejava.lang.StringDefine CSS inline style for the chart container.
titlenotruejava.lang.StringDefine a title of the entire chart.
valuenotruejava.lang.ObjectDefine an individual instance or List of ChartSeries objects to draw on this plot.
widthnotruejava.lang.IntegerDefine the width of the entire chart region in pixels.
x2Axisnotrueorg.icefaces.ace.component.chart.AxisDefines the configuration of the x1 axis. Attempts are made to interpret a configuration if undefined.
xAxisnotrueorg.icefaces.ace.component.chart.AxisDefines the configuration of the x axis. Attempts are made to interpret a configuration if undefined.
yAxesnotrueorg.icefaces.ace.component.chart.Axis[]Defines the configuration of the y axes (up to 9). Attempts are made to interpret a configuration if undefined.
zoomnotruejava.lang.BooleanEnable click+drag selection of a range on the chart using the cursor. The 'cursor' property must be enabled to use this property.

Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.