public class Chart extends Imagemap
Chart requires an implementation of an engine (ChartEngine
).
The default engine is based on JFreeChart and available in ZK PE and ZK EE.
The model and type must match to each other; or the result is unpredictable. The 3D chart is not supported on all chart type.
type | model | 3D |
---|---|---|
area | CategoryModel or XYModel | No |
bar | CategoryModel | Yes |
bubble | XYZModel | No |
candlestick | HiLoModel | No |
dial | @{link DialModel} | No |
gantt | GanttModel | No |
highlow | HiLoModel | No |
histogram | XYModel | No |
line | CategoryModel or XYModel | Yes |
pie | PieModel | Yes |
polar | XYModel | No |
ring | PieModel | No |
scatter | XYModel | No |
stacked_bar | CategoryModel | Yes |
stacked_area | CategoryModel or XYModel | No |
step | XYModel | No |
step_area | XYModel | No |
time_series | XYModel | No |
wafermap | WaferMapModel | No |
waterfall | CategoryModel | No |
wind | XYZModel | No |
ChartEngine
,
ChartModel
,
Serialized FormImage.ExtraCtrl
AbstractComponent.Children
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
AREA |
static java.lang.String |
BAR |
static java.lang.String |
BUBBLE |
static java.lang.String |
CANDLESTICK |
static java.lang.String |
COMBINATION |
static java.lang.String |
DAY |
static java.lang.String |
DIAL |
static java.lang.String |
FUNNEL |
static java.lang.String |
GANTT |
static java.lang.String |
HIGHLOW |
static java.lang.String |
HISTOGRAM |
static java.lang.String |
HOUR |
static java.lang.String |
LINE |
static java.lang.String |
MILLISECOND |
static java.lang.String |
MINUTE |
static java.lang.String |
MONTH |
static java.lang.String |
PIE |
static java.lang.String |
POLAR |
static java.lang.String |
QUARTER |
static java.lang.String |
RING |
static java.lang.String |
SCATTER |
static java.lang.String |
SECOND |
static java.lang.String |
STACKED_AREA |
static java.lang.String |
STACKED_BAR |
static java.lang.String |
STEP |
static java.lang.String |
STEP_AREA |
static java.lang.String |
TIME_SERIES |
static java.lang.String |
WAFERMAP |
static java.lang.String |
WATERFALL |
static java.lang.String |
WEEK |
static java.lang.String |
WIND |
static java.lang.String |
YEAR |
_zclass
APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE
AFTER_CHILD_ADDED, AFTER_CHILD_REMOVED, AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE
Constructor and Description |
---|
Chart() |
Modifier and Type | Method and Description |
---|---|
boolean |
addEventListener(java.lang.String evtnm,
EventListener<? extends Event> listener)
Adds an event listener to specified event name for this component.
|
java.lang.Object |
clone()
Clones the component.
|
ChartAreaListener |
getAreaListener()
Returns the renderer to render each area, or null if the default
renderer is used.
|
int |
getBgAlpha()
Get the background alpha (transparency, 0 ~ 255, opaque).
|
java.lang.String |
getBgColor()
Get the background color of the chart (in string as #RRGGBB).
|
int[] |
getBgRGB()
Get the background color in int array (0: red, 1: green, 2:blue).
|
java.lang.String |
getDateFormat()
Returns the date format used by date related Chart.
|
ChartEngine |
getEngine()
Returns the implementation chart engine.
|
int |
getFgAlpha()
Get the foreground alpha (transparency, 0 ~ 255, opaque).
|
int |
getIntHeight()
Get the chart int width in pixel; to be used by the derived subclass.
|
int |
getIntWidth()
Get the chart int width in pixel; to be used by the derived subclass.
|
java.awt.Font |
getLegendFont()
Returns the legend font of this chart.
|
ChartModel |
getModel()
Returns the chart model associated with this chart, or null
if this chart is not associated with any chart data model.
|
java.lang.String |
getOrient()
Get the chart orientation (vertical or horizontal)
|
int |
getPaneAlpha()
Get the pane alpha (transparency, 0 ~ 255, opacue).
|
java.lang.String |
getPaneColor()
Get the pane color of the chart (in string as #RRGGBB).
|
int[] |
getPaneRGB()
Get the pane color in int array (0: red, 1: green, 2:blue).
|
java.lang.String |
getPeriod()
Returns the period used in Time Series Chart.
|
java.util.TimeZone |
getTimeZone()
Returns the time zone that this Time Series Chart belongs to, or null if
the default time zone is used.
|
java.lang.String |
getTitle()
Get the chart's title.
|
java.awt.Font |
getTitleFont()
Returns the title font of this chart.
|
java.lang.String |
getType()
Get the chart's type.
|
java.lang.String |
getXAxis()
Get the label in xAxis.
|
java.awt.Font |
getXAxisFont()
Returns the label font of x axis of this chart.
|
java.awt.Font |
getXAxisTickFont()
Returns the tick number font of x axis of this chart.
|
java.lang.String |
getYAxis()
Get the label in yAxis.
|
java.awt.Font |
getYAxisFont()
Returns the label font of y axis of this chart.
|
java.awt.Font |
getYAxisTickFont()
Returns the tick number font of y axis of this chart.
|
boolean |
isShowLegend()
Check whether show the legend of the chart.
|
boolean |
isShowTooltiptext()
Check whether show the tooltiptext.
|
boolean |
isThreeD()
Whether a 3d chart.
|
protected ChartEngine |
newChartEngine()
Instantiates the default chart engine.
|
void |
setAreaListener(ChartAreaListener listener)
Sets the renderer which is used to render each area.
|
void |
setAreaListener(java.lang.String clsnm)
Sets the renderer by use of a class name.
|
void |
setBgAlpha(int alpha)
Set the background alpha (transparency, 0 ~ 255).
|
void |
setBgColor(java.lang.String color)
Set the background color of the chart.
|
void |
setDateFormat(java.lang.String format)
Sets the date format used by date related Chart.
|
void |
setEngine(ChartEngine engine)
Sets the chart engine.
|
void |
setEngine(java.lang.String clsnm)
Sets the chart engine by use of a class name.
|
void |
setFgAlpha(int alpha)
Set the foreground alpha (transparency, 0 ~ 255).
|
void |
setHeight(java.lang.String h)
Override super class to prepare the int height.
|
void |
setHflex(java.lang.String flex)
Overrides the method in HtmlBasedComponent, not to check using hflex and width at the same time
|
void |
setLegendFont(java.awt.Font font)
Sets the legend font of this chart.
|
void |
setModel(ChartModel model)
Sets the chart model associated with this chart.
|
void |
setModel(java.lang.String clsnm)
Sets the model by use of a class name.
|
void |
setOrient(java.lang.String orient)
Set the chart orientation.
|
void |
setPaneAlpha(int alpha)
Set the pane alpha (transparency, 0 ~ 255).
|
void |
setPaneColor(java.lang.String color)
Set the pane color of the chart.
|
void |
setPeriod(java.lang.String period)
Sets the period used in Time Series Chart.
|
void |
setShowLegend(boolean showLegend)
whether show the chart's legend.
|
void |
setShowTooltiptext(boolean showTooltiptext)
whether show the chart's tooltip.
|
void |
setThreeD(boolean b)
Set true to show three dimensional graph (If a type of chart got no 3d peer, this is ignored).
|
void |
setTimeZone(java.util.TimeZone tzone)
Sets the time zone that this Time Series Chart belongs to, or null if
the default time zone is used.
|
void |
setTitle(java.lang.String title)
Set the chart's title.
|
void |
setTitleFont(java.awt.Font font)
Sets the title font of this chart.
|
void |
setType(java.lang.String type)
Set the chart's type (Chart.PIE, Chart.BAR, Chart.LINE, etc.).
|
void |
setVflex(java.lang.String flex)
Overrides the method in HtmlBasedComponent, not to check using vflex and height at the same time
|
void |
setWidth(java.lang.String w)
Override super class to prepare the int width.
|
void |
setXAxis(java.lang.String label)
Set the label in xAxis.
|
void |
setXAxisFont(java.awt.Font axisFont)
Sets the label font of x axis of this chart.
|
void |
setXAxisTickFont(java.awt.Font axisTickFont)
Sets the tick number font of x axis of this chart.
|
void |
setYAxis(java.lang.String label)
Set the label in yAxis.
|
void |
setYAxisFont(java.awt.Font axisFont)
Sets the label font of y axis of this chart.
|
void |
setYAxisTickFont(java.awt.Font axisTickFont)
Sets the tick number font of y axis of this chart.
|
protected void |
smartDrawChart()
mark a draw flag to inform that this Chart needs update.
|
beforeChildAdded, isChildable
getAlign, getBorder, getContent, getExtraCtrl, getHover, getHspace, getSrc, getVspace, renderProperties, setAlign, setBorder, setContent, setContent, setHover, setHoverContent, setHoverContent, setHspace, setSrc, setVspace
getContext, getCtrlKeys, getPopup, getPropertyAccess, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributes
focus, getAction, getDraggable, getDroppable, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, service, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight0, setHeightDirectly, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex0, setVflexDirectly, setWidth0, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly
addAnnotation, addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getCallback, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize
public static final java.lang.String PIE
public static final java.lang.String FUNNEL
public static final java.lang.String RING
public static final java.lang.String BAR
public static final java.lang.String LINE
public static final java.lang.String AREA
public static final java.lang.String STACKED_BAR
public static final java.lang.String COMBINATION
public static final java.lang.String STACKED_AREA
public static final java.lang.String WATERFALL
public static final java.lang.String POLAR
public static final java.lang.String SCATTER
public static final java.lang.String TIME_SERIES
public static final java.lang.String STEP
public static final java.lang.String STEP_AREA
public static final java.lang.String HISTOGRAM
public static final java.lang.String CANDLESTICK
public static final java.lang.String HIGHLOW
public static final java.lang.String BUBBLE
public static final java.lang.String WAFERMAP
public static final java.lang.String GANTT
public static final java.lang.String WIND
public static final java.lang.String DIAL
public static final java.lang.String YEAR
public static final java.lang.String QUARTER
public static final java.lang.String MONTH
public static final java.lang.String WEEK
public static final java.lang.String DAY
public static final java.lang.String HOUR
public static final java.lang.String MINUTE
public static final java.lang.String SECOND
public static final java.lang.String MILLISECOND
public void setType(java.lang.String type)
Default: pie.
public java.lang.String getType()
public void setThreeD(boolean b)
public boolean isThreeD()
public void setTitle(java.lang.String title)
title
- the chart's title.public java.lang.String getTitle()
public void setWidth(java.lang.String w)
setWidth
in class HtmlBasedComponent
HtmlBasedComponent.setWidthDirectly(java.lang.String)
,
AbstractComponent.disableClientUpdate(boolean)
public void setHflex(java.lang.String flex)
setHflex
in class HtmlBasedComponent
flex
- horizontal flex hint of this component.HtmlBasedComponent.setVflex(java.lang.String)
,
HtmlBasedComponent.getHflex()
public int getIntWidth()
public void setHeight(java.lang.String h)
setHeight
in class HtmlBasedComponent
public void setVflex(java.lang.String flex)
setVflex
in class HtmlBasedComponent
flex
- the vertical flex hint.HtmlBasedComponent.setHflex(java.lang.String)
,
HtmlBasedComponent.getVflex()
public int getIntHeight()
public void setXAxis(java.lang.String label)
label
- label in xAxis.public java.lang.String getXAxis()
public void setYAxis(java.lang.String label)
label
- label in yAxis.public java.lang.String getYAxis()
public void setShowLegend(boolean showLegend)
showLegend
- true if want to show the legend (default to true).public boolean isShowLegend()
public void setShowTooltiptext(boolean showTooltiptext)
showTooltiptext
- true if want to pop the tooltiptext (default to true).public boolean isShowTooltiptext()
public void setPaneAlpha(int alpha)
alpha
- the transparency of pane color (0 ~ 255, default to 255 opaque).public int getPaneAlpha()
public void setPaneColor(java.lang.String color)
color
- in #RRGGBB format (hexadecimal).public java.lang.String getPaneColor()
public int[] getPaneRGB()
public void setFgAlpha(int alpha)
alpha
- the transparency of foreground color (0 ~ 255, default to 255 opaque).public int getFgAlpha()
public void setBgAlpha(int alpha)
alpha
- the transparency of background color (0 ~ 255, default to 255 opaque).public int getBgAlpha()
public void setBgColor(java.lang.String color)
color
- in #RRGGBB format (hexadecimal).public java.lang.String getBgColor()
public int[] getBgRGB()
public void setOrient(java.lang.String orient)
orient
- vertical or horizontal (default to vertical)public java.lang.String getOrient()
public java.util.TimeZone getTimeZone()
The default time zone is determined by TimeZones.getCurrent()
.
public void setTimeZone(java.util.TimeZone tzone)
The default time zone is determined by TimeZones.getCurrent()
.
public java.lang.String getPeriod()
public void setPeriod(java.lang.String period)
public java.lang.String getDateFormat()
public void setDateFormat(java.lang.String format)
format
- public ChartModel getModel()
public void setModel(ChartModel model)
model
- the chart model to associate, or null to dissociate
any previous model.UiException
- if failed to initialize with the modelpublic void setModel(java.lang.String clsnm) throws java.lang.ClassNotFoundException, java.lang.NoSuchMethodException, java.lang.IllegalAccessException, java.lang.InstantiationException, java.lang.reflect.InvocationTargetException
java.lang.ClassNotFoundException
java.lang.NoSuchMethodException
java.lang.IllegalAccessException
java.lang.InstantiationException
java.lang.reflect.InvocationTargetException
public java.awt.Font getTitleFont()
public void setTitleFont(java.awt.Font font)
font
- the title font of this chartpublic java.awt.Font getLegendFont()
public void setLegendFont(java.awt.Font font)
font
- the legend font of this chartpublic java.awt.Font getXAxisTickFont()
public void setXAxisTickFont(java.awt.Font axisTickFont)
axisTickFont
- the tick number font of x axis of this chartpublic java.awt.Font getXAxisFont()
public void setXAxisFont(java.awt.Font axisFont)
axisFont
- the label font of x axis of this chartpublic java.awt.Font getYAxisTickFont()
public void setYAxisTickFont(java.awt.Font axisTickFont)
axisTickFont
- the tick number font of y axis of this chartpublic java.awt.Font getYAxisFont()
public void setYAxisFont(java.awt.Font axisFont)
axisFont
- the tick number font of y axis of this chartpublic ChartEngine getEngine() throws UiException
UiException
- if failed to load the engine.protected ChartEngine newChartEngine() throws UiException
setEngine(org.zkoss.zul.impl.ChartEngine)
is not called with non-null
engine.
By default, it looks up the library property called
org.zkoss.zul.chart.engine.class.
If found, the value is assumed to be
the class name of the chart engine (it must implement
ChartEngine
).
If not found, UiException
is thrown.
Derived class might override this method to provide your own default class.
UiException
- if failed to instantiate the enginepublic void setEngine(ChartEngine engine)
public void setEngine(java.lang.String clsnm) throws java.lang.ClassNotFoundException, java.lang.NoSuchMethodException, java.lang.IllegalAccessException, java.lang.InstantiationException, java.lang.reflect.InvocationTargetException
java.lang.ClassNotFoundException
java.lang.NoSuchMethodException
java.lang.IllegalAccessException
java.lang.InstantiationException
java.lang.reflect.InvocationTargetException
public ChartAreaListener getAreaListener()
public void setAreaListener(ChartAreaListener listener)
Note: changing a render will not cause the chart to re-render. If you want it to re-render, you could call smartDraw.
listener
- the area listener, or null to ignore it.UiException
- if failed to initialize.public void setAreaListener(java.lang.String clsnm) throws java.lang.ClassNotFoundException, java.lang.NoSuchMethodException, java.lang.IllegalAccessException, java.lang.InstantiationException, java.lang.reflect.InvocationTargetException
java.lang.ClassNotFoundException
java.lang.NoSuchMethodException
java.lang.IllegalAccessException
java.lang.InstantiationException
java.lang.reflect.InvocationTargetException
protected void smartDrawChart()
public boolean addEventListener(java.lang.String evtnm, EventListener<? extends Event> listener)
Component
You could register listener to all components in the same page
by use of Page.addEventListener(java.lang.String, org.zkoss.zk.ui.event.EventListener<? extends org.zkoss.zk.ui.event.Event>)
.
ZK 5.0 and earlier, the second registration is ignored if an event listener has been registered twice. However, since 6.0.0 and later, it won't be ignored. If a listener has been registered multiple times, it will be invoked multiple times.
If you prefer to ignore the second registration, you could specify a library property called "org.zkoss.zk.ui.EventListener.duplicateIgnored" to true.
addEventListener
in interface Component
addEventListener
in class AbstractComponent
evtnm
- what event to listen (never null)Page.addEventListener(java.lang.String, org.zkoss.zk.ui.event.EventListener<? extends org.zkoss.zk.ui.event.Event>)
public java.lang.Object clone()
Component
clone
in interface Component
clone
in class XulElement
Copyright © 2005-2018 Potix Corporation. All Rights Reserved.