Fusionchart (ZK Enterprise Utilities 9.6.6.1 API)

java.lang.Object
- org.zkoss.zk.ui.AbstractComponent
- - org.zkoss.zk.ui.HtmlBasedComponent
  - - org.zkoss.zkmax.zul.Fusionchart

All Implemented Interfaces:: Serializable, Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl

public class Fusionchart
extends org.zkoss.zk.ui.HtmlBasedComponent

The Fusionchart 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	VERTICAL 3D	Horizontal 3D
area	`CategoryModel` or `XYModel`	No	No
bar	`CategoryModel`	Yes	No
gantt	`GanttModel`	No	No
line	`CategoryModel` or `XYModel`	Yes
pie	`PieModel`	Yes	Yes
funnel	`SingleValueCategoryModel`	No	No
stacked_bar	`CategoryModel`	Yes	Yes
stacked_area	`CategoryModel` or `XYModel`	No	No

Since:: 6.0.1
Author:: jimmyshiau
See Also:: ChartModel, Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent
  org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl
- Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent
  org.zkoss.zk.ui.AbstractComponent.Children

Field Summary

Fields
Modifier and Type Field and Description

static String ORIENT_HORIZONTAL

static String ORIENT_VERTICAL
- Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent
  _zclass
- Fields inherited from interface org.zkoss.zk.ui.Component
  APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE
- Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl
  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

Fields
Modifier and Type	Field and Description
`static String`	`ORIENT_HORIZONTAL`
`static String`	`ORIENT_VERTICAL`

Constructor Summary

Constructors
Constructor and Description

Fusionchart()

Constructors
Constructor and Description
`Fusionchart()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone()`
`AbstractChartConfig`	`getChartConfig()`
`String`	`getDataXMLPath()` Get the url of the chart data .xml file.
`String`	`getDateFormat()` Returns the date format used by date related Chart.
`FusionchartEngine<Fusionchart>`	`getEngine()`
`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.
`org.zkoss.zul.ChartModel`	`getModel()` Returns the chart model associated with this chart, or null if this chart is not associated with any chart data model.
`String`	`getOrient()` Get the chart orientation (vertical or horizontal)
`String`	`getSubTitle()` Get the chart's subtitle.
`<T> org.zkoss.zul.ListModel<T>`	`getTableModel()`
`<T> GanttTableRenderer<T>`	`getTableRenderer()`
`TimeZone`	`getTimeZone()` Returns the time zone that this Time Series Chart belongs to, or null if the default time zone is used.
`String`	`getTitle()` Get the chart's title.
`String`	`getType()` Get the chart's type.
`String`	`getXAxis()` Get the label in xAxis.
`String`	`getYAxis()` Get the label in yAxis.
`String`	`getZclass()`
`boolean`	`isChildable()` Not childable.
`boolean`	`isShowLegend()` Check whether show the legend of the chart.
`boolean`	`isShowTooltiptext()` Check whether show the tooltiptext.
`boolean`	`isThreeD()` Whether a 3d chart.
`protected FusionchartEngine<Fusionchart>`	`newChartEngine()` Instantiates the default chart engine.
`protected void`	`renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)`
`void`	`service(org.zkoss.zk.au.AuRequest request, boolean everError)`
`void`	`setChartConfig(AbstractChartConfig chartConfig)`
`void`	`setDataXMLPath(String url)` Set the url of the chart data .xml file.
`void`	`setDateFormat(String format)` Sets the date format used by date related Chart.
`void`	`setEngine(FusionchartEngine<Fusionchart> engine)` Sets the chart engine.
`void`	`setEngine(String clsnm)` Sets the chart engine by use of a class name.
`void`	`setHeight(String h)` Override super class to prepare the int height.
`void`	`setHflex(String flex)` Overrides the method in HtmlBasedComponent, not to check using hflex and width at the same time
`void`	`setModel(org.zkoss.zul.ChartModel model)` Sets the chart model associated with this chart.
`void`	`setModel(String clsnm)` Sets the model by use of a class name.
`void`	`setOrient(String orient)` Set the chart orientation.
`void`	`setShowLegend(boolean showLegend)` whether show the chart's legend.
`void`	`setShowTooltiptext(boolean showTooltiptext)` whether show the chart's tooltip.
`void`	`setSubTitle(String subTitle)` Set the chart's subtitle.
`void`	`setTableModel(org.zkoss.zul.ListModel<?> model)`
`void`	`setTableRenderer(GanttTableRenderer<?> renderer)`
`void`	`setThreeD(boolean threeD)` Set true to show three dimensional graph (If a type of chart got no 3d peer, this is ignored).
`void`	`setTimeZone(TimeZone tzone)` Sets the time zone that this Time Series Chart belongs to, or null if the default time zone is used.
`void`	`setTitle(String title)` Set the chart's title.
`void`	`setType(String type)` Set the chart's type (Chart.PIE, Chart.BAR, Chart.LINE, etc.).
`void`	`setVflex(String flex)` Overrides the method in HtmlBasedComponent, not to check using vflex and height at the same time
`void`	`setWidth(String w)` Override super class to prepare the int width.
`void`	`setXAxis(String label)` Set the label in xAxis.
`void`	`setYAxis(String label)` Set the label in yAxis.
`protected void`	`smartDrawChart()` mark a draw flag to inform that this Chart needs update.

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent
addSclass, evalCSSFlex, focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getPropertyAccess, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, removeSclass, removeSclass, 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

Methods inherited from class org.zkoss.zk.ui.AbstractComponent
addAnnotation, addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, 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, invalidatePartial, isInitialized, 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

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl
invalidatePartial

- Field Detail
  - ORIENT_VERTICAL
```
public static final String ORIENT_VERTICAL
```
    See Also:
    
    Constant Field Values
  - ORIENT_HORIZONTAL
```
public static final String ORIENT_HORIZONTAL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Fusionchart
```
public Fusionchart()
```
- Method Detail
  - setType
```
public void setType(String type)
```
    Set the chart's type (Chart.PIE, Chart.BAR, Chart.LINE, etc.).
    Default: pie.
  - getType
```
public String getType()
```
    Get the chart's type.
  - setThreeD
```
public void setThreeD(boolean threeD)
```
    Set true to show three dimensional graph (If a type of chart got no 3d peer, this is ignored).
  - isThreeD
```
public boolean isThreeD()
```
    Whether a 3d chart.
  - setTitle
```
public void setTitle(String title)
```
    Set the chart's title.
    
    Parameters:
    
    title - the chart's title.
  - getTitle
```
public String getTitle()
```
    Get the chart's title.
  - setSubTitle
```
public void setSubTitle(String subTitle)
```
    Set the chart's subtitle.
    
    Parameters:
    
    subTitle - the chart's subtitle.
  - getSubTitle
```
public String getSubTitle()
```
    Get the chart's subtitle.
  - setWidth
```
public void setWidth(String w)
```
    Override super class to prepare the int width.
    
    Overrides:
    
    setWidth in class org.zkoss.zk.ui.HtmlBasedComponent
  - setHflex
```
public void setHflex(String flex)
```
    Overrides the method in HtmlBasedComponent, not to check using hflex and width at the same time
    
    Overrides:
    
    setHflex in class org.zkoss.zk.ui.HtmlBasedComponent
    
    Since:
    
    8.0.1
  - getIntWidth
```
public int getIntWidth()
```
    Get the chart int width in pixel; to be used by the derived subclass.
  - setHeight
```
public void setHeight(String h)
```
    Override super class to prepare the int height.
    
    Overrides:
    
    setHeight in class org.zkoss.zk.ui.HtmlBasedComponent
  - setVflex
```
public void setVflex(String flex)
```
    Overrides the method in HtmlBasedComponent, not to check using vflex and height at the same time
    
    Overrides:
    
    setVflex in class org.zkoss.zk.ui.HtmlBasedComponent
    
    Since:
    
    8.0.1
  - getIntHeight
```
public int getIntHeight()
```
    Get the chart int width in pixel; to be used by the derived subclass.
  - setXAxis
