Package org.zkoss.chart

Class Charts

  • All Implemented Interfaces:
    Serializable, Cloneable, ChartsApi, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl
    public class Charts
extends org.zkoss.zk.ui.AbstractComponent
implements ChartsApi
    Charts is a ZK component that wraps the Highcharts.com charting library which is written in pure HTML5/JavaScript, offering intuitive, interactive charts to your website or web application. Charts component currently supports arcdiagram, area, arearange, areaspline, areasplinerange, bar, bellcurve, boxplot, bubble, bullet, column, columnpyramid, columnrange, cylinder, dependencywheel, dumbbell, errorbar, funnel (funnel3d), gauge, heatmap, histogram, item, line, lollipop, networkgraph, organization, packedbubble, pareto, pie, polygon, pyramid (pyramid3d), sankey, scatter (scatter3d), solidgauge, spline, streamgraph. sunburst, tilemap, timeline, treegraph, treemap, variablepie, variwide, vector, venn, windbarb, wordcloud, waterfall, and xrange chart types.

    Model supports:

    • CategoryModel: line, area, bar, column, columnpyramid, areaspline, waterfall, spline, streamgraph, bullet, cylinder
    • SingleValueCategoryModel: pie, pyramid (pyramid3d), funnel (funnel3d), and lollipop
    • DialModel: gauge
    • XYModel: line, area, bar, column, columnpyramid, areaspline, scatter, bubble, waterfall, spline, columnrange, errorbar, polygon, streamgraph, bullet, cylinder, windbarb
    • XYZModel: bubble, arearange, areasplinerange, heatmap, scatter3d, variwide
    • BoxPlotModel: boxplot
    • WordCloudModel: wordcloud
    • FromToModel: networkgraph, organization
    • FromToWeightModel: networkgraph, organization, sankey, dependencywheel, and arcdiagram
    • LowModel: lollipop
    • LowHighModel: dumbbell
    The model implementations use the same as Charts' API to manipulate the data of the model, so developer can use the Charts' API instead of using model if the chart data are not dynamically changed.

    Author:
    jumperchen, RaymondChao
    See Also:
    Serialized Form

    • Nested Class Summary

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

        org.zkoss.zk.ui.AbstractComponent.Children

    • Constructor Summary

      Constructors 
      Constructor Description
      Charts()  

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void addAnnotation​(Annotation annotation)
      Add an annotation to the chart after render time.
      void addAxis​(Axis axis)
      Add an axis to the chart after render time.
      void addEvent​(String name, org.zkoss.json.JavaScriptValue event)
      Sets a client side event for the chart.
      void addSeries​(Series series)
      Add a series to the chart after render time.
      void addSeriesAsDrilldown​(Point point, Series series)
      Add a series to the chart as drilldown from a specific point in the parent series.
      void clearPointSelection()
      Clears the selected points in the chart.
      Accessibility getAccessibility()
      Returns options for configuring accessibility for the chart.
      Annotation getAnnotation()
      Returns the Annotation options, if any.
      Annotation getAnnotation​(int index)
      Returns the Annotation options from the given index, if any.
      int getAnnotationSize()
      Returns the size of annotations
      Color getBackgroundColor()
      Returns the background color for the outer chart area.
      Color getBorderColor()
      Returns the color of the outer chart border.
      Object getBorderRadius()
      Returns the corner radius of the outer chart border.
      Number getBorderWidth()
      Returns the pixel width of the outer chart border.
      Caption getCaption()
      Returns the Caption options, if any.
      Chart getChart()
      Returns the Chart options, if any.
      String getClassName()
      Returns a CSS class name to apply to the charts container div, allowing unique CSS styling for each chart.
      ColorAxis getColorAxis()
      Returns the ColorAxis options, if any.
      ColorAxis getColorAxis​(int index)
      Returns the ColorAxis options from the given index, if any.
      List<Color> getColors()
      Returns the default colors for the chart's series.
      Credits getCredits()
      Returns the Credits options, if any.
      String getCtrlKeys()
      Returns what keystrokes to intercept.
      Data getData()
      Returns the data object.
      Drilldown getDrilldown()
      Returns the drilldown object.
      Map<String,​org.zkoss.json.JavaScriptValue> getEventsMap()
      Returns a map of client side event listeners for the chart.
      Exporting getExporting()
      Returns the Exporting options, if any.
      Number getHeight()
      Returns an explicit height for the chart.
      String getHflex()
      Returns horizontal flex hint of this chart.
      Labels getLabels()
      Returns the labels options
      Lang getLang()
      Returns the labels options
      Legend getLegend()
      Returns the Legend options, if any.
      Loading getLoading()
      Returns the Loading options, if any.
      Number[] getMargin()
      Returns the margin between the outer edge of the chart and the plot area.
      Number getMarginBottom()
      Returns the margin between the bottom outer edge of the chart and the plot area.
      Number getMarginLeft()
      Returns the margin between the left outer edge of the chart and the plot area.
      Number getMarginRight()
      Returns the margin between the right outer edge of the chart and the plot area.
      Number getMarginTop()
      Returns the margin between the top outer edge of the chart and the plot area.
      ChartsModel getModel()
      Returns the chart model associated with this chart, or null if this chart is not associated with any chart data model.
      Navigation getNavigation()
      Returns the navigation options
      NoData getNoData()
      Returns the no-data options
      Options getOptions()
      Returns the global options for all Charts.
      Options3D getOptions3D()
      Returns the options to render charts in 3 dimensions.
      Pane getPane()
      Returns the pane at the index 0
      Pane getPane​(int index)
      Returns the pane from the given index
      int getPaneSize()
      Returns the size of the pane list
      String getPanKey()
      Returns setting a key to switch between zooming and panning.
      ParallelAxes getParallelAxes()
      Returns common options for all yAxes rendered in a parallel coordinates plot, if any.
      String getPinchType()
      Returns equivalent to getZoomType(), but for multitouch gestures only.
      Color getPlotBackgroundColor()
      Returns the background color for the plot area.
      String getPlotBackgroundImage()
      Returns the URL for an image to use as the plot background.
      Color getPlotBorderColor()
      Returns the color of the inner chart or plot area border.
      Number getPlotBorderWidth()
      Returns the pixel width of the plot area border.
      PlotData getPlotData()
      Returns the plot data which is a JSON object to collect all chart's options for Charts JS.
      PlotOptions getPlotOptions()
      Returns the plotOptions option, if any.
      ResetZoomButton getResetZoomButton()
      Returns the button that appears after a selection zoom, allowing the user to reset zoom.
      Responsive getResponsive()
      Returns a set of rules to apply for different screen or chart sizes.
      ScrollablePlotArea getScrollablePlotArea()
      Returns the options for a scrollable plot area.
      Set<Point> getSelectedPoints()
      Returns a readonly set of all currently selected points in the chart.
      Color getSelectionMarkerFill()
      Returns the background color of the marker square when selecting (zooming in on) an area of the chart.
      Series getSeries()
      Returns the Series options, if any.
      Series getSeries​(int index)
      Returns the Series options from the given index, if any.
      int getSeriesSize()
      Returns the size of series
      Sonification getSonification()
      Returns the sonification options, if any.
      Number[] getSpacing()
      Returns the distance between the outer edge of the chart and the content, like title, legend, axis title or labels.
      Number getSpacingBottom()
      Returns the space between the bottom edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
      Number getSpacingLeft()
      Returns the space between the left edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
      Number getSpacingRight()
      Returns the space between the right edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
      Number getSpacingTop()
      Returns the space between the top edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
      <K,​V>
      Map<K,​V>      		 getStyle()
      Returns additional CSS styles to apply inline to the container div.
      Subtitle getSubtitle()
      Returns the Subtitle options, if any.
      Theme getTheme()
      Returns the global theme for all Charts.
      Title getTitle()
      Returns the Title options, if any.
      Tooltip getTooltip()
      Returns the Tooltip options, if any.
      String getType()
      Get the chart's type.
      String getVflex()
      Returns vertical flex hint of this chart.
      Number getWidth()
      Returns an explicit width for the chart.
      XAxis getXAxis()
      Returns the XAxis options, if any.
      XAxis getXAxis​(int index)
      Returns the XAxis options from the given index, if any.
      int getXAxisSize()
      Returns the size of xAxis
      YAxis getYAxis()
      Returns the YAxis options, if any.
      YAxis getYAxis​(int index)
      Returns the YAxis options from the given index, if any.
      int getyAxisSize()
      Deprecated.
      As of release 10.2.1.0, using getYAxisSize() instead.
      int getYAxisSize()
      Returns the size of yAxis
      ZAxis getZAxis()
      Returns the ZAxis options, if any.
      ZAxis getZAxis​(int index)
      Returns the ZAxis options from the given index, if any.
      int getzAxisSize()
      Returns the size of zAxis
      String getZclass()
      The default zclass is "z-charts"
      String getZoomType()
      Returns decides in what dimentions the user can zoom by dragging the mouse.
      void hideLoading()
      Hides the loading dim the chart'ts plot area after rendering time.
      void invalidate()  
      boolean isAlignTicks()
      Returns when using multiple axis, the ticks of two or more opposite axes will automatically be aligned by adding ticks to the axis or axes with the least ticks.
      boolean isAnimation()
      Returns whether enable the animation
      boolean isEnableZoomSelection()
      Returns whether selection event will zoom the chart to the selected area.
      boolean isIgnoreHiddenSeries()
      Returns if true, the axes will scale to the remaining visible series once one series is hidden.
      boolean isInverted()
      Returns whether to invert the axes so that the x axis is vertical and y axis is horizontal.
      boolean isPanning()
      Returns if allow panning in a chart.
      boolean isParallelCoordinates()
      Returns a flag to render charts as a parallel coordinates plot.
      boolean isPlotShadow()
      Returns whether to apply a drop shadow to the plot area.
      boolean isPolar()
      Returns whether transforms into the polar coordinate system
      boolean isReflow()
      Returns whether to reflow the chart to fit the width of the container div on resizing the window.
      boolean isRendered()
      Returns whether the component has been rendered to client side.
      boolean isShadow()
      Returns whether to apply a drop shadow to the outer chart area.
      boolean isShowAxes()
      Returns whether to show the axes initially.
      boolean isStyledMode()
      Returns whether to apply styled mode.
      void onSyncModel()  
      void print()
      Clears away other elements in the page and prints the chart as it is displayed.
      protected void renderProperties​(org.zkoss.zk.ui.sys.ContentRenderer renderer)  
      void selectPoint​(Point selPoint, boolean accumulate)  
      void service​(org.zkoss.zk.au.AuRequest request, boolean everError)  
      void setAccessibility​(Accessibility accessibility)
      Sets options for configuring accessibility for the chart.
      void setAlignTicks​(boolean alignTicks)
      Sets when using multiple axis, the ticks of two or more opposite axes will automatically be aligned by adding ticks to the axis or axes with the least ticks.
      void setAnimation​(boolean animation)
      Animation can be disabled throughout the chart by setting it to false here.
      void setBackgroundColor​(String backgroundColor)
      Sets the background color for the outer chart area.
      void setBackgroundColor​(Color color)
      Sets the background gradient for the outer chart area.
      void setBackgroundColor​(LinearGradient gradient)
      Sets the background gradient for the outer chart area.
      void setBackgroundColor​(RadialGradient gradient)
      Sets the background gradient for the outer chart area.
      void setBorderColor​(String borderColor)
      Sets the color of the outer chart border.
      void setBorderColor​(Color borderColor)
      Sets the color of the outer chart border.
      void setBorderColor​(LinearGradient borderColor)
      Sets the color of the outer chart border.
      void setBorderColor​(RadialGradient borderColor)
      Sets the color of the outer chart border.
      void setBorderRadius​(Number borderRadius)
      Sets the corner radius of the outer chart border.
      void setBorderWidth​(Number borderWidth)
      Sets the pixel width of the outer chart border.
      void setCaption​(String caption)
      Sets the chart caption.
      void setCaption​(Caption caption)
      Sets the Caption option.
      void setChart​(Chart chart)
      Sets the Chart options
      void setClassName​(String className)
      Sets a CSS class name to apply to the charts container div, allowing unique CSS styling for each chart.
      void setColors​(String... source)
      Sets the default colors for the chart's series.
      void setColors​(List<Color> colors)
      Sets the default colors for the chart's series.
      void setCredits​(Credits credits)
      Sets the Credits options
      void setCtrlKeys​(String ctrlKeys)
      Sets what keystrokes to intercept.
      void setDateFormat​(String format, Number time, boolean capitalize)
      Sets the formats a JavaScript date timestamp (milliseconds since Jan 1st 1970) into a human readable date string.
      void setEnableZoomSelection​(boolean enableZoomSelection)
      Sets whether selection event will zoom the chart to the selected area.
      void setEvents​(Map<String,​org.zkoss.json.JavaScriptValue> events)
      Sets a map of client side event listeners for the chart.
      void setExporting​(Exporting exporting)
      Sets the Exporting options.
      void setHeight​(Number height)
      Sets an explicit height for the chart.
      void setHeight​(String height)
      Sets an explicit height for the chart.
      void setHflex​(String flex)
      Sets horizontal flex hint of this chart.
      void setIgnoreHiddenSeries​(boolean ignoreHiddenSeries)
      Sets to ignore the hidden series, if true, the axes will scale to the remaining visible series once one series is hidden.
      void setInverted​(boolean inverted)
      Sets whether to invert the axes so that the x axis is vertical and y axis is horizontal.
      void setLabels​(Labels labels)
      Sets the labels options
      void setLang​(Lang lang)
      Sets the labels options
      void setLegend​(Legend legend)
      Sets the Legend options
      void setMargin​(Number margin)
      Sets the margin between the outer edge of the chart and the plot area.
      void setMargin​(Number[] margin)
      Sets the margin between the outer edge of the chart and the plot area.
      void setMargin​(String margins)
      Sets the margin between the outer edge of the chart and the plot area.
      void setMarginBottom​(Number marginBottom)
      Sets the margin between the bottom outer edge of the chart and the plot area.
      void setMarginLeft​(Number marginLeft)
      Sets the margin between the left outer edge of the chart and the plot area.
      void setMarginRight​(Number marginRight)
      Sets the margin between the right outer edge of the chart and the plot area.
      void setMarginTop​(Number marginTop)
      Sets the margin between the top outer edge of the chart and the plot area.
      void setModel​(ChartsModel model)
      Sets the chart model associated with this chart.
      void setModel​(org.zkoss.zul.ChartModel model)  
      void setNavigation​(Navigation navigation)
      Sets the navigation options
      void setNoData​(NoData noData)
      Sets the no-data options
      void setNumberFormat​(Number number, Number decimals, String decimalPoint, String thousandsSep)
      Formats a JavaScript number with grouped thousands, a fixed amount of decimals and an optional decimal point.
      void setOptions​(Options options)
      Sets the global options for all Charts in the same browser page.
      void setOptions3D​(Options3D options3D)
      Sets the options to render charts in 3 dimensions.
      void setPanKey​(String panKey)
      Sets setting a key to switch between zooming and panning.
      void setPanning​(boolean panning)
      Sets if allow panning in a chart.
      void setParallelAxes​(ParallelAxes parallelAxes)
      Sets common options for all yAxes rendered in a parallel coordinates plot.
      void setParallelCoordinates​(boolean parallelCoordinates)
      Sets a flag to render charts as a parallel coordinates plot.
      void setPinchType​(String pinchType)
      Sets equivalent to setZoomType(String), but for multitouch gestures only.
      void setPlotBackgroundColor​(String plotBackgroundColor)
      Sets the background color for the plot area.
      void setPlotBackgroundColor​(Color plotBackgroundColor)
      Sets the background color for the plot area.
      void setPlotBackgroundColor​(LinearGradient plotBackgroundColor)
      Sets the background color for the plot area.
      void setPlotBackgroundColor​(RadialGradient plotBackgroundColor)
      Sets the background color for the plot area.
      void setPlotBackgroundImage​(String plotBackgroundImage)
      Sets the URL for an image to use as the plot background.
      void setPlotBorderColor​(String plotBorderColor)
      Sets the color of the inner chart or plot area border.
      void setPlotBorderColor​(Color plotBorderColor)
      Sets the color of the inner chart or plot area border.
      void setPlotBorderColor​(LinearGradient plotBorderColor)
      Sets the color of the inner chart or plot area border.
      void setPlotBorderColor​(RadialGradient plotBorderColor)
      Sets the color of the inner chart or plot area border.
      void setPlotBorderWidth​(Number plotBorderWidth)
      Sets the pixel width of the plot area border.
      void setPlotOptions​(PlotOptions plotOptions)
      Sets the plotOptions options
      void setPlotShadow​(boolean plotShadow)
      Sets whether to apply a drop shadow to the plot area.
      void setPolar​(boolean polar)
      Sets to true to enable the cartesian charts like line, spline, area and column are transformed into the polar coordinate system.
      void setReflow​(boolean reflow)
      Sets whether to reflow the chart to fit the width of the container div on resizing the window.
      void setResetZoomButton​(ResetZoomButton resetZoomButton)
      Sets the button that appears after a selection zoom, allowing the user to reset zoom.
      void setResponsive​(Responsive responsive)
      Sets a set of rules to apply for different screen or chart sizes.
      void setScrollablePlotArea​(ScrollablePlotArea scrollablePlotArea)
      Sets the options for a scrollable plot area.
      void setSelectionMarkerFill​(String selectionMarkerFill)
      Sets the background color of the marker square when selecting (zooming in on) an area of the chart.
      void setSelectionMarkerFill​(Color selectionMarkerFill)
      Sets the background color of the marker square when selecting (zooming in on) an area of the chart.
      void setSelectionMarkerFill​(LinearGradient selectionMarkerFill)
      Sets the background color of the marker square when selecting (zooming in on) an area of the chart.
      void setSelectionMarkerFill​(RadialGradient selectionMarkerFill)
      Sets the background color of the marker square when selecting (zooming in on) an area of the chart.
      void setShadow​(boolean shadow)
      Sets whether to apply a drop shadow to the outer chart area.
      void setShowAxes​(boolean showAxes)
      Sets whether to show the axes initially.
      void setSonification​(Sonification sonification)
      Sets the sonification options
      void setSpacing​(Number[] spacing)
      Sets the distance between the outer edge of the chart and the content, like title, legend, axis title or labels.
      void setSpacing​(String spacings)
      Sets the distance between the outer edge of the chart and the content, like title, legend, axis title or labels.
      void setSpacingBottom​(Number spacingBottom)
      Sets the space between the bottom edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
      void setSpacingLeft​(Number spacingLeft)
      Sets the space between the left edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
      void setSpacingRight​(Number spacingRight)
      Sets the space between the right edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
      void setSpacingTop​(Number spacingTop)
      Sets the space between the top edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
      void setStyle​(String style)
      Sets additional CSS styles to apply inline to the container div.
      <K,​V>
      void      		 setStyle​(Map<K,​V> style)
      Sets additional CSS styles to apply inline to the container div.
      void setStyledMode​(boolean styledMode)
      Sets whether to apply styled mode.
      void setSubtitle​(String subtitle)
      Sets the chart subtitle
      void setSubtitle​(Subtitle subtitle)
      Sets the Subtitle options
      void setTheme​(Theme theme)
      Sets the theme options for all Charts in the same browser page.
      void setTitle​(String title)
      Sets the chart title.
      void setTitle​(Title title)
      Sets the Title options
      void setTooltip​(Tooltip tooltip)
      Sets the Tooltip options
      void setType​(String type)
      Set the chart's type (Charts.PIE, Charts.BAR, Charts.LINE, etc.).
      void setVflex​(String flex)
      Sets vertical flex hint of this chart.
      void setWidth​(Number width)
      Sets an explicit width for the chart.
      void setXAxis​(XAxis xaxis)
      Sets the xAxis with out putting it in an Array
      void setYAxis​(YAxis yaxis)
      Sets the yAxis with out putting it in an Array
      void setZAxis​(ZAxis zaxis)
      Sets the zAxis with out putting it in an Array
      void setZclass​(String zclass)
      Sets the zclass for this component
      void setZoomType​(String zoomType)
      Sets decides in what dimentions the user can zoom by dragging the mouse.
      void showLoading​(String text)
      Shows the loading dim the chart'ts plot area with the given text after rendering time, if any.
      protected void smartDrawChart()
      mark a draw flag to inform that this Chart needs update.
      protected void smartUpdate​(String attr, Object value, boolean append)  
      void toggleSonify()
      Play/pause sonification of a chart.

      • 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, clone, 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, getExtraCtrl, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getPropertyAccess, 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, invalidatePartial, isChildable, 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, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize

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

        invalidatePartial

    • Constructor Detail

      • Charts

        public Charts()

    • Method Detail

      • getPlotData

        public PlotData getPlotData()
        Returns the plot data which is a JSON object to collect all chart's options for Charts JS.
        Specified by:
        getPlotData in interface ChartsApi

      • getData

        public Data getData()
        Returns the data object.
        Specified by:
        getData in interface ChartsApi
        Since:
        11.2.0.0

      • setOptions

        public void setOptions​(Options options)
        Sets the global options for all Charts in the same browser page.

      • setDateFormat

        public void setDateFormat​(String format,
                          Number time,
                          boolean capitalize)
        Sets the formats a JavaScript date timestamp (milliseconds since Jan 1st 1970) into a human readable date string. The format is a subset of the formats for PHP's strftime function.
        Parameters:
        format - A string containing some of the formats above.
        time - The JavaScript time to format.
        capitalize - Whether to capitalize words in the return string.

      • setNumberFormat

        public void setNumberFormat​(Number number,
                            Number decimals,
                            String decimalPoint,
                            String thousandsSep)
        Formats a JavaScript number with grouped thousands, a fixed amount of decimals and an optional decimal point. It is a port of PHP's function with the same name. See PHP number_format for a full explanation of the parameters.
        Parameters:
        number - The raw number to format.
        decimals - The desired number of decimals.
        decimalPoint - The decimal point. Defaults to "." or to the string specified globally in Lang.setDecimalPoint(String).
        thousandsSep - The thousands separator. Defaults to " " or to the string specified globally in Lang.setThousandsSep(String)

      • setColors

        public void setColors​(List<Color> colors)
        Sets the default colors for the chart's series. When all colors are used, new colors are pulled from the start again.
        Specified by:
        setColors in interface ChartsApi

      • setColors

        public void setColors​(String... source)
        Sets the default colors for the chart's series. When all colors are used, new colors are pulled from the start again.
        Specified by:
        setColors in interface ChartsApi

      • getColors

        public List<Color> getColors()
        Returns the default colors for the chart's series. When all colors are used, new colors are pulled from the start again.
        Specified by:
        getColors in interface ChartsApi

      • setTheme

        public void setTheme​(Theme theme)
        Sets the theme options for all Charts in the same browser page.
        Specified by:
        setTheme in interface ChartsApi

      • getTheme

        public Theme getTheme()
        Returns the global theme for all Charts.

        Default is null

        Specified by:
        getTheme in interface ChartsApi

      • getOptions

        public Options getOptions()
        Returns the global options for all Charts.

        Default is null.

      • getModel

        public ChartsModel getModel()
        Returns the chart model associated with this chart, or null if this chart is not associated with any chart data model.
        Specified by:
        getModel in interface ChartsApi

      • setModel

        public void setModel​(ChartsModel 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.
        Specified by:
        setModel in interface ChartsApi
        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​(org.zkoss.zul.ChartModel model)
        Specified by:
        setModel in interface ChartsApi

      • onSyncModel

        public void onSyncModel()

      • showLoading

        public void showLoading​(String text)
        Shows the loading dim the chart'ts plot area with the given text after rendering time, if any.

      • hideLoading

        public void hideLoading()
        Hides the loading dim the chart'ts plot area after rendering time.

      • print

        public void print()
        Clears away other elements in the page and prints the chart as it is displayed.

      • setType

        public void setType​(String type)
        Set the chart's type (Charts.PIE, Charts.BAR, Charts.LINE, etc.).

        Default: line.

        Specified by:
        setType in interface ChartsApi

      • getType

        public String getType()
        Get the chart's type.

        Default: line.

        Specified by:
        getType in interface ChartsApi

      • setAlignTicks

        public void setAlignTicks​(boolean alignTicks)
        Sets when using multiple axis, the ticks of two or more opposite axes will automatically be aligned by adding ticks to the axis or axes with the least ticks. This can be prevented by setting alignTicks to false. If the grid lines look messy, it's a good idea to hide them for the secondary axis by setting gridLineWidth to 0.
        Specified by:
        setAlignTicks in interface ChartsApi
        Parameters:
        alignTicks - when using multiple axis, the ticks of two or more opposite axes will automatically be aligned by adding ticks to the axis or axes with the least ticks
        See Also:
        Chart.setAlignTicks(boolean)

      • isAlignTicks

        public boolean isAlignTicks()
        Returns when using multiple axis, the ticks of two or more opposite axes will automatically be aligned by adding ticks to the axis or axes with the least ticks. This can be prevented by setting alignTicks to false. If the grid lines look messy, it's a good idea to hide them for the secondary axis by setting gridLineWidth to 0.

        Default: true.

        Specified by:
        isAlignTicks in interface ChartsApi
        See Also:
        Chart.isAlignTicks()

      • isAnimation

        public boolean isAnimation()
        Returns whether enable the animation

        Default: true

        Specified by:
        isAnimation in interface ChartsApi

      • setIgnoreHiddenSeries

        public void setIgnoreHiddenSeries​(boolean ignoreHiddenSeries)
        Sets to ignore the hidden series, if true, the axes will scale to the remaining visible series once one series is hidden. If false, hiding and showing a series will not affect the axes or the other series. For stacks, once one series within the stack is hidden, the rest of the stack will close in around it even if the axis is not affected.
        Specified by:
        setIgnoreHiddenSeries in interface ChartsApi
        Parameters:
        ignoreHiddenSeries - if true, the axes will scale to the remaining visible series once one series is hidden

      • isIgnoreHiddenSeries

        public boolean isIgnoreHiddenSeries()
        Returns if true, the axes will scale to the remaining visible series once one series is hidden. If false, hiding and showing a series will not affect the axes or the other series. For stacks, once one series within the stack is hidden, the rest of the stack will close in around it even if the axis is not affected.

        Default: true.

        Specified by:
        isIgnoreHiddenSeries in interface ChartsApi

      • setBackgroundColor

        public void setBackgroundColor​(String backgroundColor)
        Sets the background color for the outer chart area.
        Specified by:
        setBackgroundColor in interface ChartsApi
        Parameters:
        backgroundColor - the background color for the outer chart area

      • setBackgroundColor

        public void setBackgroundColor​(Color color)
        Sets the background gradient for the outer chart area.
        Specified by:
        setBackgroundColor in interface ChartsApi

      • setBorderColor

        public void setBorderColor​(String borderColor)
        Sets the color of the outer chart border. The border is painted using vector graphic techniques to allow rounded corners.
        Specified by:
        setBorderColor in interface ChartsApi

      • setBorderColor

        public void setBorderColor​(LinearGradient borderColor)
        Sets the color of the outer chart border. The border is painted using vector graphic techniques to allow rounded corners.
        Specified by:
        setBorderColor in interface ChartsApi

      • setBorderColor

        public void setBorderColor​(RadialGradient borderColor)
        Sets the color of the outer chart border. The border is painted using vector graphic techniques to allow rounded corners.
        Specified by:
        setBorderColor in interface ChartsApi

      • setBorderColor

        public void setBorderColor​(Color borderColor)
        Sets the color of the outer chart border. The border is painted using vector graphic techniques to allow rounded corners.
        Specified by:
        setBorderColor in interface ChartsApi

      • getBorderColor

        public Color getBorderColor()
        Returns the color of the outer chart border. The border is painted using vector graphic techniques to allow rounded corners.

        Default: "#4572A7".

        Specified by:
        getBorderColor in interface ChartsApi
        See Also:
        Chart.getBorderColor()

      • setBorderRadius

        public void setBorderRadius​(Number borderRadius)
        Sets the corner radius of the outer chart border. In export, the radius defaults to 0.

        Default: 5.

        Specified by:
        setBorderRadius in interface ChartsApi
        Parameters:
        borderRadius - the corner radius of the outer chart border
        See Also:
        Chart.setBorderRadius(Number)

      • setBorderWidth

        public void setBorderWidth​(Number borderWidth)
        Sets the pixel width of the outer chart border. The border is painted using vector graphic techniques to allow rounded corners.
        Specified by:
        setBorderWidth in interface ChartsApi
        See Also:
        Chart.setBorderWidth(Number)

      • getBorderWidth

        public Number getBorderWidth()
        Returns the pixel width of the outer chart border. The border is painted using vector graphic techniques to allow rounded corners.

        Default: 0.

        Specified by:
        getBorderWidth in interface ChartsApi
        See Also:
        Chart.getBorderWidth()

      • setWidth

        public void setWidth​(Number width)
        Sets an explicit width for the chart. By default the width is calculated from the offset width of the containing element.
        Specified by:
        setWidth in interface ChartsApi
        Parameters:
        width - an explicit width for the chart
        See Also:
        Chart.setWidth(Number)

      • getWidth

        public Number getWidth()
        Returns an explicit width for the chart. By default the width is calculated from the offset width of the containing element.

        Default: null.

        Specified by:
        getWidth in interface ChartsApi
        See Also:
        Chart.getWidth()

      • setHeight

        public void setHeight​(Number height)
        Sets an explicit height for the chart. By default the height is calculated from the offset height of the containing element, or 400 pixels if the containing element's height is 0.
        Specified by:
        setHeight in interface ChartsApi
        Parameters:
        height - an explicit height for the chart
        See Also:
        Chart.setHeight(Number)

      • setHeight

        public void setHeight​(String height)
        Description copied from interface: ChartsApi
        Sets an explicit height for the chart. If given a percentage string (for example '56%'), the height is given as the percentage of the actual chart width. This allows for preserving the aspect ratio across responsive sizes.
        Specified by:
        setHeight in interface ChartsApi

      • getHeight

        public Number getHeight()
        Returns an explicit height for the chart. By default the height is calculated from the offset height of the containing element, or 400 pixels if the containing element's height is 0.

        Default: null.

        Specified by:
        getHeight in interface ChartsApi
        See Also:
        Chart.getHeight()

      • setInverted

        public void setInverted​(boolean inverted)
        Sets whether to invert the axes so that the x axis is vertical and y axis is horizontal. When true, the x axis is reversed by default. If a bar series is present in the chart, it will be inverted automatically.
        Specified by:
        setInverted in interface ChartsApi
        See Also:
        Chart.setInverted(boolean)

      • isInverted

        public boolean isInverted()
        Returns whether to invert the axes so that the x axis is vertical and y axis is horizontal. When true, the x axis is reversed by default. If a bar series is present in the chart, it will be inverted automatically.

        Default: false.

        Specified by:
        isInverted in interface ChartsApi
        See Also:
        Chart.isInverted()

      • setMargin

        public void setMargin​(Number margin)
        Sets the margin between the outer edge of the chart and the plot area.
        Specified by:
        setMargin in interface ChartsApi

      • setMarginBottom

        public void setMarginBottom​(Number marginBottom)
        Sets the margin between the bottom outer edge of the chart and the plot area. Use this to set a fixed pixel value for the margin as opposed to the default dynamic margin. See also setSpacingBottom(Number).
        Specified by:
        setMarginBottom in interface ChartsApi
        Parameters:
        marginBottom - the margin between the bottom outer edge of the chart and the plot area
        See Also:
        Chart.setMarginBottom(Number)

      • setMarginLeft

        public void setMarginLeft​(Number marginLeft)
        Sets the margin between the left outer edge of the chart and the plot area. Use this to set a fixed pixel value for the margin as opposed to the default dynamic margin. See also setSpacingLeft(Number)
        Specified by:
        setMarginLeft in interface ChartsApi
        Parameters:
        marginLeft - the margin between the left outer edge of the chart and the plot area
        See Also:
        Chart.setMarginLeft(Number)

      • setMarginRight

        public void setMarginRight​(Number marginRight)
        Sets the margin between the right outer edge of the chart and the plot area. Use this to set a fixed pixel value for the margin as opposed to the default dynamic margin. See also setSpacingRight(Number).
        Specified by:
        setMarginRight in interface ChartsApi
        Parameters:
        marginRight - the margin between the right outer edge of the chart and the plot area
        See Also:
        Chart.setMarginRight(Number)

      • setMarginTop

        public void setMarginTop​(Number marginTop)
        Sets the margin between the top outer edge of the chart and the plot area. Use this to set a fixed pixel value for the margin as opposed to the default dynamic margin. See also setSpacingTop(Number).
        Specified by:
        setMarginTop in interface ChartsApi
        Parameters:
        marginTop - the margin between the top outer edge of the chart and the plot area
        See Also:
        Chart.setMarginTop(Number)

      • setPinchType

        public void setPinchType​(String pinchType)
        Sets equivalent to setZoomType(String), but for multitouch gestures only. By default, the pinchType is the same as the zoomType setting. However, pinching can be enabled separately in some cases, for example in stock charts where a mouse drag pans the chart, while pinching is enabled.

        Default: null.

        Specified by:
        setPinchType in interface ChartsApi
        See Also:
        setZoomType(String), Chart.setPinchType(String)

      • getPinchType

        public String getPinchType()
        Returns equivalent to getZoomType(), but for multitouch gestures only. By default, the pinchType is the same as the zoomType setting. However, pinching can be enabled separately in some cases, for example in stock charts where a mouse drag pans the chart, while pinching is enabled.

        Default: null.

        Specified by:
        getPinchType in interface ChartsApi
        See Also:
        Chart.getPinchType()

      • setPlotBackgroundColor

        public void setPlotBackgroundColor​(String plotBackgroundColor)
        Sets the background color for the plot area.
        Specified by:
        setPlotBackgroundColor in interface ChartsApi

      • setPlotBackgroundColor

        public void setPlotBackgroundColor​(Color plotBackgroundColor)
        Sets the background color for the plot area.
        Specified by:
        setPlotBackgroundColor in interface ChartsApi

      • setPlotBackgroundImage

        public void setPlotBackgroundImage​(String plotBackgroundImage)
        Sets the URL for an image to use as the plot background. To set an image as the background for the entire chart, set a CSS background image to the container element. Note that for the image to be applied to exported charts, its URL needs to be accessible by the export server.
        Specified by:
        setPlotBackgroundImage in interface ChartsApi
        Parameters:
        plotBackgroundImage - the URL for an image to use as the plot background
        See Also:
        Chart.setPlotBackgroundImage(String)

      • setPlotBorderColor

        public void setPlotBorderColor​(String plotBorderColor)
        Sets the color of the inner chart or plot area border.
        Specified by:
        setPlotBorderColor in interface ChartsApi

      • setPlotBorderColor

        public void setPlotBorderColor​(Color plotBorderColor)
        Sets the color of the inner chart or plot area border.
        Specified by:
        setPlotBorderColor in interface ChartsApi

      • setPolar

        public void setPolar​(boolean polar)
        Sets to true to enable the cartesian charts like line, spline, area and column are transformed into the polar coordinate system.
        Specified by:
        setPolar in interface ChartsApi
        Parameters:
        polar - when true, cartesian charts like line, spline, area and column are transformed into the polar coordinate system
        See Also:
        Chart.setPolar(boolean)

      • isPolar

        public boolean isPolar()
        Returns whether transforms into the polar coordinate system

        Default: false.

        Specified by:
        isPolar in interface ChartsApi
        See Also:
        Chart.isPolar()

      • setReflow

        public void setReflow​(boolean reflow)
        Sets whether to reflow the chart to fit the width of the container div on resizing the window.
        Specified by:
        setReflow in interface ChartsApi
        Parameters:
        reflow - whether to reflow the chart to fit the width of the container div on resizing the window
        See Also:
        Chart.setReflow(boolean)

      • isReflow

        public boolean isReflow()
        Returns whether to reflow the chart to fit the width of the container div on resizing the window.

        Default: true.

        Specified by:
        isReflow in interface ChartsApi
        See Also:
        Chart.isReflow()

      • getResetZoomButton

        public ResetZoomButton getResetZoomButton()
        Description copied from interface: ChartsApi
        Returns the button that appears after a selection zoom, allowing the user to reset zoom.

        Default: null.

        Specified by:
        getResetZoomButton in interface ChartsApi

      • setResetZoomButton

        public void setResetZoomButton​(ResetZoomButton resetZoomButton)
        Description copied from interface: ChartsApi
        Sets the button that appears after a selection zoom, allowing the user to reset zoom.
        Specified by:
        setResetZoomButton in interface ChartsApi
        Parameters:
        resetZoomButton - the button that appears after a selection zoom, allowing the user to reset zoom

      • setSelectionMarkerFill

        public void setSelectionMarkerFill​(String selectionMarkerFill)
        Sets the background color of the marker square when selecting (zooming in on) an area of the chart.
        Specified by:
        setSelectionMarkerFill in interface ChartsApi

      • setSelectionMarkerFill

        public void setSelectionMarkerFill​(LinearGradient selectionMarkerFill)
        Sets the background color of the marker square when selecting (zooming in on) an area of the chart.
        Specified by:
        setSelectionMarkerFill in interface ChartsApi

      • setSelectionMarkerFill

        public void setSelectionMarkerFill​(RadialGradient selectionMarkerFill)
        Sets the background color of the marker square when selecting (zooming in on) an area of the chart.
        Specified by:
        setSelectionMarkerFill in interface ChartsApi

      • setSelectionMarkerFill

        public void setSelectionMarkerFill​(Color selectionMarkerFill)
        Sets the background color of the marker square when selecting (zooming in on) an area of the chart.
        Specified by:
        setSelectionMarkerFill in interface ChartsApi

      • setShadow

        public void setShadow​(boolean shadow)
        Sets whether to apply a drop shadow to the outer chart area. Requires that backgroundColor be set.
        Specified by:
        setShadow in interface ChartsApi
        Parameters:
        shadow - whether to apply a drop shadow to the outer chart area
        See Also:
        Chart.setShadow(boolean)

      • isShadow

        public boolean isShadow()
        Returns whether to apply a drop shadow to the outer chart area. Requires that backgroundColor be set.

        Default: false.

        Specified by:
        isShadow in interface ChartsApi
        See Also:
        Chart.isShadow()

      • setShowAxes

        public void setShowAxes​(boolean showAxes)
        Sets whether to show the axes initially. This only applies to empty charts where series are added dynamically, as axes are automatically added to cartesian series.
        Specified by:
        setShowAxes in interface ChartsApi
        Parameters:
        showAxes - whether to show the axes initially
        See Also:
        Chart.setShowAxes(boolean)

      • isShowAxes

        public boolean isShowAxes()
        Returns whether to show the axes initially. This only applies to empty charts where series are added dynamically, as axes are automatically added to cartesian series.

        Default: false.

        Specified by:
        isShowAxes in interface ChartsApi
        See Also:
        Chart.isShowAxes()

      • getSonification

        public Sonification getSonification()
        Returns the sonification options, if any. Otherwise, create a new one.
        Specified by:
        getSonification in interface ChartsApi
        Since:
        11.2.0.0

      • getSpacing

        public Number[] getSpacing()
        Returns the distance between the outer edge of the chart and the content, like title, legend, axis title or labels. The numbers in the array designate top, right, bottom and left respectively.

        Default: [10, 10, 15, 10].

        Specified by:
        getSpacing in interface ChartsApi

      • setSpacingBottom

        public void setSpacingBottom​(Number spacingBottom)
        Sets the space between the bottom edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).

        Specified by:
        setSpacingBottom in interface ChartsApi
        Parameters:
        spacingBottom - The space between the bottom edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position)
        See Also:
        Chart.setSpacingBottom(Number)

      • getSpacingBottom

        public Number getSpacingBottom()
        Returns the space between the bottom edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).

        Default: 15.

        Specified by:
        getSpacingBottom in interface ChartsApi
        See Also:
        Chart.getSpacingBottom()

      • setSpacingLeft

        public void setSpacingLeft​(Number spacingLeft)
        Sets the space between the left edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).

        Specified by:
        setSpacingLeft in interface ChartsApi
        Parameters:
        spacingLeft - The space between the left edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position)
        See Also:
        Chart.setSpacingLeft(Number)

      • getSpacingLeft

        public Number getSpacingLeft()
        Returns the space between the left edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).

        Default: 10.

        Specified by:
        getSpacingLeft in interface ChartsApi
        See Also:
        Chart.getSpacingLeft()

      • setSpacingRight

        public void setSpacingRight​(Number spacingRight)
        Sets the space between the right edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
        Specified by:
        setSpacingRight in interface ChartsApi
        Parameters:
        spacingRight - The space between the right edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position)
        See Also:
        Chart.setSpacingRight(Number)

      • getSpacingRight

        public Number getSpacingRight()
        Returns the space between the right edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).

        Default: 10.

        Specified by:
        getSpacingRight in interface ChartsApi
        See Also:
        Chart.getSpacingRight()

      • setSpacingTop

        public void setSpacingTop​(Number spacingTop)
        Sets the space between the top edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).
        Specified by:
        setSpacingTop in interface ChartsApi
        Parameters:
        spacingTop - The space between the top edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position)
        See Also:
        Chart.setSpacingTop(Number)

      • getSpacingTop

        public Number getSpacingTop()
        Returns the space between the top edge of the chart and the content (plot area, axis title and labels, title, subtitle or legend in top position).

        Default: 10.

        Specified by:
        getSpacingTop in interface ChartsApi
        See Also:
        Chart.getSpacingTop()

      • setStyle

        public void setStyle​(String style)
        Sets additional CSS styles to apply inline to the container div. Note that since the default font styles are applied in the renderer, it is ignorant of the individual chart options and must be set globally.

        This method allows simple settings like 

        
 label.setStyle("fontWeight: 'bold'; color: 'white'; textShadow: '0px 1px 2px black'");

        In the format of CSS key:value, and ";" separating multiple key:value pairs, if you have more a complex CSS styling, we recommend using setStyle(Map)

        Specified by:
        setStyle in interface ChartsApi
        Parameters:
        style - one or many CSS key:value pairs in a single line string format

      • setStyle

        public <K,​V> void setStyle​(Map<K,​V> style)
        Sets additional CSS styles to apply inline to the container div. Note that since the default font styles are applied in the renderer, it is ignorant of the individual chart options and must be set globally.

        This method allows complex styling like: 

         
 Map<String, Object> styles = new HashMap<String, Object>();
 styles.put("fill", "#E8E8EA");
 styles.put("stroke", "#6E6E78");
 styles.put("stroke-width", "1");
 styles.put("r", "0");
 Map<String, Object> states = new HashMap<String, Object>();
 Map<String, String> hover = new HashMap<String, String>();
 hover.put("fill", "#F4F4F6");
 hover.put("stroke", "#6E6E78");
 hover.put("stroke-width", "1");
 hover.put("r", "0");
 states.put("hover", hover);
 styles.put("states", states);
 Map<String, String> style = new HashMap<String, String>();
 style.put("color", "#4D5663");
 style.put("fontSize", "12px");
 style.put("fontFamily", "'Arial'");
 style.put("fontWeight", "normal");
 style.put("padding", "10px");
 styles.put("style", style);
        which will generate the final results like: 
        
 {
     "fill": "#E8E8EA",
     "stroke": "#6E6E78",
     "stroke-width": "1",
     "r": "0",
     "states":
     {
         "hover":
         {
             "fill": "#F4F4F6",
             "stroke": "#6E6E78",
             "stroke-width": "1",
             "r": "0"
         }
     },
     "style":
     {
         "color": "#4D5663",
         "fontSize": "12px",
         "fontFamily": "'Arial'",
         "fontWeight": "normal",
         "padding": "10px"
     }
 }
        Specified by:
        setStyle in interface ChartsApi
        Type Parameters:
        K - Type for the key, usually String
        V - Type for the value, usually String. For nested maps, use Object or any other type.
        Parameters:
        style - the style object

      • isStyledMode

        public boolean isStyledMode()
        Returns whether to apply styled mode. When in styled mode, no presentational attributes or CSS are applied to the chart SVG. Instead, CSS rules are required to style the chart. The default style sheet is available from highcharts.css.

        Default: false

        Specified by:
        isStyledMode in interface ChartsApi
        Since:
        10.2.1.0

      • setStyledMode

        public void setStyledMode​(boolean styledMode)
        Sets whether to apply styled mode. When in styled mode, no presentational attributes or CSS are applied to the chart SVG. Instead, CSS rules are required to style the chart. The default style sheet is available from highcharts.css.

        Default: false

        Specified by:
        setStyledMode in interface ChartsApi
        Since:
        10.2.1.0

      • getStyle

        public <K,​V> Map<K,​V> getStyle()
        Returns additional CSS styles to apply inline to the container div. Note that since the default font styles are applied in the renderer, it is ignorant of the individual chart options and must be set globally. Defaults to: 
         fontFamily: "Lucida Grande", "Lucida Sans Unicode", Verdana, Arial, Helvetica, sans-serif; fontSize: 12px

        Specified by:
        getStyle in interface ChartsApi
        Type Parameters:
        K - type for the key

        if style was set using setStyle(String), type will be String

        if style was set using setStyle(Map), type will be the same as the type from the key of the map

        if style was not set, default style will be applied, and type will be String

        V - type for the value

        if style was set using setStyle(String), type will be String

        if style was set using setStyle(Map), type will be the same as the type from the key of the map

        if style was not set, default style will be applied, and type will be String

      • setZoomType

        public void setZoomType​(String zoomType)
        Sets decides in what dimentions the user can zoom by dragging the mouse. Can be one of x, y or xy.
        Specified by:
        setZoomType in interface ChartsApi
        Parameters:
        zoomType - decides in what dimentions the user can zoom by dragging the mouse
        See Also:
        Chart.setZoomType(String)

      • getZoomType

        public String getZoomType()
        Returns decides in what dimentions the user can zoom by dragging the mouse. Can be one of x, y or xy.

        Default: null.

        Specified by:
        getZoomType in interface ChartsApi
        See Also:
        Chart.getZoomType()

      • smartDrawChart

        protected void smartDrawChart()
        mark a draw flag to inform that this Chart needs update.

      • getTooltip

        public Tooltip getTooltip()
        Returns the Tooltip options, if any. Otherwise, create a new one.
        Specified by:
        getTooltip in interface ChartsApi
        See Also:
        Tooltip

      • setTooltip

        public void setTooltip​(Tooltip tooltip)
        Sets the Tooltip options
        Specified by:
        setTooltip in interface ChartsApi
        Parameters:
        tooltip -

      • getChart

        public Chart getChart()
        Returns the Chart options, if any. Otherwise, create a new one.
        Specified by:
        getChart in interface ChartsApi
        See Also:
        Chart

      • setNoData

        public void setNoData​(NoData noData)
        Sets the no-data options
        Specified by:
        setNoData in interface ChartsApi
        Since:
        1.1.0

      • getNoData

        public NoData getNoData()
        Returns the no-data options
        Specified by:
        getNoData in interface ChartsApi
        Since:
        1.1.0

      • setCredits

        public void setCredits​(Credits credits)
        Sets the Credits options
        Specified by:
        setCredits in interface ChartsApi
        Parameters:
        credits -

      • getCredits

        public Credits getCredits()
        Returns the Credits options, if any. Otherwise, create a new one.
        Specified by:
        getCredits in interface ChartsApi
        See Also:
        Credits

      • setChart

        public void setChart​(Chart chart)
        Sets the Chart options
        Specified by:
        setChart in interface ChartsApi
        Parameters:
        chart -

      • getPane

        public Pane getPane()
        Returns the pane at the index 0
        Specified by:
        getPane in interface ChartsApi

      • getPane

        public Pane getPane​(int index)
        Returns the pane from the given index
        Specified by:
        getPane in interface ChartsApi

      • getPaneSize

        public int getPaneSize()
        Returns the size of the pane list
        Specified by:
        getPaneSize in interface ChartsApi

      • getLegend

        public Legend getLegend()
        Returns the Legend options, if any. Otherwise, create a new one.
        Specified by:
        getLegend in interface ChartsApi
        See Also:
        Legend

      • getLoading

        public Loading getLoading()
        Returns the Loading options, if any. Otherwise, create a new one.
        Specified by:
        getLoading in interface ChartsApi
        See Also:
        Loading

      • setLegend

        public void setLegend​(Legend legend)
        Sets the Legend options
        Specified by:
        setLegend in interface ChartsApi
        Parameters:
        legend -

      • setLabels

        public void setLabels​(Labels labels)
        Sets the labels options
        Specified by:
        setLabels in interface ChartsApi

      • getLang

        public Lang getLang()
        Returns the labels options
        Specified by:
        getLang in interface ChartsApi
        Since:
        11.2.0.0

      • setLang

        public void setLang​(Lang lang)
        Sets the labels options
        Specified by:
        setLang in interface ChartsApi
        Since:
        11.2.0.0

      • setPlotOptions

        public void setPlotOptions​(PlotOptions plotOptions)
        Sets the plotOptions options
        Specified by:
        setPlotOptions in interface ChartsApi
        Parameters:
        plotOptions -

      • getSeries

        public Series getSeries()
        Returns the Series options, if any. Otherwise, create a new one.

        Returns the first series (index 0) by default.

        Specified by:
        getSeries in interface ChartsApi
        See Also:
        Series, getSeries(int)

      • addSeries

        public void addSeries​(Series series)
        Add a series to the chart after render time. Note that this method should never be used when adding data synchronously at chart render time, as it adds expense to the calculations and rendering. When adding data at the same time as the chart is initiated, add the series as a configuration option instead.
        Specified by:
        addSeries in interface ChartsApi
        Parameters:
        series -

      • addAxis

        public void addAxis​(Axis axis)
        Add an axis to the chart after render time. Note that this method should never be used when adding data synchronously at chart render time, as it adds expense to the calculations and rendering. When adding data at the same time as the chart is initiated, add the axis as a configuration option instead.
        Specified by:
        addAxis in interface ChartsApi
        Parameters:
        axis -

      • getSeriesSize

        public int getSeriesSize()
        Returns the size of series
        Specified by:
        getSeriesSize in interface ChartsApi

      • getSeries

        public Series getSeries​(int index)
        Returns the Series options from the given index, if any. Otherwise, create a new one.
        Specified by:
        getSeries in interface ChartsApi
        See Also:
        Series

      • getXAxis

        public XAxis getXAxis()
        Returns the XAxis options, if any. Otherwise, create a new one.

        Returns the first xAxis (index 0) by default.

        Specified by:
        getXAxis in interface ChartsApi
        See Also:
        XAxis, getXAxis(int)

      • getXAxis

        public XAxis getXAxis​(int index)
        Returns the XAxis options from the given index, if any. Otherwise, create a new one.
        Specified by:
        getXAxis in interface ChartsApi
        See Also:
        XAxis

      • getXAxisSize

        public int getXAxisSize()
        Returns the size of xAxis
        Specified by:
        getXAxisSize in interface ChartsApi

      • setXAxis

        public void setXAxis​(XAxis xaxis)
        Sets the xAxis with out putting it in an Array
        Specified by:
        setXAxis in interface ChartsApi

      • getYAxis

        public YAxis getYAxis()
        Returns the YAxis options, if any. Otherwise, create a new one.

        Returns the first yAxis (index 0) by default.

        Specified by:
        getYAxis in interface ChartsApi
        See Also:
        YAxis, getYAxis(int)

      • getYAxis

        public YAxis getYAxis​(int index)
        Returns the YAxis options from the given index, if any. Otherwise, create a new one.
        Specified by:
        getYAxis in interface ChartsApi
        See Also:
        YAxis

      • getyAxisSize

        public int getyAxisSize()
        Deprecated.
        As of release 10.2.1.0, using getYAxisSize() instead.
        Returns the size of yAxis
        Specified by:
        getyAxisSize in interface ChartsApi

      • getYAxisSize

        public int getYAxisSize()
        Returns the size of yAxis
        Specified by:
        getYAxisSize in interface ChartsApi
        Since:
        10.2.1.0

      • setYAxis

        public void setYAxis​(YAxis yaxis)
        Sets the yAxis with out putting it in an Array
        Specified by:
        setYAxis in interface ChartsApi

      • getZAxis

        public ZAxis getZAxis()
        Returns the ZAxis options, if any. Otherwise, create a new one.

        Returns the first zAxis (index 0) by default.

        Specified by:
        getZAxis in interface ChartsApi
        See Also:
        ZAxis, getZAxis(int)

      • getZAxis

        public ZAxis getZAxis​(int index)
        Returns the ZAxis options from the given index, if any. Otherwise, create a new one.
        Specified by:
        getZAxis in interface ChartsApi
        See Also:
        ZAxis

      • getzAxisSize

        public int getzAxisSize()
        Returns the size of zAxis
        Specified by:
        getzAxisSize in interface ChartsApi

      • setZAxis

        public void setZAxis​(ZAxis zaxis)
        Sets the zAxis with out putting it in an Array
        Specified by:
        setZAxis in interface ChartsApi

      • getOptions3D

        public Options3D getOptions3D()
        Returns the options to render charts in 3 dimensions.

        Default: null.

        Specified by:
        getOptions3D in interface ChartsApi

      • setOptions3D

        public void setOptions3D​(Options3D options3D)
        Sets the options to render charts in 3 dimensions.
        Specified by:
        setOptions3D in interface ChartsApi
        Parameters:
        options3D - the options to render charts in 3 dimensions.

      • getClassName

        public String getClassName()
        Returns a CSS class name to apply to the charts container div, allowing unique CSS styling for each chart.
        Specified by:
        getClassName in interface ChartsApi
        Since:
        10.2.1.0
        See Also:
        Chart.getClassName()

      • setClassName

        public void setClassName​(String className)
        Sets a CSS class name to apply to the charts container div, allowing unique CSS styling for each chart.
        Specified by:
        setClassName in interface ChartsApi
        Since:
        10.2.1.0
        See Also:
        Chart.setClassName(String)

      • setTitle

        public void setTitle​(String title)
        Sets the chart title.
        Specified by:
        setTitle in interface ChartsApi

      • setTitle

        public void setTitle​(Title title)
        Sets the Title options
        Specified by:
        setTitle in interface ChartsApi
        Parameters:
        title -

      • getTitle

        public Title getTitle()
        Returns the Title options, if any. Otherwise, create a new one.
        Specified by:
        getTitle in interface ChartsApi
        See Also:
        Title

      • getSubtitle

        public Subtitle getSubtitle()
        Returns the Subtitle options, if any. Otherwise, create a new one.
        Specified by:
        getSubtitle in interface ChartsApi
        See Also:
        Subtitle

      • setSubtitle

        public void setSubtitle​(String subtitle)
        Sets the chart subtitle
        Specified by:
        setSubtitle in interface ChartsApi
        Parameters:
        subtitle -

      • setSubtitle

        public void setSubtitle​(Subtitle subtitle)
        Sets the Subtitle options
        Specified by:
        setSubtitle in interface ChartsApi
        Parameters:
        subtitle -

      • getPanKey

        public String getPanKey()
        Returns setting a key to switch between zooming and panning. Can be one of alt, ctrl, meta (the command key on Mac and Windows key on Windows) or shift. The keys are mapped directly to the key properties of the click event argument (event.altKey, event.ctrlKey, event.metaKey and event.shiftKey).

        Default: null

        Specified by:
        getPanKey in interface ChartsApi
        Since:
        10.2.1.0
        See Also:
        Chart.getPanKey()

      • setPanKey

        public void setPanKey​(String panKey)
        Sets setting a key to switch between zooming and panning. Can be one of alt, ctrl, meta (the command key on Mac and Windows key on Windows) or shift. The keys are mapped directly to the key properties of the click event argument (event.altKey, event.ctrlKey, event.metaKey and event.shiftKey).
        Specified by:
        setPanKey in interface ChartsApi
        Since:
        10.2.1.0
        See Also:
        Chart.setPanKey(String)

      • isPanning

        public boolean isPanning()
        Returns if allow panning in a chart. Best used with panKey to combine zooming and panning. On touch devices, when the tooltip.followTouchMove option is true (default), panning requires two fingers. To allow panning with one finger, set followTouchMove to false.

        Default: false

        Specified by:
        isPanning in interface ChartsApi
        Since:
        10.2.1.0
        See Also:
        Chart.isPanning()

      • setPanning

        public void setPanning​(boolean panning)
        Sets if allow panning in a chart. Best used with panKey to combine zooming and panning. On touch devices, when the tooltip.followTouchMove option is true (default), panning requires two fingers. To allow panning with one finger, set followTouchMove to false.
        Specified by:
        setPanning in interface ChartsApi
        Since:
        10.2.1.0
        See Also:
        Chart.setPanning(boolean)

      • isParallelCoordinates

        public boolean isParallelCoordinates()
        Returns a flag to render charts as a parallel coordinates plot. In a parallel coordinates plot (||-coords) by default all required yAxes are generated and the legend is disabled.

        Default: false.

        Specified by:
        isParallelCoordinates in interface ChartsApi
        Since:
        10.2.1.0
        See Also:
        Chart.isParallelCoordinates()

      • setParallelCoordinates

        public void setParallelCoordinates​(boolean parallelCoordinates)
        Sets a flag to render charts as a parallel coordinates plot. In a parallel coordinates plot (||-coords) by default all required yAxes are generated and the legend is disabled.

        Default: false.

        Specified by:
        setParallelCoordinates in interface ChartsApi
        Since:
        10.2.1.0
        See Also:
        Chart.setParallelCoordinates(boolean)

      • getCtrlKeys

        public String getCtrlKeys()
        Returns what keystrokes to intercept.

        Default: null.

        Since:
        7.2.1.2

      • setCtrlKeys

        public void setCtrlKeys​(String ctrlKeys)
        Sets what keystrokes to intercept.

        The string could be a combination of the following:

        ^k
        A control key, i.e., Ctrl+k, where k could be a~z, 0~9, #n
        @k
        A alt key, i.e., Alt+k, where k could be a~z, 0~9, #n
        $n
        A shift key, i.e., Shift+n, where n could be #n. Note: $a ~ $z are not supported.
        #home
        Home
        #end
        End
        #ins
        Insert
        #del
        Delete
        #bak
        Backspace
        #left
        Left arrow
        #right
        Right arrow
        #up
        Up arrow
        #down
        Down arrow
        #pgup
        PageUp
        #pgdn
        PageDn
        #f1 #f2 ... #f12
        Function keys representing F1, F2, ... F12

        For example,

        ^a^d@c#f10#left#right
        It means you want to intercept Ctrl+A, Ctrl+D, Alt+C, F10, Left and Right.
        ^#left
        It means Ctrl+Left.
        ^#f1
        It means Ctrl+F1.
        @#f3
        It means Alt+F3.

        Note: it doesn't support Ctrl+Alt, Shift+Ctrl, Shift+Alt or Shift+Ctrl+Alt.

        Since:
        7.2.1.2

      • addSeriesAsDrilldown

        public void addSeriesAsDrilldown​(Point point,
                                 Series series)
        Add a series to the chart as drilldown from a specific point in the parent series. This method is used for async drilldown, when clicking a point in a series should result in loading and displaying a more high-resolution series. When not async, the setup is simpler using the drilldown.series options structure.
        Parameters:
        point - The existing Point object from which the drilldown will start.
        series - The series options, as documented under plotOptions.series and under the plotOptions for each series type

      • isRendered

        public boolean isRendered()
        Returns whether the component has been rendered to client side. Most of the time this method is used for component developer only.

      • invalidate

        public void invalidate()
        Specified by:
        invalidate in interface org.zkoss.zk.ui.Component
        Overrides:
        invalidate in class org.zkoss.zk.ui.AbstractComponent

      • renderProperties

        protected void renderProperties​(org.zkoss.zk.ui.sys.ContentRenderer renderer)
                         throws IOException
        Overrides:
        renderProperties in class org.zkoss.zk.ui.AbstractComponent
        Throws:
        IOException

      • smartUpdate

        protected void smartUpdate​(String attr,
                           Object value,
                           boolean append)
        Overrides:
        smartUpdate in class org.zkoss.zk.ui.AbstractComponent

      • 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.AbstractComponent

      • selectPoint

        public void selectPoint​(Point selPoint,
                        boolean accumulate)

      • clearPointSelection

        public void clearPointSelection()
        Clears the selected points in the chart.

      • setZclass

        public void setZclass​(String zclass)
        Sets the zclass for this component
        Parameters:
        zclass -

      • getZclass

        public String getZclass()
        The default zclass is "z-charts"

      • getHflex

        public String getHflex()
        Returns horizontal flex hint of this chart.

        Default: null

        Returns:
        horizontal flex hint of this chart.
        See Also:
        setHflex(java.lang.String)

      • setHflex

        public void setHflex​(String flex)
        Sets horizontal flex hint of this chart.

        Default: null

        See Also:
        getHflex()

      • getVflex

        public String getVflex()
        Returns vertical flex hint of this chart.

        Default: null

        Returns:
        vertical flex hint of this chart.
        See Also:
        setVflex(java.lang.String)

      • setVflex

        public void setVflex​(String flex)
        Sets vertical flex hint of this chart.

        Default: null

        See Also:
        getVflex()

      • getAnnotation

        public Annotation getAnnotation​(int index)
        Description copied from interface: ChartsApi
        Returns the Annotation options from the given index, if any. Otherwise, create a new one.

        Specified by:
        getAnnotation in interface ChartsApi
        See Also:
        Annotation

      • getAnnotationSize

        public int getAnnotationSize()
        Description copied from interface: ChartsApi
        Returns the size of annotations
        Specified by:
        getAnnotationSize in interface ChartsApi

      • addAnnotation

        public void addAnnotation​(Annotation annotation)
        Description copied from interface: ChartsApi
        Add an annotation to the chart after render time. Note that this method should never be used when adding data synchronously at chart render time, as it adds expense to the calculations and rendering. When adding data at the same time as the chart is initiated, add the annotation as a configuration option instead.
        Specified by:
        addAnnotation in interface ChartsApi

      • setCaption

        public void setCaption​(String caption)
        Description copied from interface: ChartsApi
        Sets the chart caption.
        Specified by:
        setCaption in interface ChartsApi

      • setCaption

        public void setCaption​(Caption caption)
        Description copied from interface: ChartsApi
        Sets the Caption option.
        Specified by:
        setCaption in interface ChartsApi

      • getCaption

        public Caption getCaption()
        Description copied from interface: ChartsApi
        Returns the Caption options, if any. Otherwise, create a new one.
        Specified by:
        getCaption in interface ChartsApi
        See Also:
        Caption

      • getResponsive

        public Responsive getResponsive()
        Description copied from interface: ChartsApi
        Returns a set of rules to apply for different screen or chart sizes. Each rule specifies additional chart options.
        Specified by:
        getResponsive in interface ChartsApi

      • setResponsive

        public void setResponsive​(Responsive responsive)
        Description copied from interface: ChartsApi
        Sets a set of rules to apply for different screen or chart sizes. Each rule specifies additional chart options.
        Specified by:
        setResponsive in interface ChartsApi

      • getEventsMap

        public Map<String,​org.zkoss.json.JavaScriptValue> getEventsMap()
        Description copied from interface: ChartsApi
        Returns a map of client side event listeners for the chart.
        Specified by:
        getEventsMap in interface ChartsApi

      • setEvents

        public void setEvents​(Map<String,​org.zkoss.json.JavaScriptValue> events)
        Description copied from interface: ChartsApi
        Sets a map of client side event listeners for the chart.
        Specified by:
        setEvents in interface ChartsApi

      • addEvent

        public void addEvent​(String name,
                     org.zkoss.json.JavaScriptValue event)
        Description copied from interface: ChartsApi
        Sets a client side event for the chart.
        Specified by:
        addEvent in interface ChartsApi

      • toggleSonify

        public void toggleSonify()
        Play/pause sonification of a chart.
        Since:
        11.2.0.0