|
ICEfaces 3.3.0 Java API Documentation |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
org.icefaces.ace.component.chart.ChartBase
public class ChartBase
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.
| Nested Class Summary | |
|---|---|
protected static class |
ChartBase.PropertyKeys
|
| Field Summary | |
|---|---|
static java.lang.String |
COMPONENT_TYPE
|
static java.lang.String |
RENDERER_TYPE
|
| Fields inherited from class javax.faces.component.UIComponent |
|---|
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY |
| Constructor Summary | |
|---|---|
ChartBase()
|
|
| Method Summary | |
|---|---|
void |
addClientBehavior(java.lang.String eventName,
javax.faces.component.behavior.ClientBehavior behavior)
|
Axis |
getDefaultAxesConfig()
Return the value of the defaultAxesConfig property. |
java.lang.String |
getDefaultEventName()
|
java.lang.String |
getDefaultExecute(java.lang.String event)
|
java.lang.String |
getDefaultRender(java.lang.String event)
|
ChartSeries |
getDefaultSeriesConfig()
Return the value of the defaultSeriesConfig property. |
java.util.Collection<java.lang.String> |
getEventNames()
|
java.lang.String |
getFamily()
|
java.lang.Integer |
getHeight()
Return the value of the height property. |
HighlighterTooltipAxes |
getHighlighterAxes()
Return the value of the highlighterAxes property. |
java.lang.String |
getHighlighterFormatString()
Return the value of the highlighterFormatString property. |
Location |
getHighlighterLocation()
Return the value of the highlighterLocation property. |
java.lang.Integer |
getHighlighterYValueCount()
Return the value of the highlighterYValueCount property. |
Location |
getLegendLocation()
Return the value of the legendLocation property. |
LegendPlacement |
getLegendPlacement()
Return the value of the legendPlacement property. |
javax.el.MethodExpression |
getPointChangeListener()
Return the value of the pointChangeListener property. |
javax.el.MethodExpression |
getSelectListener()
Return the value of the selectListener property. |
java.lang.String |
getStyle()
Return the value of the style property. |
java.lang.String |
getTitle()
Return the value of the title property. |
java.lang.Object |
getValue()
Return the value of the value property. |
java.lang.String |
getWidgetVar()
Return the value of the widgetVar property. |
java.lang.Integer |
getWidth()
Return the value of the width property. |
Axis |
getX2Axis()
Return the value of the x2Axis property. |
Axis |
getXAxis()
Return the value of the xAxis property. |
Axis[] |
getYAxes()
Return the value of the yAxes property. |
java.lang.Boolean |
isAnimated()
Return the value of the animated property. |
java.lang.Boolean |
isCursor()
Return the value of the cursor property. |
java.lang.Boolean |
isHiddenInitPolling()
Return the value of the hiddenInitPolling property. |
java.lang.Boolean |
isHighlighter()
Return the value of the highlighter property. |
java.lang.Boolean |
isHighlighterBringSeriesToFront()
Return the value of the highlighterBringSeriesToFront property. |
java.lang.Boolean |
isHighlighterShowMarker()
Return the value of the highlighterShowMarker property. |
java.lang.Boolean |
isLegend()
Return the value of the legend property. |
java.lang.Boolean |
isShowTooltip()
Return the value of the showTooltip property. |
java.lang.Boolean |
isStackSeries()
Return the value of the stackSeries property. |
java.lang.Boolean |
isZoom()
Return the value of the zoom property. |
void |
setAnimated(java.lang.Boolean animated)
Set the value of the animated property. |
void |
setCursor(java.lang.Boolean cursor)
Set the value of the cursor property. |
void |
setDefaultAxesConfig(Axis defaultAxesConfig)
Set the value of the defaultAxesConfig property. |
void |
setDefaultSeriesConfig(ChartSeries defaultSeriesConfig)
Set the value of the defaultSeriesConfig property. |
void |
setHeight(java.lang.Integer height)
Set the value of the height property. |
void |
setHiddenInitPolling(java.lang.Boolean hiddenInitPolling)
Set the value of the hiddenInitPolling property. |
void |
setHighlighter(java.lang.Boolean highlighter)
Set the value of the highlighter property. |
void |
setHighlighterAxes(HighlighterTooltipAxes highlighterAxes)
Set the value of the highlighterAxes property. |
void |
setHighlighterBringSeriesToFront(java.lang.Boolean highlighterBringSeriesToFront)
Set the value of the highlighterBringSeriesToFront property. |
void |
setHighlighterFormatString(java.lang.String highlighterFormatString)
Set the value of the highlighterFormatString property. |
void |
setHighlighterLocation(Location highlighterLocation)
Set the value of the highlighterLocation property. |
void |
setHighlighterShowMarker(java.lang.Boolean highlighterShowMarker)
Set the value of the highlighterShowMarker property. |
void |
setHighlighterYValueCount(java.lang.Integer highlighterYValueCount)
Set the value of the highlighterYValueCount property. |
void |
setLegend(java.lang.Boolean legend)
Set the value of the legend property. |
void |
setLegendLocation(Location legendLocation)
Set the value of the legendLocation property. |
void |
setLegendPlacement(LegendPlacement legendPlacement)
Set the value of the legendPlacement property. |
void |
setPointChangeListener(javax.el.MethodExpression pointChangeListener)
Set the value of the pointChangeListener property. |
void |
setSelectListener(javax.el.MethodExpression selectListener)
Set the value of the selectListener property. |
void |
setShowTooltip(java.lang.Boolean showTooltip)
Set the value of the showTooltip property. |
void |
setStackSeries(java.lang.Boolean stackSeries)
Set the value of the stackSeries property. |
void |
setStyle(java.lang.String style)
Set the value of the style property. |
void |
setTitle(java.lang.String title)
Set the value of the title property. |
void |
setValue(java.lang.Object value)
Set the value of the value property. |
void |
setWidgetVar(java.lang.String widgetVar)
Set the value of the widgetVar property. |
void |
setWidth(java.lang.Integer width)
Set the value of the width property. |
void |
setX2Axis(Axis x2Axis)
Set the value of the x2Axis property. |
void |
setXAxis(Axis xAxis)
Set the value of the xAxis property. |
void |
setYAxes(Axis[] yAxes)
Set the value of the yAxes property. |
void |
setZoom(java.lang.Boolean zoom)
Set the value of the zoom property. |
| Methods inherited from class javax.faces.component.UIComponentBase |
|---|
addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent |
| Methods inherited from class javax.faces.component.UIComponent |
|---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder |
|---|
getClientBehaviors |
| Field Detail |
|---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String RENDERER_TYPE
| Constructor Detail |
|---|
public ChartBase()
| Method Detail |
|---|
public java.lang.String getFamily()
getFamily in class javax.faces.component.UIComponentpublic void setAnimated(java.lang.Boolean animated)
Set the value of the animated property.
Contents: Enables the draw animation behaviour of the chart. By default is enabled for all browsers but IE8 and lower for performanceconcerns.
setAnimated in interface IChartpublic java.lang.Boolean isAnimated()
Return the value of the animated property.
Contents: Enables the draw animation behaviour of the chart. By default is enabled for all browsers but IE8 and lower for performanceconcerns.
isAnimated in interface IChartpublic void setCursor(java.lang.Boolean cursor)
Set the value of the cursor property.
Contents: Enable a crosshair cursor on the chart.
setCursor in interface IChartpublic java.lang.Boolean isCursor()
Return the value of the cursor property.
Contents: Enable a crosshair cursor on the chart.
isCursor in interface IChartpublic void setDefaultAxesConfig(Axis defaultAxesConfig)
Set the value of the defaultAxesConfig property.
Contents: Define a Axis whose configuration is used where other axes have not made an explicit configuration.
setDefaultAxesConfig in interface IChartpublic Axis getDefaultAxesConfig()
Return the value of the defaultAxesConfig property.
Contents: Define a Axis whose configuration is used where other axes have not made an explicit configuration.
getDefaultAxesConfig in interface IChartpublic void setDefaultSeriesConfig(ChartSeries defaultSeriesConfig)
Set the value of the defaultSeriesConfig property.
Contents: Define 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.
setDefaultSeriesConfig in interface IChartpublic ChartSeries getDefaultSeriesConfig()
Return the value of the defaultSeriesConfig property.
Contents: Define 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.
getDefaultSeriesConfig in interface IChartpublic void setHeight(java.lang.Integer height)
Set the value of the height property.
Contents: Define the height of the entire chart region in pixels.
setHeight in interface IChartpublic java.lang.Integer getHeight()
Return the value of the height property.
Contents: Define the height of the entire chart region in pixels.
getHeight in interface IChartpublic void setHiddenInitPolling(java.lang.Boolean hiddenInitPolling)
Set the value of the hiddenInitPolling property.
Contents: Enable 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, 'chartWidgetvar.replot()' must be called.
setHiddenInitPolling in interface IChartpublic java.lang.Boolean isHiddenInitPolling()
Return the value of the hiddenInitPolling property.
Contents: Enable 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, 'chartWidgetvar.replot()' must be called. Default = 'true'.
isHiddenInitPolling in interface IChartpublic void setHighlighter(java.lang.Boolean highlighter)
Set the value of the highlighter property.
Contents: Enables drawing an info string at the cursor position when hovering at data points. Default configuration displays x, y values.
setHighlighter in interface IChartpublic java.lang.Boolean isHighlighter()
Return the value of the highlighter property.
Contents: Enables drawing an info string at the cursor position when hovering at data points. Default configuration displays x, y values.
isHighlighter in interface IChartpublic void setHighlighterAxes(HighlighterTooltipAxes highlighterAxes)
Set the value of the highlighterAxes property.
Contents: Defines the point values passed to the highlighter tooltip, either X, Y, XY or YX. Default is XY.
setHighlighterAxes in interface IChartpublic HighlighterTooltipAxes getHighlighterAxes()
Return the value of the highlighterAxes property.
Contents: Defines the point values passed to the highlighter tooltip, either X, Y, XY or YX. Default is XY.
getHighlighterAxes in interface IChartpublic void setHighlighterBringSeriesToFront(java.lang.Boolean highlighterBringSeriesToFront)
Set the value of the highlighterBringSeriesToFront property.
Contents: Enables the highlighted series being temporarily reordered to be entirely visible.
setHighlighterBringSeriesToFront in interface IChartpublic java.lang.Boolean isHighlighterBringSeriesToFront()
Return the value of the highlighterBringSeriesToFront property.
Contents: Enables the highlighted series being temporarily reordered to be entirely visible.
isHighlighterBringSeriesToFront in interface IChartpublic void setHighlighterFormatString(java.lang.String highlighterFormatString)
Set the value of the highlighterFormatString property.
Contents: Defines 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'
setHighlighterFormatString in interface IChartpublic java.lang.String getHighlighterFormatString()
Return the value of the highlighterFormatString property.
Contents: Defines 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'
getHighlighterFormatString in interface IChartpublic void setHighlighterLocation(Location highlighterLocation)
Set the value of the highlighterLocation property.
Contents: Defines the direction the highlighter tooltip is located relative to the cursor. Is 'NW' by default.
setHighlighterLocation in interface IChartpublic Location getHighlighterLocation()
Return the value of the highlighterLocation property.
Contents: Defines the direction the highlighter tooltip is located relative to the cursor. Is 'NW' by default.
getHighlighterLocation in interface IChartpublic void setHighlighterShowMarker(java.lang.Boolean highlighterShowMarker)
Set the value of the highlighterShowMarker property.
Contents: Enables drawing an 'active' styled point marker while the highlighter tooltip is shown. Is true by default.
setHighlighterShowMarker in interface IChartpublic java.lang.Boolean isHighlighterShowMarker()
Return the value of the highlighterShowMarker property.
Contents: Enables drawing an 'active' styled point marker while the highlighter tooltip is shown. Is true by default.
isHighlighterShowMarker in interface IChartpublic void setHighlighterYValueCount(java.lang.Integer highlighterYValueCount)
Set the value of the highlighterYValueCount property.
Contents: Defines 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.
setHighlighterYValueCount in interface IChartpublic java.lang.Integer getHighlighterYValueCount()
Return the value of the highlighterYValueCount property.
Contents: Defines 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.
getHighlighterYValueCount in interface IChartpublic void setLegend(java.lang.Boolean legend)
Set the value of the legend property.
Contents: Enabling displays the legend.
setLegend in interface IChartpublic java.lang.Boolean isLegend()
Return the value of the legend property.
Contents: Enabling displays the legend.
isLegend in interface IChartpublic void setLegendLocation(Location legendLocation)
Set the value of the legendLocation property.
Contents: Defines 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.
setLegendLocation in interface IChartpublic Location getLegendLocation()
Return the value of the legendLocation property.
Contents: Defines 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.
getLegendLocation in interface IChartpublic void setLegendPlacement(LegendPlacement legendPlacement)
Set the value of the legendPlacement property.
Contents: Defines the placement of the legend relative to the content of the chart. The available configurations are: INSIDE_GRID, OUTSIDE_GRID and OUTSIDE
setLegendPlacement in interface IChartpublic LegendPlacement getLegendPlacement()
Return the value of the legendPlacement property.
Contents: Defines the placement of the legend relative to the content of the chart. The available configurations are: INSIDE_GRID, OUTSIDE_GRID and OUTSIDE
getLegendPlacement in interface IChartpublic void setPointChangeListener(javax.el.MethodExpression pointChangeListener)
Set the value of the pointChangeListener property.
Contents: MethodExpression reference called whenever a series element is dragged to a new x or y value. The method receives a single argument, PointValueChangeEvent.
setPointChangeListener in interface IChartpublic javax.el.MethodExpression getPointChangeListener()
Return the value of the pointChangeListener property.
Contents: MethodExpression reference called whenever a series element is dragged to a new x or y value. The method receives a single argument, PointValueChangeEvent.
getPointChangeListener in interface IChartpublic void setSelectListener(javax.el.MethodExpression selectListener)
Set the value of the selectListener property.
Contents: MethodExpression reference called whenever a series element is selected. The method receives a single argument, SeriesSelectionEvent.
setSelectListener in interface IChartpublic javax.el.MethodExpression getSelectListener()
Return the value of the selectListener property.
Contents: MethodExpression reference called whenever a series element is selected. The method receives a single argument, SeriesSelectionEvent.
getSelectListener in interface IChartpublic void setShowTooltip(java.lang.Boolean showTooltip)
Set the value of the showTooltip property.
Contents: Enable display of a legend regarding the coordinates of the cursor. The 'cursor' property must be enabled to use this property.
setShowTooltip in interface IChartpublic java.lang.Boolean isShowTooltip()
Return the value of the showTooltip property.
Contents: Enable display of a legend regarding the coordinates of the cursor. The 'cursor' property must be enabled to use this property.
isShowTooltip in interface IChartpublic void setStackSeries(java.lang.Boolean stackSeries)
Set the value of the stackSeries property.
Contents: Enables a stack or "mountain" plot. Not all types of series may support this mode.
setStackSeries in interface IChartpublic java.lang.Boolean isStackSeries()
Return the value of the stackSeries property.
Contents: Enables a stack or "mountain" plot. Not all types of series may support this mode. Default = 'false'.
isStackSeries in interface IChartpublic void setStyle(java.lang.String style)
Set the value of the style property.
Contents: Define CSS inline style for the chart container.
setStyle in interface IChartpublic java.lang.String getStyle()
Return the value of the style property.
Contents: Define CSS inline style for the chart container.
getStyle in interface IChartpublic void setTitle(java.lang.String title)
Set the value of the title property.
Contents: Define a title of the entire chart.
setTitle in interface IChartpublic java.lang.String getTitle()
Return the value of the title property.
Contents: Define a title of the entire chart.
getTitle in interface IChartpublic void setValue(java.lang.Object value)
Set the value of the value property.
Contents: Define an individual instance or List of ChartSeries objects to draw on this plot.
setValue in interface IChartpublic java.lang.Object getValue()
Return the value of the value property.
Contents: Define an individual instance or List of ChartSeries objects to draw on this plot.
getValue in interface IChartpublic void setWidgetVar(java.lang.String widgetVar)
Set the value of the widgetVar property.
Contents: The JavaScript global component instance name. Must be unique among components on a page.
setWidgetVar in interface IChartpublic java.lang.String getWidgetVar()
Return the value of the widgetVar property.
Contents: The JavaScript global component instance name. Must be unique among components on a page.
getWidgetVar in interface IChartpublic void setWidth(java.lang.Integer width)
Set the value of the width property.
Contents: Define the width of the entire chart region in pixels.
setWidth in interface IChartpublic java.lang.Integer getWidth()
Return the value of the width property.
Contents: Define the width of the entire chart region in pixels.
getWidth in interface IChartpublic void setX2Axis(Axis x2Axis)
Set the value of the x2Axis property.
Contents: Defines the configuration of the x1 axis. Attempts are made to interpret a configuration if undefined.
setX2Axis in interface IChartpublic Axis getX2Axis()
Return the value of the x2Axis property.
Contents: Defines the configuration of the x1 axis. Attempts are made to interpret a configuration if undefined.
getX2Axis in interface IChartpublic void setXAxis(Axis xAxis)
Set the value of the xAxis property.
Contents: Defines the configuration of the x axis. Attempts are made to interpret a configuration if undefined.
setXAxis in interface IChartpublic Axis getXAxis()
Return the value of the xAxis property.
Contents: Defines the configuration of the x axis. Attempts are made to interpret a configuration if undefined.
getXAxis in interface IChartpublic void setYAxes(Axis[] yAxes)
Set the value of the yAxes property.
Contents: Defines the configuration of the y axes (up to 9). Attempts are made to interpret a configuration if undefined.
setYAxes in interface IChartpublic Axis[] getYAxes()
Return the value of the yAxes property.
Contents: Defines the configuration of the y axes (up to 9). Attempts are made to interpret a configuration if undefined.
getYAxes in interface IChartpublic void setZoom(java.lang.Boolean zoom)
Set the value of the zoom property.
Contents: Enable click+drag selection of a range on the chart using the cursor. The 'cursor' property must be enabled to use this property.
setZoom in interface IChartpublic java.lang.Boolean isZoom()
Return the value of the zoom property.
Contents: Enable click+drag selection of a range on the chart using the cursor. The 'cursor' property must be enabled to use this property.
isZoom in interface IChartpublic java.util.Collection<java.lang.String> getEventNames()
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHoldergetEventNames in class javax.faces.component.UIComponentBasepublic java.lang.String getDefaultEventName()
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHoldergetDefaultEventName in class javax.faces.component.UIComponentBasepublic java.lang.String getDefaultRender(java.lang.String event)
getDefaultRender in interface IceClientBehaviorHolderpublic java.lang.String getDefaultExecute(java.lang.String event)
getDefaultExecute in interface IceClientBehaviorHolder
public void addClientBehavior(java.lang.String eventName,
javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolderaddClientBehavior in class javax.faces.component.UIComponentBase
|
ICEfaces 3.3.0 Java API Documentation |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||