```
public void setXAxis(String label)
```
    Set the label in xAxis.
    
    Parameters:
    
    label - label in xAxis.
  - getXAxis
```
public String getXAxis()
```
    Get the label in xAxis.
  - setYAxis
```
public void setYAxis(String label)
```
    Set the label in yAxis.
    
    Parameters:
    
    label - label in yAxis.
  - getYAxis
```
public String getYAxis()
```
    Get the label in yAxis.
  - setShowLegend
```
public void setShowLegend(boolean showLegend)
```
    whether show the chart's legend.
    
    Parameters:
    
    showLegend - true if want to show the legend (default to true).
  - isShowLegend
```
public boolean isShowLegend()
```
    Check whether show the legend of the chart.
  - setShowTooltiptext
```
public void setShowTooltiptext(boolean showTooltiptext)
```
    whether show the chart's tooltip.
    
    Parameters:
    
    showTooltiptext - true if want to pop the tooltiptext (default to true).
  - isShowTooltiptext
```
public boolean isShowTooltiptext()
```
    Check whether show the tooltiptext.
  - setOrient
```
public void setOrient(String orient)
```
    Set the chart orientation. Note:The two orient is no difference in Piechart.
    
    Parameters:
    
    orient - vertical or horizontal (default to vertical)
  - getOrient
```
public String getOrient()
```
    Get the chart orientation (vertical or horizontal)
  - getTimeZone
```
public TimeZone getTimeZone()
```
    Returns the time zone that this Time Series Chart belongs to, or null if the default time zone is used.
    The default time zone is determined by TimeZones.getCurrent().
  - setTimeZone
```
public void setTimeZone(TimeZone tzone)
```
    Sets the time zone that this Time Series Chart belongs to, or null if the default time zone is used.
    The default time zone is determined by TimeZones.getCurrent().
  - getDateFormat
```
public String getDateFormat()
```
    Returns the date format used by date related Chart.
    
    Returns:
    
    the date format used by date related Chart..
  - setDateFormat
```
public void setDateFormat(String format)
```
    Sets the date format used by date related Chart. This is the most important attribute, which you'll need to specify for all the Gantt charts that you build. With the help of this attribute, you're basically specifying the format in which you'll be providing your dates to FusionCharts.
    
    Parameters:
    
    format - MM/dd/yyyy or dd/MM/yyyy or yyyy/MM/dd (default to MM/dd/yyyy)
  - setDataXMLPath
```
public void setDataXMLPath(String url)
```
    Set the url of the chart data .xml file. See Fusionchart Free's FusionCharts Free Documentation for details.
    
    Parameters:
    
    url - the url path for the data xml path
  - getDataXMLPath
```
public String getDataXMLPath()
```
    Get the url of the chart data .xml file. See Fusionchart Free's FusionCharts Free Documentation for details.
  - getChartConfig
```
public AbstractChartConfig getChartConfig()
```
  - setChartConfig
```
public void setChartConfig(AbstractChartConfig chartConfig)
```
  - getTableRenderer
```
public <T> GanttTableRenderer<T> getTableRenderer()
```
  - setTableRenderer
```
public void setTableRenderer(GanttTableRenderer<?> renderer)
```
  - getModel
```
public org.zkoss.zul.ChartModel getModel()
```
    Returns the chart model associated with this chart, or null if this chart is not associated with any chart data model.
  - setModel
```
public void setModel(org.zkoss.zul.ChartModel model)
```
    Sets the chart model associated with this chart. If a non-null model is assigned, no matter whether it is the same as the previous, it will always cause re-render.
    
    Parameters:
    
    model - the chart model to associate, or null to dissociate any previous model.
    
    Throws:
    
    org.zkoss.zk.ui.UiException - if failed to initialize with the model
  - setModel
```
public void setModel(String clsnm)
              throws ClassNotFoundException,
                     NoSuchMethodException,
                     IllegalAccessException,
                     InstantiationException,
                     InvocationTargetException
```
    Sets the model by use of a class name. It creates an instance automatically.
    
    Throws:
    
    ClassNotFoundException
    
    NoSuchMethodException
    
    IllegalAccessException
    
    InstantiationException
    
    InvocationTargetException
  - getTableModel
```
public <T> org.zkoss.zul.ListModel<T> getTableModel()
```
  - setTableModel
```
public void setTableModel(org.zkoss.zul.ListModel<?> model)
```
  - getEngine
```
public FusionchartEngine<Fusionchart> getEngine()
                                         throws org.zkoss.zk.ui.UiException
```
    Throws:
    
    org.zkoss.zk.ui.UiException
  - newChartEngine
```
protected FusionchartEngine<Fusionchart> newChartEngine()
                                                 throws org.zkoss.zk.ui.UiException
```
    Instantiates the default chart engine. It is called, if setEngine(org.zkoss.zkmax.zul.fusionchart.FusionchartEngine<org.zkoss.zkmax.zul.Fusionchart>) 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 FusionchartEngine). If not found, UiException is thrown.
    Derived class might override this method to provide your own default class.
    
    Throws:
    
    org.zkoss.zk.ui.UiException - if failed to instantiate the engine
  - setEngine
```
public void setEngine(FusionchartEngine<Fusionchart> engine)
```
    Sets the chart engine.
  - setEngine
```
public void setEngine(String clsnm)
               throws ClassNotFoundException,
                      NoSuchMethodException,
                      IllegalAccessException,
                      InstantiationException,
                      InvocationTargetException
```
    Sets the chart engine by use of a class name. It creates an instance automatically.
    
    Throws:
    
    ClassNotFoundException
    
    NoSuchMethodException
    
    IllegalAccessException
    
    InstantiationException
    
    InvocationTargetException
  - smartDrawChart
```
protected void smartDrawChart()
```
    mark a draw flag to inform that this Chart needs update.
  - getZclass
```
public String getZclass()
```
    Overrides:
    
    getZclass in class org.zkoss.zk.ui.HtmlBasedComponent
  - clone
```
public Object clone()
```
    Specified by:
    
    clone in interface org.zkoss.zk.ui.Component
    
    Overrides:
    
    clone in class org.zkoss.zk.ui.HtmlBasedComponent
  - service
```
public void service(org.zkoss.zk.au.AuRequest request,
                    boolean everError)
```
    Specified by:
    
    service in interface org.zkoss.zk.ui.sys.ComponentCtrl
    
    Overrides:
    
    service in class org.zkoss.zk.ui.HtmlBasedComponent
  - renderProperties
```
protected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
                         throws IOException
```
    Overrides:
    
    renderProperties in class org.zkoss.zk.ui.HtmlBasedComponent
    
    Throws:
    
    IOException
  - isChildable
```
public boolean isChildable()
```
    Not childable.
    
    Overrides:
    
    isChildable in class org.zkoss.zk.ui.AbstractComponent

Class Fusionchart

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent

Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

Field Summary

Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

Fields inherited from interface org.zkoss.zk.ui.Component

Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

Constructor Summary

Method Summary

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

Methods inherited from class org.zkoss.zk.ui.AbstractComponent

Methods inherited from class java.lang.Object

Methods inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

Field Detail

ORIENT_VERTICAL

ORIENT_HORIZONTAL

Constructor Detail

Fusionchart

Method Detail

setType

getType

setThreeD

isThreeD

setTitle

getTitle

setSubTitle

getSubTitle

setWidth

setHflex

getIntWidth

setHeight

setVflex

getIntHeight

setXAxis

getXAxis

setYAxis

getYAxis

setShowLegend

isShowLegend

setShowTooltiptext

isShowTooltiptext

setOrient

getOrient

getTimeZone

setTimeZone

getDateFormat

setDateFormat

setDataXMLPath

getDataXMLPath

getChartConfig

setChartConfig

getTableRenderer

setTableRenderer

getModel

setModel

setModel

getTableModel

setTableModel

getEngine

newChartEngine

setEngine

setEngine

smartDrawChart

getZclass

clone

service

renderProperties

isChildable