|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Chart
The generic chart component. Developers set proper chart type, data model, and the threeD (3D) attribute to draw proper chart. 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 |
gantt | GanttModel |
No |
hilow | 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
Field Summary |
---|
Fields inherited from interface org.zkoss.zk.ui.Component |
---|
APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE |
Method Summary | |
---|---|
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, opacue). |
java.lang.String |
getBgColor()
Get the background color of the chart (in string as #RRGGBB). null means default. |
int[] |
getBgRGB()
Get the background color in int array (0: red, 1: green, 2:blue). null means default. |
java.lang.String |
getDateFormat()
Returns the date format used by date related Chart. |
ChartEngine |
getEngine()
Returns the implemetation chart engine. |
int |
getFgAlpha()
Get the foreground alpha (transparency, 0 ~ 255, opacue). |
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. |
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). null means default. |
int[] |
getPaneRGB()
Get the pane color in int array (0: red, 1: green, 2:blue). null means default. |
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.lang.String |
getType()
Get the chart's type. |
java.lang.String |
getXAxis()
Get the label in xAxis. |
java.lang.String |
getYAxis()
Get the label in yAxis. |
boolean |
isShowLegend()
Check whether show the legend of the chart. |
boolean |
isShowTooltiptext()
Check whether show the tooltiptext. |
boolean |
isThreeD()
Whether a 3d chart. |
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 |
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 |
setType(java.lang.String type)
Set the chart's type (Chart.PIE, Chart.BAR, Chart.LINE, etc.). |
void |
setXAxis(java.lang.String label)
Set the label in xAxis. |
void |
setYAxis(java.lang.String label)
Set the label in yAxis. |
Methods inherited from interface org.zkoss.zul.api.Image |
---|
getAlign, getBorder, getContent, getHover, getHspace, getSrc, getVspace, setAlign, setBorder, setContent, setContent, setHover, setHoverContent, setHoverContent, setHspace, setSrc, setVspace |
Methods inherited from interface org.zkoss.zul.impl.api.XulElement |
---|
getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip |
Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent |
---|
focus, getHeight, getLeft, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZclass, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex |
Methods inherited from interface org.zkoss.zk.ui.ext.Scope |
---|
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute |
Method Detail |
---|
void setType(java.lang.String type)
Default: pie.
java.lang.String getType()
void setThreeD(boolean b)
boolean isThreeD()
void setTitle(java.lang.String title)
title
- the chart's title.java.lang.String getTitle()
int getIntWidth()
int getIntHeight()
void setXAxis(java.lang.String label)
label
- label in xAxis.java.lang.String getXAxis()
void setYAxis(java.lang.String label)
label
- label in yAxis.java.lang.String getYAxis()
void setShowLegend(boolean showLegend)
showLegend
- true if want to show the legend (default to true).boolean isShowLegend()
void setShowTooltiptext(boolean showTooltiptext)
showTooltiptext
- true if want to pop the tooltiptext (default to true).boolean isShowTooltiptext()
void setPaneAlpha(int alpha)
alpha
- the transparency of pane color (0 ~ 255, default to 255
opaque).int getPaneAlpha()
void setPaneColor(java.lang.String color)
color
- in #RRGGBB format (hexdecimal).java.lang.String getPaneColor()
int[] getPaneRGB()
void setFgAlpha(int alpha)
alpha
- the transparency of foreground color (0 ~ 255, default to 255
opaque).int getFgAlpha()
void setBgAlpha(int alpha)
alpha
- the transparency of background color (0 ~ 255, default to 255
opaque).int getBgAlpha()
void setBgColor(java.lang.String color)
color
- in #RRGGBB format (hexdecimal).java.lang.String getBgColor()
int[] getBgRGB()
void setOrient(java.lang.String orient)
orient
- vertical or horizontal (default to vertical)java.lang.String getOrient()
java.util.TimeZone getTimeZone()
The default time zone is determined by
TimeZones.getCurrent()
.
void setTimeZone(java.util.TimeZone tzone)
The default time zone is determined by
TimeZones.getCurrent()
.
java.lang.String getPeriod()
void setPeriod(java.lang.String period)
java.lang.String getDateFormat()
void setDateFormat(java.lang.String format)
format
- ChartModel getModel()
void setModel(ChartModel model)
model
- the chart model to associate, or null to dis-associate any
previous model.
UiException
- if failed to initialize with the modelvoid 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
ChartEngine getEngine() throws UiException
UiException
- if failed to load the engine.void setEngine(ChartEngine engine)
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
ChartAreaListener getAreaListener()
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.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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |