Class Series
- java.lang.Object
-
- org.zkoss.chart.Optionable
-
- org.zkoss.chart.Series
-
- All Implemented Interfaces:
Serializable,OptionDataListener,org.zkoss.json.JSONAware
public class Series extends Optionable implements OptionDataListener
The Series object is the JavaScript representation of each line, area series, pie etc. The object can be accessed in a number of ways. All series and point event handlers give a reference to the series object. The chart object has a series property that is a collection of all the chart's series. The point objects also have the same reference. Another way to reference the series programmatically is by id.All the options in this class support
DynamicalAttribute.- Author:
- jumperchen
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class org.zkoss.chart.Optionable
NOT_NULL_VALUE, options
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddDataLabels(DataLabels dataLabels)Add an option of data labels to the list.voidaddEvent(String name, org.zkoss.json.JavaScriptValue event)Sets general event handlers for the series items.voidaddPoint(double y)Add a number point to the end of the current points list.voidaddPoint(double x, double y)Add a point with x and y numbers to the end of the current points list.voidaddPoint(double x, double low, double high)Add a point with x, low, and high numbers to the end of the current points list.voidaddPoint(Number y)Add a number point to the end of the current points list.voidaddPoint(Number x, Number y)Add a point with x and y numbers to the end of the current points list.voidaddPoint(Number x, Number low, Number high)Add a point with x, low, and high numbers to the end of the current points list.voidaddPoint(String name, double y)Add a point with name and number to the end of the current points list.voidaddPoint(String name, Number y)Add a point with name and number to the end of the current points list.voidaddPoint(String name, Number y, Number x)Add a point with name, Y number, and X index to the end of the current points list.voidaddPoint(String from, String to)Add a point with from and to to the end of the current points list.voidaddPoint(String from, String to, Number weight)Add a point with from, to and weight to the end of the current points list.voidaddPoint(String id, String parent, String name)Add a point with id, parent and name to the end of the current points list.voidaddPoint(Point point)Add a point at the end of the current points list.voidaddPoint(Point point, boolean redraw, boolean shift, boolean animation)Add a point to the end of the current points list.voidaddPoint(Point point, boolean redraw, boolean shift, Animation animation)Add a point at the end of the current points list.SeriesAccessibilitygetAccessibility()Returns accessibility options for a series.booleangetAlternateStartingDirection()Enabling this option will make the treemap alternate the drawing direction between vertical and horizontal.AnimationgetAnimation()Returns whether to enable or disable the initial animation when a series is displayed.NumbergetAnimationLimit()For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high.ObjectgetBaseSeries()Returns an integer identifying the index to use for the base series, or a string representing the id of the series.ObjectgetBinsNumber()Returns a preferable number of bins.NumbergetBinWidth()Returns the width of each bin.StringgetBoostBlending()Returns the color blending in the boost module.NumbergetBoostThreshold()Returns the point threshold for when a series should enter boost mode.ColorgetBorderColor()Returns the color of the border surrounding each slice.StringgetBorderDashStyle()Returns the border dash style.ObjectgetBorderRadius()Returns the border radius of the series.NumbergetBorderWidth()Returns the border width of the series.StringgetBoxDashStyle()Returns the dash style of the box.BreadcrumbsgetBreadcrumbs()Returns the options for the breadcrumbs, the navigation at the top leading the way up through the traversed levels.NumbergetBrighten()Returns the brighten.List<String>getCenter()Returns the center of the pie chart relative to the plot area.StringgetCenterPos()Returns the center position for arc diagram.StringgetClassName()Returns an additional class name to apply to the series' graphical elements.ClustergetCluster()Returns the options for marker clusters, the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts.CollapseButtongetCollapseButton()Returns the options applied to collapse Button for treegraph type.ColorgetColor()Returns individual color for the series.ObjectgetColorAxis()When using dual or multiple color axes, this defines which colorAxis the particular series is connected to.NumbergetColorIndex()Returns a specific color index to use for the series, so its graphic representations are given the class name"highcharts-color-{n}".StringgetColorKey()Returns what data value should be used to calculate point color if colorAxis is used.List<Color>getColors()Returns a series specific or series type specific color set to apply instead of the globalCharts.getColors()whensetColorByPoint(boolean)is true.NumbergetColsize()Returns the column size - how many X axis units each column in the heatmap should span.StringgetConnectorColor()Returns the color of the line that connects the dumbbell point's values.NumbergetConnectorWidth()Returns the pixel width of the line that connects the dumbbell point's values.NumbergetCropThreshold()When the series contains less points than the crop threshold, all points are drawn, even if the points fall outside the visible plot area at the current zoom.StringgetCursor()Returns you can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.NumbergetCurveFactor()Higher numbers makes the links in a sankey diagram or dependency wheelrender more curved.<K,V>
Map<K,V>getCustom()Returns a reserved subspace to store options and values for customized functionality.StringgetDashStyle()Returns a name for the dash style to use for the graph.List<Point>getData()Returns the list of point dataWindBarbDataGroupinggetDataGrouping()Returns the data grouping options for the wind barbs, if any.DataLabelsgetDataLabels()Returns the first or single option of data labels.List<DataLabels>getDataLabelsList()Returns the list of options of data labels.DataSortinggetDataSorting()Returns the series data sorting.NumbergetDepth()Returns the depth of the 3D chart.StringgetDescription()A description of the series to add to the screen reader information about the series.GaugeDialPlotOptionsgetDial()Returns options for the dial or arrow pointer of the gauge.DragDropgetDragDrop()Returns the options of the draggable-points module allows points to be moved around or modified in the chart, if any.ColorgetEdgeColor()3D columns only.NumbergetEdgeWidth()3D columns only.NumbergetEndAngle()In circular view, returns the end angle of the item layout, in degrees where 0 is up.Map<String,org.zkoss.json.JavaScriptValue>getEventsMap()Returns general event handlers for the series items.ColorgetFillColor()Returns fill color or gradient for the area.NumbergetFillOpacity()Returns fill opacity for the area, arearange, areaspline, areasplinerange, bellcurve, and streamgraph.StringgetFindNearestPointBy()Returns whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series.intgetGapSize()NumbergetGroupPadding()Returns padding between each value groups, in x axis units.NumbergetGroupZPadding()Returns the spacing between columns on the Z Axis in a 3D chart.NumbergetHangingIndent()Returns the indentation in pixels of hanging nodes, nodes which parent has layout set to hanging.StringgetHangingIndentTranslation()Defines the indentation of a hanging layout parent's children.StringgetHeight()Returns the height of the neck, the lower part of a funnel.StringgetId()Returns an id for the series.intgetIndex()Returns the index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.ObjectgetInnerRadius()Returns the inner radius for points in a solid gauge.ObjectgetInnerSize()In circular view, returns the size of the inner diameter of the circle.booleangetInteractByLeaf()This option decides if the user can interact with the parent nodes or just the leaf nodes.NumbergetIntervals()Returns the length of the bell curve.NumbergetItemPadding()Returns the padding between the items, given in relative size where the size of the item is 1.JittergetJitter()Apply a jitter effect for the rendered markers.List<String>getKeys()Returns an array specifying which option maps to which key in the data point array.SeriesLabelgetLabel()Returns series label options, if any.StringgetLayout()Returns the layout of the items in rectangular view.StringgetLayoutAlgorithm()Get the option that decides which algorithm is used for setting position and dimensions of the points.StringgetLayoutStartingDirection()Defines which direction the layout algorithm will start drawing.intgetLegendIndex()Returns the sequential index of the series in the legend.List<Level>getLevels()Returns options on specific levels.LevelSizegetLevelSize()Returns options of determining the width of the ring per level, if any.StringgetLinecap()Returns the line cap used for line ends and line joins on the graph.ColorgetLineColor()Returns a separate color for the graph line.NumbergetLineWidth()Returns the width of the point marker's outline.NetworkGraphLinkgetLink()Returns the link style options, if any.ColorgetLinkColor()Returns the color of the links between nodes.(Requires organization)StringgetLinkedTo()Returns the id of another series to link to.NumbergetLinkLineWidth()Returns the line width of the links connecting nodes, in pixels.(Requires organization)NumbergetLinkOpacity()Returns linkOpacity on all points which lay on the same level.NumbergetLinkRadius()Returns radius for the rounded corners of the links between nodes.NumbergetLinkWeight()The global link weight.ColorgetLowColor()Returns color of the start markers in a dumbbell graph.LowMarkergetLowMarker()Returns options for the lower markers of the dumbbell-like series.MarkergetMarker()Returns the marker for this series.NumbergetMaxFontSize()Returns the word with the largest weight will have a font size equal to this value.ObjectgetMaxPointSize()Returns the maximum size of the points' radius related to chart's plotArea.NumbergetMaxPointWidth()Returns the maximum allowed pixel width for a column, translated to the height of a bar in a bar chart.ObjectgetMaxSize()Returns maximum bubble size.StringgetMedianColor()Returns the color of the median line.StringgetMedianDashStyle()Returns a name for the dash style of the median.NumbergetMedianWidth()Returns the pixel width of the median line.NumbergetMinFontSize()Returns a threshold determining the minimum font size that can be applied to a word.NumbergetMinLinkWidth()Returns the minimal width for a line of a sankey.NumbergetMinNodeLength()In a horizontal chart, the minimum width of the hanging nodes only, in pixels.NumbergetMinPointLength()Returns the minimal height for a column or width for a bar.ObjectgetMinPointSize()Returns the minimum size of the points' radius related to chart's plotArea.ObjectgetMinSize()Returns the minimum size.StringgetName()Returns the name of the series as shown in the legend, tooltip etc.StringgetNeckHeight()Returns the height of the neck, the lower part of the funnel.StringgetNeckWidth()Returns the width of the neck, the lower part of the funnel.ColorgetNegativeColor()Returns the color for the parts of the graph or points that are below thesetThreshold(Number).ColorgetNegativeFillColor()Returns a separate color for the negative part of the area.NetworkGraphLayoutAlgorithmgetNetworkGraphLayoutAlgorithm()Return options for layout algorithm for networkgraph type, if any.NumbergetNodePadding()Returns the padding between nodes in a sankey diagram or dependency wheel, in pixels.NodegetNodes()Returns the Node options, if any.NodegetNodes(int index)Returns the Node options from the given index, if any.intgetNodesSize()Returns the size of nodes.NumbergetNodeWidth()Returns the pixel width of each node in a sankey diagram or dependency wheel, or the height in case the chart is inverted.ColorgetNullColor()Returns the color applied to null points.StringgetOffset()Returns the offset of an arc diagram nodes column in relation to theplotArea.OnPointgetOnPoint()Returns the Series on point feature.StringgetOnSeries()Returns the id of another series in the chart that the wind barbs are projected on.NumbergetOpacity()Returns opacity of a series parts: line, fill (e.g.NumbergetOvershoot()Returns the amount of degrees that are allowed to overshoot (Requires gauge) Default:nullPackedBubbleLayoutAlgorithmgetPackedBubbleLayoutAlgorithm()Return options for layout algorithm when simulation is enabled, if any.PackedBubbleParentNodegetParentNode()Returns series options for parent nodes.XRangePartialFillgetPartialFill()Returns a partial fill for each point, if any.GaugePivotPlotOptionsgetPivot()Returns options for the pivot or the center point of the gauge.StringgetPlacementStrategy()Returns which algorithm is used for placement, and rotation of a word.SeriesPlotOptionsgetPlotOptions()Returns the plot options to the series.PointgetPoint(int index)Returns the point in the list from the given index.org.zkoss.json.JavaScriptValuegetPointDescriptionFormatter()Returns the formatter function to use instead of the default for series descriptions.NumbergetPointInterval()Returns the point interval of the series.StringgetPointIntervalUnit()On datetime series, this allows for setting the pointInterval to the two irregular time units, month and year.NumbergetPointPadding()Returns the padding between each column or bar, in x axis units.ObjectgetPointPlacement()Returns the point placement.NumbergetPointRange()Default: nullNumbergetPointsInInterval()Returns how many points should be plotted within 1 interval.NumbergetPointStart()If no x values are given for the points in a series, pointStart defines on what value to start.NumbergetPointWidth()Returns a pixel value specifying a fixed width for each column or bar.ObjectgetRadius()Returns the outer radius for points in a solid gauge.StringgetRootId()Returns which point to use as a root in the visualization.WordCloudRotationgetRotation()Returns the rotation options for the words in the wordcloud, if any.NumbergetRows()Returns the number of rows to display in the rectangular or circular view.NumbergetRowsize()Returns the row size - how many Y axis units each heatmap row should span.ObjectgetShadow()Returns the Shadow object or boolean value of shadow, depend on what was set.ObjectgetSize()Returns the diameter of the pie relative to the plot area.StringgetSizeBy()Returns what the plot area value should be represented by.NumbergetSlicedOffset()Returns if a point is sliced, moved out from the center, how many pixels should it be moved?SeriesSonificationgetSonification()Returns the Sonification/audio chart options for a series.NumbergetSortIndex()Returns the sort index of the point inside the treemap level.StringgetSpiral()Returns the spiral used for placing a word after the initial position experienced a collision with either another word or the borders.ObjectgetStack()Returns the option allows grouping series in a stacked chart.StringgetStacking()Returns whether to stack the values of each series on top of each other.NumbergetStartAngle()In circular view, returns the start angle of the item layout, in degrees where 0 is up.StatesgetStates()Returns a wrapper object for all the series options in specific states.StringgetStemDashStyle()Returns the dash style of the stem, the vertical line extending from the box to the whiskers.NumbergetStemWidth()Returns the width of the stem, the vertical line extending from the box to the whiskers.StringgetStep()Returns whether to apply steps to the line.<K,V>
Map<K,V>getStyle()Returns CSS styles for the words.TargetOptionsgetTargetOptions()Returns all options related with look and position of targets, if any.NumbergetThickness()Returns thickness describing the ring size for a donut type chart, overridinggetInnerSize().NumbergetThreshold()Returns the threshold, also called zero level or base level.StringgetTileShape()Returns the shape of the tiles in the tilemap.TooltipgetTooltip()Returns the tooltip options.booleangetTrackByArea()Returns whether the whole area or just the line should respond to mouseover tooltips and other mouse or touch events.TraverseUpButtongetTraverseUpButton()Returns options for the button appearing when traversing down in a treemap, if any.TreeGraphLinkgetTreeGraphLink()Returns the tree graph link style options, if any.NumbergetTurboThreshold()Returns when a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed.StringgetType()The type of series.ColorgetUpColor()Returns the color of up point in a waterfall series.NumbergetVectorLength()Returns the pixel length of the stems.ColorgetWhiskerColor()Returns the color of the whiskers, the horizontal lines marking low and high values.StringgetWhiskerDashStyle()Returns the dash style of the whisker.StringgetWhiskerLength()Returns the length of the whiskers, the horizontal lines marking low and high values.NumbergetWhiskerWidth()Returns the line width of the whiskers, the horizontal lines marking low and high values.StringgetWidth()Returns the width of the funnel compared to the width of the plot area, or the pixel width if it is a number.ObjectgetXAxis()When using dual or multiple x axes, this number defines which xAxis the particular series is connected to.NumbergetXOffset()Returns horizontal offset from the cartesian position, in pixels.ObjectgetYAxis()When using dual or multiple y axes, this number defines which yAxis the particular series is connected to.NumbergetYOffset()Returns vertical offset from the cartesian position, in pixels.intgetZIndex()Define the visual z index of the series.NumbergetZMax()Returns the maximum for the Z value range.NumbergetZMin()Returns the minimum for the Z value range.StringgetZoneAxis()Defines the Axis on which the zones are applied.List<Zone>getZones()An list defining zones within a series.NumbergetZThreshold()Returns whensetDisplayNegative(boolean)isfalse, bubbles with lower Z values are skipped.voidhide()Hides the series if visible.booleanisAllowPointSelect()Returns whether to allow this series' points to be selected by clicking on the graphic.booleanisAllowTraversingTree()When enabled the user can click on a point which is a parent and zoom in on its children.booleanisAnimation()Returns whether to enable or disable the initial animation when a series is displayed.booleanisCenteredLinks()Returns the option to center links rather than position them one after another.booleanisCenterInCategory()When true, the columns will center in the category, ignoring null or missing points.booleanisClip()Disable this option to allow series rendering in the whole plotting area.booleanisColorByPoint()Returns whether color by point option is enabled or notbooleanisConnectEnds()Returns whether to connect the ends of a line series plot across the extremes.booleanisConnectNulls()Returns whether to connect a graph line across null points, or render a gap between the two points on either side of the null.booleanisCrisp()When true, each point or column edge is rounded to its nearest pixel in order to render sharp on screen.booleanisDataAsColumns()Indicates data is structured as columns instead of rows.booleanisDisplayNegative()Returns whether to display negative sized bubbles.booleanisDraggable()Flag to determine if nodes are draggable or not.booleanisEnableMouseTracking()Returns enable or disable the mouse tracking for a specific series.booleanisEqualNodes()Returns whether nodes with different values should have the same size.booleanisGetExtremesFromAll()Returns whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis.booleanisGradientForSides()By default sides fill is set to a gradient through this option being set to true.booleanisGrouping()Returns whether to group non-stacked columns or to let them render independent of each other.booleanisIgnoreHiddenPoint()Returns whether ignore the hidden point.booleanisIncludeInDataExport()When set to false will prevent the series data from being included in any form of data export.booleanisInterpolation()Returns the boolean value of interpolated.booleanisLevelIsConstant()Used together with the levels and allowDrillToNode options.booleanisRelativeXValue()When true, X values in the data set are relative to the currentpointStart,pointIntervalandpointIntervalUnitsettings.booleanisReversed()Returns whether the series should be placed on the other side of the plotArea.booleanisRounded()Returns whether to draw rounded edges on the gauge.booleanisSelected()Returns whether to select the series initially.booleanisShadow()Returns whether to apply a drop shadow to the graph line.booleanisShowCheckbox()Returns if true, a checkbox is displayed next to the legend item to allow selecting the series.booleanisShowInLegend()Returns whether to display this particular series or series type in the legend.booleanisSizeByAbsoluteValue()When this is true, the absolute value of z determines the size of the bubble.booleanisSkipKeyboardNavigation()If set to true, the accessibility module will skip past the points in this series for keyboard navigation.booleanisSoftThreshold()When this is true, the series will not cause the Y axis to cross the zero plane (or threshold option) unless the data actually crosses the plane.booleanisStacking()Returns whether to stack the values of each series on top of each other or not.booleanisStickyTracking()Returns sticky tracking of mouse events.booleanisUseSimulation()Returns an option is giving a possibility to choose between using simulation for calculating bubble positions.booleanisVisible()Returns whether the series is visible or not.booleanisWrap()Returns when this option istrue, the dial will wrap around the axes.voidonChange(OptionDataEvent event)Sent when the contents of the chart option has changed.voidremove()voidselect()voidsetAccessibility(SeriesAccessibility accessibility)Sets accessibility options for a series.voidsetAllowPointSelect(boolean allowPointSelect)Sets whether to allow this series' points to be selected by clicking on the graphic.voidsetAllowTraversingTree(boolean allowTraversingTree)When enabled the user can click on a point which is a parent and zoom in on its children.voidsetAlternateStartingDirection(boolean alternateStartingDirection)Enabling this option will make the treemap alternate the drawing direction between vertical and horizontal.voidsetAnimation(boolean animation)Sets whether to enable or disable the initial animation when a series is displayed.voidsetAnimation(Animation animation)Sets the initial animation when a series is displayed.voidsetAnimationLimit(Number animationLimit)For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high.voidsetBaseSeries(int baseSeries)Sets an integer identifying the index to use for the base series.voidsetBaseSeries(String baseSeries)Sets a string representing the id of the series to use for the base series.voidsetBinsNumber(Number binsNumber)Sets a preferable number of bins.voidsetBinsNumber(String binsNumber)Sets a preferable number of bins.voidsetBinsNumber(org.zkoss.json.JavaScriptValue binsNumber)Sets a preferable number of bins.voidsetBinWidth(Number binWidth)Sets the width of each bin.voidsetBoostBlending(String boostBlending)Sets the color blending in the boost module.voidsetBoostThreshold(Number boostThreshold)Sets the point threshold for when a series should enter boost mode.voidsetBorderColor(String borderColor)Sets the color of the border surrounding each slice.voidsetBorderColor(Color borderColor)Sets the color of the border surrounding each slice.voidsetBorderColor(LinearGradient borderColor)Sets the color of the border surrounding each slice.voidsetBorderColor(RadialGradient borderColor)Sets the color of the border surrounding each slice.voidsetBorderDashStyle(String borderDashStyle)Sets the border dash style.voidsetBorderRadius(Number borderRadius)Sets the border radius of the series.voidsetBorderRadius(String borderRadius)Sets the border radius of the series.voidsetBorderWidth(Number borderWidth)Sets the border width of the series.voidsetBoxDashStyle(String boxDashStyle)Sets the dash style of the box.voidsetBreadcrumbs(Breadcrumbs breadcrumbs)Sets the options for the breadcrumbs, the navigation at the top leading the way up through the traversed levels.voidsetBrighten(Number brighten)Sets the brighten.voidsetCenter(Object... center)Sets the center of the pie chart relative to the plot area.voidsetCenter(List<Object> center)Sets the center of the pie chart relative to the plot area.voidsetCenteredLinks(boolean centeredLinks)Sets the option to center links rather than position them one after another.voidsetCenterInCategory(boolean centerInCategory)When true, the columns will center in the category, ignoring null or missing points.voidsetCenterPos(String centerPos)Sets the center position for arc diagram.voidsetClassName(String className)Sets an additional class name to apply to the series' graphical elements.voidsetClip(boolean clip)Disable this option to allow series rendering in the whole plotting area.voidsetCluster(Cluster cluster)Sets the options for marker clusters, the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts.voidsetCollapseButton(CollapseButton collapseButton)Sets the options applied to collapse Button for treegraph type.voidsetColor(String color)Sets individual color for the series.voidsetColor(Color color)Sets individual color for the series.voidsetColor(LinearGradient color)Sets individual color for the series.voidsetColor(RadialGradient color)Sets individual color for the series.voidsetColorAxis(boolean colorAxis)When using dual or multiple color axes, this defines which colorAxis the particular series is connected to.voidsetColorAxis(Number colorAxis)When using dual or multiple color axes, this defines which colorAxis the particular series is connected to.voidsetColorAxis(String colorAxis)When using dual or multiple color axes, this defines which colorAxis the particular series is connected to.voidsetColorByPoint(boolean colorByPoint)Sets whether to enable the color by point option or notvoidsetColorIndex(Number colorIndex)Sets a specific color index to use for the series, so its graphic representations are given the class name"highcharts-color-{n}".voidsetColorKey(String colorKey)Sets what data value should be used to calculate point color if colorAxis is used.voidsetColors(String... colors)Sets a series specific or series type specific color set to apply instead of the globalCharts.getColors()whensetColorByPoint(boolean)is true.voidsetColors(List<Color> colors)Sets a series specific or series type specific color set to apply instead of the globalCharts.getColors()whensetColorByPoint(boolean)is true.voidsetColors(Color... colors)Sets a series specific or series type specific color set to apply instead of the globalCharts.getColors()whensetColorByPoint(boolean)is true.voidsetColsize(Number colsize)Sets the column size - how many X axis units each column in the heatmap should span.voidsetConnectEnds(boolean connectEnds)Sets whether to connect the ends of a line series plot across the extremes.voidsetConnectNulls(boolean connectNulls)Sets whether to connect a graph line across null points, or render a gap between the two points on either side of the null.voidsetConnectorColor(String connectorColor)Sets the color of the line that connects the dumbbell point's values.voidsetConnectorWidth(Number connectorWidth)Sets the pixel width of the line that connects the dumbbell point's values.voidsetCrisp(boolean crisp)When true, each point or column edge is rounded to its nearest pixel in order to render sharp on screen.voidsetCropThreshold(Number cropThreshold)When the series contains less points than the crop threshold, all points are drawn, even if the points fall outside the visible plot area at the current zoom.voidsetCursor(String cursor)Sets you can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.voidsetCurveFactor(Number curveFactor)Higher numbers makes the links in a sankey diagram or dependency wheelrender more curved.<K,V>
voidsetCustom(Map<K,V> custom)Sets a reserved subspace to store options and values for customized functionality.voidsetDashStyle(String dashStyle)Sets a name for the dash style to use for the graph.voidsetData(Double... data)Sets an array of number datavoidsetData(Integer... data)Sets an array of number datavoidsetData(Number... data)Sets an array of number datavoidsetData(List<? extends Number> data)Sets a list of point datavoidsetData(Point... data)Sets an array of point datavoidsetDataAsColumns(boolean dataAsColumns)Indicates data is structured as columns instead of rows.voidsetDataGrouping(WindBarbDataGrouping dataGrouping)Sets the data grouping options for the wind barbs.voidsetDataLabels(List<DataLabels> dataLabels)Sets the list of options of data labels.voidsetDataLabels(DataLabels dataLabels)Sets the first or single option of data labels.voidsetDataSorting(DataSorting dataSorting)Sets the series data sorting.voidsetDepth(Number depth)Sets the depth of the 3D chart.voidsetDescription(String description)A description of the series to add to the screen reader information about the series.voidsetDial(GaugeDialPlotOptions dial)Sets options for the dial or arrow pointer of the gauge.voidsetDisplayNegative(boolean displayNegative)Sets whether to display negative sized bubbles.voidsetDragDrop(DragDrop dragDrop)Sets the options of the draggable-points module allows points to be moved around or modified in the chart.voidsetDraggable(boolean draggable)Flag to determine if nodes are draggable or not.voidsetEdgeColor(String color)3D columns only.voidsetEdgeColor(Color color)3D columns only.voidsetEdgeWidth(Number edgeWidth)3D columns only.voidsetEnableMouseTracking(boolean enableMouseTracking)Sets enable or disable the mouse tracking for a specific series.voidsetEndAngle(Number endAngle)In circular view, sets the end angle of the item layout, in degrees where 0 is up.voidsetEqualNodes(boolean equalNodes)Sets whether nodes with different values should have the same size.voidsetEvents(Map<String,org.zkoss.json.JavaScriptValue> events)Sets a map of general event handlers for the series items.voidsetFillColor(String color)Sets fill color for the area.voidsetFillColor(Color color)Sets fill color for the area.voidsetFillColor(LinearGradient color)Sets fill gradient for the area.voidsetFillColor(RadialGradient color)Sets fill gradient for the area.voidsetFillOpacity(Number fillOpacity)Sets fill opacity for the area, arearange, areaspline, areasplinerange, bellcurve, and streamgraph.voidsetFindNearestPointBy(String findNearestPointBy)Sets whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series.voidsetGapSize(int gapSize)voidsetGetExtremesFromAll(boolean getExtremesFromAll)Sets whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis.voidsetGradientForSides(boolean gradientForSides)By default sides fill is set to a gradient through this option being set to true.voidsetGrouping(boolean grouping)Sets whether to group non-stacked columns or to let them render independent of each other.voidsetGroupPadding(Number groupPadding)Sets padding between each value groups, in x axis units.voidsetGroupZPadding(Number groupZPadding)Sets the spacing between columns on the Z Axis in a 3D chart.voidsetHangingIndent(Number hangingIndent)Sets the indentation in pixels of hanging nodes, nodes which parent has layout set to hanging.voidsetHangingIndentTranslation(String hangingIndentTranslation)Defines the indentation of a hanging layout parent's children.voidsetHeight(String height)Sets the height of the neck, the lower part of a funnel.voidsetId(String id)Sets an id for the series.voidsetIgnoreHiddenPoint(boolean ignoreHiddenPoint)Sets whether ignore the hidden point.voidsetIncludeInDataExport(boolean includeInDataExport)When set to false will prevent the series data from being included in any form of data export.voidsetIndex(int index)Sets the index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.voidsetInnerRadius(Number innerRadius)Sets the inner radius for points in a solid gauge.voidsetInnerSize(int innerSize)In circular view, sets the size of the inner diameter of the circle.voidsetInnerSize(String innerSize)In circular view, sets the size of the inner diameter of the circle.voidsetInteractByLeaf(boolean interactByLeaf)This option decides if the user can interact with the parent nodes or just the leaf nodes.voidsetInterpolation(boolean interpolation)Sets the boolean value of interpolated.voidsetIntervals(Number intervals)Sets the length of the bell curve.voidsetItemPadding(Number itemPadding)Sets the padding between the items, given in relative size where the size of the item is 1.voidsetJitter(Jitter jitter)Apply a jitter effect for the rendered markers.voidsetKeys(String... keys)Returns an array specifying which option maps to which key in the data point array.voidsetKeys(List<String> keys)Returns an array specifying which option maps to which key in the data point array.voidsetLabel(SeriesLabel label)Sets series label options.voidsetLayout(String layout)Sets the layout of the items in rectangular view.voidsetLayoutAlgorithm(String layoutAlgorithm)Set the option decides which algorithm is used for setting position and dimensions of the points.voidsetLayoutAlgorithm(NetworkGraphLayoutAlgorithm layoutAlgorithm)Sets options for layout algorithm for networkgraph typevoidsetLayoutAlgorithm(PackedBubbleLayoutAlgorithm layoutAlgorithm)Sets options for layout algorithm when simulation is enabled.voidsetLayoutStartingDirection(String layoutStartingDirection)Set which direction the layout algorithm will start drawing.voidsetLegendIndex(int legendIndex)Sets the sequential index of the series in the legend.voidsetLevelIsConstant(boolean levelIsConstant)Used together with the levels and allowDrillToNode options.voidsetLevels(List<Level> levels)Set options on specific levels.voidsetLevels(Level... levels)Set options on specific levels.voidsetLevelSize(LevelSize levelSize)Sets options of determining the width of the ring per level.voidsetLinecap(String linecap)Sets the line cap used for line ends and line joins on the graph.voidsetLineColor(String color)Sets a separate color for the graph line.voidsetLineColor(Color color)Sets a separate color for the graph line.voidsetLineColor(LinearGradient color)Sets a separate color for the graph line.voidsetLineColor(RadialGradient color)Sets a separate color for the graph line.voidsetLineWidth(Number lineWidth)Sets the width of the point marker's outline.voidsetLink(NetworkGraphLink link)Sets the link style options.voidsetLinkColor(String linkColor)Sets the color of the links between nodes.voidsetLinkColor(Color linkColor)Sets the color of the links between nodes.(Requires organization)voidsetLinkedTo(String linkedTo)Sets the id of another series to link to.voidsetLinkLineWidth(Number linkLineWidth)Sets the line width of the links connecting nodes, in pixels.voidsetLinkOpacity(Number linkOpacity)Sets linkOpacity on all points which lay on the same level.voidsetLinkRadius(Number linkRadius)Sets radius for the rounded corners of the links between nodes.voidsetLinkWeight(Number linkWeight)The global link weight.voidsetLowColor(String color)Sets color of the start markers in a dumbbell graph.voidsetLowColor(Color color)Sets color of the start markers in a dumbbell graph.voidsetLowColor(LinearGradient color)Sets color of the start markers in a dumbbell graph.voidsetLowColor(RadialGradient color)Sets color of the start markers in a dumbbell graph.voidsetLowMarker(LowMarker lowMarker)Sets options for the lower markers of the dumbbell-like series.voidsetMarker(Marker marker)Sets the marker for this series.voidsetMaxFontSize(Number maxFontSize)Sets the word with the largest weight will have a font size equal to this value.voidsetMaxPointSize(Number maxPointSize)Sets the maximum size of the points' radius related to chart's plotArea.voidsetMaxPointWidth(Number maxPointWidth)Sets the maximum allowed pixel width for a column, translated to the height of a bar in a bar chart.voidsetMaxSize(Number maxSize)Sets maximum bubble size.voidsetMaxSize(String maxSize)Sets maximum bubble size.voidsetMedianColor(String medianColor)Sets the color of the median line.voidsetMedianColor(Color medianColor)Sets the color of the median line.voidsetMedianColor(LinearGradient medianColor)Sets the color of the median line.voidsetMedianColor(RadialGradient medianColor)Sets the color of the median line.voidsetMedianDashStyle(String medianDashStyle)Sets a name for the dash style of the median.voidsetMedianWidth(Number medianWidth)Sets the pixel width of the median line.voidsetMinFontSize(Number minFontSize)Sets a threshold determining the minimum font size that can be applied to a word.voidsetMinLinkWidth(Number minLinkWidth)Sets the minimal width for a line of a sankey.voidsetMinNodeLength(Number minNodeLength)In a horizontal chart, the minimum width of the hanging nodes only, in pixels.voidsetMinPointLength(Number minPointLength)Sets the minimal height for a column or width for a bar.voidsetMinPointSize(Number minPointSize)Sets the minimum size of the points' radius related to chart's plotArea.voidsetMinSize(Number minSize)Sets the minimum size.voidsetMinSize(String minSize)Sets the minimum size.voidsetName(String name)Sets the name of the series as shown in the legend, tooltip etc.voidsetNeckHeight(String neckHeight)Sets the height of the neck, the lower part of the funnel.voidsetNeckWidth(String neckWidth)Sets the width of the neck, the lower part of the funnel.voidsetNegativeColor(String color)Sets the color for the parts of the graph or points that are below thesetThreshold(Number).voidsetNegativeColor(Color color)Sets the color for the parts of the graph or points that are below thesetThreshold(Number).voidsetNegativeColor(LinearGradient color)Sets the color for the parts of the graph or points that are below thesetThreshold(Number).voidsetNegativeColor(RadialGradient color)Sets the color for the parts of the graph or points that are below thesetThreshold(Number).voidsetNegativeFillColor(String color)Sets a separate color for the negative part of the area.voidsetNegativeFillColor(Color color)Sets a separate color for the negative part of the area.voidsetNegativeFillColor(LinearGradient color)Sets a separate color for the negative part of the area.voidsetNegativeFillColor(RadialGradient color)Sets a separate color for the negative part of the area.voidsetNodePadding(Number nodePadding)Sets the padding between nodes in a sankey diagram or dependency wheel, in pixels.voidsetNodeWidth(Number nodeWidth)Sets the pixel width of each node in a sankey diagram or dependency wheel, or the height in case the chart is inverted.voidsetNodeWidth(String nodeWidth)Sets the pixel width of each node in a sankey diagram or dependency wheel, or the height in case the chart is inverted.voidsetNullColor(String color)Sets the color applied to null points.voidsetNullColor(Color color)Sets the color applied to null points.voidsetNullColor(LinearGradient color)Sets the color applied to null points.voidsetNullColor(RadialGradient color)Sets the color applied to null points.voidsetOffset(String offset)Sets the offset of an arc diagram nodes column in relation to theplotArea.voidsetOnPoint(OnPoint onPoint)Sets the Series on point feature.voidsetOnSeries(String onSeries)Sets the id of another series in the chart that the wind barbs are projected on.voidsetOpacity(Number opacity)Sets opacity of a series parts: line, fill (e.g.voidsetOvershoot(Number overshoot)Sets the amount of degrees that are allowed to overshoot (Requires gauge)voidsetParentNode(PackedBubbleParentNode parentNode)Sets series options for parent nodes.voidsetPartialFill(Number amount)Sets a partial fill with an amount for each point.voidsetPartialFill(XRangePartialFill partialFill)Sets a partial fill for each point.voidsetPivot(GaugePivotPlotOptions pivot)Sets options for the pivot or the center point of the gauge.voidsetPlacementStrategy(String placementStrategy)Sets which algorithm is used for placement, and rotation of a word.voidsetPlotOptions(SeriesPlotOptions plotOptions)Sets the plot options to the series.voidsetPointDescriptionFormatter(org.zkoss.json.JavaScriptValue pointDescriptionFormatter)Sets the formatter function to use instead of the default for series descriptions.voidsetPointInterval(Number pointInterval)Sets the point interval of the series.voidsetPointIntervalUnit(String pointIntervalUnit)Set the irregular time unit for point interval, only "day", "month", or "year" is allowed.voidsetPointPadding(Number pointPadding)Sets the padding between each column or bar, in x axis units.voidsetPointPlacement(Number pointPlacement)Sets the point placement with a numbervoidsetPointPlacement(String pointPlacement)Sets the point placement.voidsetPointRange(Number pointRange)voidsetPointsInInterval(Number pointsInInterval)Sets how many points should be plotted within 1 interval.voidsetPointStart(Number pointStart)If no x values are given for the points in a series, pointStart defines on what value to start.voidsetPointWidth(Number pointWidth)Sets a pixel value specifying a fixed width for each column or bar.voidsetRadius(Number radius)Sets the outer radius for points in a solid gauge.voidsetRadius(String radius)Sets the outer radius for points in a solid gauge.voidsetRelativeXValue(boolean relativeXValue)When true, X values in the data set are relative to the currentpointStart,pointIntervalandpointIntervalUnitsettings.voidsetReversed(boolean reversed)Sets whether the series should be placed on the other side of the plotArea.voidsetRootId(String rootId)Sets which point to use as a root in the visualization.voidsetRotation(WordCloudRotation rotation)Sets the rotation options for the words in the wordcloud.voidsetRounded(boolean rounded)Sets whether to draw rounded edges on the gauge.voidsetRows(Number rows)Sets the number of rows to display in the rectangular or circular view.voidsetRowsize(Number rowsize)Sets the row size - how many Y axis units each heatmap row should span.voidsetSelected(boolean selected)Sets whether to select the series initially.voidsetShadow(boolean shadow)Sets whether to apply a drop shadow to the graph line.voidsetShadow(Shadow shadow)Sets whether to apply a drop shadow to the graph line.voidsetShowCheckbox(boolean showCheckbox)Sets if true, a checkbox is displayed next to the legend item to allow selecting the series.voidsetShowInLegend(boolean showInLegend)Sets whether to display this particular series or series type in the legend.voidsetSize(Number size)Sets the diameter of the pie relative to the plot area.voidsetSize(String size)Sets the diameter of the pie relative to the plot area.voidsetSizeBy(String sizeBy)Sets what the plot area value should be represented by.voidsetSizeByAbsoluteValue(boolean sizeByAbsoluteValue)When this is true, the absolute value of z determines the size of the bubble.voidsetSkipKeyboardNavigation(boolean skipKeyboardNavigation)If set to true, the accessibility module will skip past the points in this series for keyboard navigation.voidsetSlicedOffset(Number slicedOffset)Sets if a point is sliced, moved out from the center, how many pixels should it be moved?voidsetSoftThreshold(boolean softThreshold)When this is true, the series will not cause the Y axis to cross the zero plane (or threshold option) unless the data actually crosses the plane.voidsetSonification(SeriesSonification sonification)Sets the Sonification/audio chart options for a series.voidsetSortIndex(Number sortIndex)Sets the sort index of the point inside the treemap level.voidsetSpiral(String spiral)Sets the spiral used for placing a word after the initial position experienced a collision with either another word or the borders.voidsetStack(Number stack)Sets the option allows grouping series in a stacked chart.voidsetStack(String stack)Sets the option allows grouping series in a stacked chart.voidsetStacking(Boolean stacking)Sets whether to stack the values of each series on top of each other.voidsetStacking(String stacking)Sets whether to stack the values of each series on top of each other.voidsetStartAngle(Number startAngle)In circular view, sets the start angle of the item layout, in degrees where 0 is up.voidsetStates(States states)Sets a wrapper object for all the series options in specific states.voidsetStemDashStyle(String stemDashStyle)Sets the dash style of the stem, the vertical line extending from the box to the whiskers.voidsetStemWidth(Number stemWidth)Sets the width of the stem, the vertical line extending from the box to the whiskers.voidsetStep(String step)Sets whether to apply steps to the line.voidsetStickyTracking(boolean stickyTracking)Sets sticky tracking of mouse events.voidsetStyle(String style)Sets CSS styles for the words.<K,V>
voidsetStyle(Map<K,V> style)Sets CSS styles for the words.voidsetTargetOptions(TargetOptions targetOptions)Sets all options related with look and position of targets.voidsetThickness(Number thickness)Sets thickness describing the ring size for a donut type chart, overridinggetInnerSize().voidsetThreshold(Number threshold)Sets the threshold, also called zero level or base level.voidsetTileShape(String tileShape)Sets the shape of the tiles in the tilemap.voidsetTooltip(Tooltip tooltip)Sets the tooltip options.voidsetTrackByArea(boolean trackByArea)Sets whether the whole area or just the line should respond to mouseover tooltips and other mouse or touch events.voidsetTraverseUpButton(TraverseUpButton traverseUpButton)Sets options for the button appearing when traversing down in a treemap.voidsetTreeGraphLink(TreeGraphLink link)Sets the tree graph link style options.voidsetTurboThreshold(Number turboThreshold)Sets when a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed.voidsetType(String type)The type of series.voidsetUpColor(Color color)Sets the color of up point in a waterfall series.voidsetUseSimulation(boolean useSimulation)Sets an option is giving a possibility to choose between using simulation for calculating bubble positions.voidsetVectorLength(Number vectorLength)Sets the pixel length of the stems.voidsetVisible(boolean visible)Sets whether the series is visible.booleansetVisibleDirectly(boolean visible)Sets whether the series is visible directly.voidsetWhiskerColor(String color)Sets the color of the whiskers, the horizontal lines marking low and high values.voidsetWhiskerColor(Color color)Sets the color of the whiskers, the horizontal lines marking low and high values.voidsetWhiskerColor(LinearGradient color)Sets the color of the whiskers, the horizontal lines marking low and high values.voidsetWhiskerColor(RadialGradient color)Sets the color of the whiskers, the horizontal lines marking low and high values.voidsetWhiskerDashStyle(String whiskerDashStyle)Sets the dash style of the whisker.voidsetWhiskerLength(Number whiskerLength)Sets the length of the whiskers, the horizontal lines marking low and high values.voidsetWhiskerLength(String whiskerLength)Sets the length of the whiskers, the horizontal lines marking low and high values.voidsetWhiskerWidth(Number whiskerWidth)Sets the line width of the whiskers, the horizontal lines marking low and high values.voidsetWidth(String width)Sets the width of the funnel compared to the width of the plot area, or the pixel width if it is a number.voidsetWrap(boolean wrap)Sets when this option istrue, the dial will wrap around the axes.voidsetXAxis(int xAxis)When using dual or multiple x axes, this number defines which xAxis the particular series is connected to.voidsetXAxis(String xAxis)When using dual or multiple x axes, this number defines which xAxis the particular series is connected to.voidsetXOffset(Number xOffset)Sets horizontal offset from the cartesian position, in pixels.voidsetYAxis(int yAxis)When using dual or multiple y axes, this number defines which yAxis the particular series is connected to.voidsetYAxis(String yAxis)When using dual or multiple y axes, this number defines which yAxis the particular series is connected to.voidsetYOffset(Number yOffset)Sets vertical offset from the cartesian position, in pixels.voidsetZIndex(int zIndex)Define the visual z index of the series.voidsetZMax(Number zMax)Sets the maximum for the Z value range.voidsetZMin(Number zMin)Sets the minimum for the Z value range.voidsetZoneAxis(String zoneAxis)Set the axis on which the zones are applied.voidsetZones(List<Zone> zones)Set the zones within a series.voidsetZThreshold(Number zThreshold)Sets whensetDisplayNegative(boolean)isfalse, bubbles with lower Z values are skipped.voidshow()Shows the series if hidden.StringtoJSONString()Encodes this object to a JSON string.-
Methods inherited from class org.zkoss.chart.Optionable
addExtraAttr, addOptionDataListener, clearOptonDataListener, clone, containsKey, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, getAttr, getAttr, getClientState, getExtraAttr, merge, removeExtraAttr, removeKey, removeOptionDataListener, setAttr, setAttr, setAttr, setAttr, toString
-
-
-
-
Method Detail
-
getAccessibility
public SeriesAccessibility getAccessibility()
Returns accessibility options for a series. If null, create a new one.Default: an instance of
SeriesAccessibility- Since:
- 10.2.1.0
-
setAccessibility
public void setAccessibility(SeriesAccessibility accessibility)
Sets accessibility options for a series.- Since:
- 10.2.1.0
-
getAnimationLimit
public Number getAnimationLimit()
For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high. For example, for a column chart and its derivatives, animation does not run if there is more than 250 points totally. To disable this cap, set animationLimit to Infinity.Default: null
- Since:
- 10.2.1.0
-
setAnimationLimit
public void setAnimationLimit(Number animationLimit)
For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high. For example, for a column chart and its derivatives, animation does not run if there is more than 250 points totally. To disable this cap, set animationLimit to Infinity.Default: null
- Since:
- 10.2.1.0
-
isAllowTraversingTree
public boolean isAllowTraversingTree()
When enabled the user can click on a point which is a parent and zoom in on its children.Default: false
- Since:
- 10.2.1.0
-
setAllowTraversingTree
public void setAllowTraversingTree(boolean allowTraversingTree)
When enabled the user can click on a point which is a parent and zoom in on its children.- Since:
- 10.2.1.0
-
getAlternateStartingDirection
public boolean getAlternateStartingDirection()
Enabling this option will make the treemap alternate the drawing direction between vertical and horizontal. The next levels starting direction will always be the opposite of the previous.Note: requires Treemap type
Defaults to false.
- Since:
- 10.2.1.0
-
setAlternateStartingDirection
public void setAlternateStartingDirection(boolean alternateStartingDirection)
Enabling this option will make the treemap alternate the drawing direction between vertical and horizontal. The next levels starting direction will always be the opposite of the previous.Note: requires Treemap type
Defaults to false.
- Since:
- 10.2.1.0
-
getBinsNumber
public Object getBinsNumber()
Returns a preferable number of bins. It is a suggestion, so a histogram may have a different number of bins. By default it is set to the square root of the base series' data length.Available options are:
"square-root","sturges,"rice". You can also define a function which takes a"baseSeries"as a parameter and should return a positive integer.Defaults to
"square-root".- Since:
- 10.2.1.0
-
setBinsNumber
public void setBinsNumber(org.zkoss.json.JavaScriptValue binsNumber)
Sets a preferable number of bins. It is a suggestion, so a histogram may have a different number of bins. By default it is set to the square root of the base series' data length.Available options are:
"square-root","sturges,"rice". You can also define a function which takes a"baseSeries"as a parameter and should return a positive integer.Defaults to
"square-root".- Since:
- 10.2.1.0
-
setBinsNumber
public void setBinsNumber(String binsNumber)
Sets a preferable number of bins. It is a suggestion, so a histogram may have a different number of bins. By default it is set to the square root of the base series' data length.Available options are:
"square-root","sturges,"rice". You can also define a function which takes a"baseSeries"as a parameter and should return a positive integer.Defaults to
"square-root".- Since:
- 10.2.1.0
-
setBinsNumber
public void setBinsNumber(Number binsNumber)
Sets a preferable number of bins. It is a suggestion, so a histogram may have a different number of bins. By default it is set to the square root of the base series' data length.Available options are:
"square-root","sturges,"rice". You can also define a function which takes a"baseSeries"as a parameter and should return a positive integer.Defaults to
"square-root".- Since:
- 10.2.1.0
-
getBinWidth
public Number getBinWidth()
Returns the width of each bin. By default the bin's width is calculated as(max - min) / number of bins. This option takes precedence over binsNumber.Default: null
- Since:
- 10.2.1.0
-
setBinWidth
public void setBinWidth(Number binWidth)
Sets the width of each bin. By default the bin's width is calculated as(max - min) / number of bins. This option takes precedence over binsNumber.- Since:
- 10.2.1.0
-
getBoostBlending
public String getBoostBlending()
Returns the color blending in the boost module.Defaults to null.
- Since:
- 10.2.1.0
-
setBoostBlending
public void setBoostBlending(String boostBlending)
Sets the color blending in the boost module.Defaults to null.
- Since:
- 10.2.1.0
-
getBoostThreshold
public Number getBoostThreshold()
Returns the point threshold for when a series should enter boost mode. Setting it to e.g. 2000 will cause the series to enter boost mode when there are 2000 or more points in the series. To disable boosting on the series, set the boostThreshold to 0. Setting it to 1 will force boosting.Note that the cropThreshold also affects this setting. When zooming in on a series that has fewer points than the cropThreshold, all points are rendered although outside the visible plot area, and the boostThreshold won't take effect.
Defaults to 5000.
- Since:
- 10.2.1.0
-
setBoostThreshold
public void setBoostThreshold(Number boostThreshold)
Sets the point threshold for when a series should enter boost mode. Setting it to e.g. 2000 will cause the series to enter boost mode when there are 2000 or more points in the series. To disable boosting on the series, set the boostThreshold to 0. Setting it to 1 will force boosting.Note that the cropThreshold also affects this setting. When zooming in on a series that has fewer points than the cropThreshold, all points are rendered although outside the visible plot area, and the boostThreshold won't take effect.
Defaults to 5000.
- Since:
- 10.2.1.0
-
getId
public String getId()
Returns an id for the series.Default: null.
-
setId
public void setId(String id)
Sets an id for the series.
-
isIgnoreHiddenPoint
public boolean isIgnoreHiddenPoint()
Returns whether ignore the hidden point.Equivalent to
Chart.isIgnoreHiddenSeries(), this option tells whether the series shall be redrawn as if the hidden point werenull.The default value true.
- Since:
- 10.2.1.0
-
setIgnoreHiddenPoint
public void setIgnoreHiddenPoint(boolean ignoreHiddenPoint)
Sets whether ignore the hidden point.Equivalent to
Chart.isIgnoreHiddenSeries(), this option tells whether the series shall be redrawn as if the hidden point werenull.The default value true.
- Since:
- 10.2.1.0
-
isIncludeInDataExport
public boolean isIncludeInDataExport()
When set to false will prevent the series data from being included in any form of data export.Default: true
- Since:
- 10.2.1.0
-
setIncludeInDataExport
public void setIncludeInDataExport(boolean includeInDataExport)
When set to false will prevent the series data from being included in any form of data export.- Since:
- 10.2.1.0
-
isAnimation
public boolean isAnimation()
Returns whether to enable or disable the initial animation when a series is displayed.Default: true.
- Since:
- 7.2.1.0
-
setAnimation
public void setAnimation(boolean animation)
Sets whether to enable or disable the initial animation when a series is displayed.- See Also:
setAnimation(Animation)
-
isAllowPointSelect
public boolean isAllowPointSelect()
Returns whether to allow this series' points to be selected by clicking on the graphic.Default: false
- Since:
- 7.2.2.0
-
setAllowPointSelect
public void setAllowPointSelect(boolean allowPointSelect)
Sets whether to allow this series' points to be selected by clicking on the graphic.- Since:
- 7.2.2.0
-
getAnimation
public Animation getAnimation()
Returns whether to enable or disable the initial animation when a series is displayed.Default: an instance of
Animation.- Since:
- 7.2.1.0
-
setAnimation
public void setAnimation(Animation animation)
Sets the initial animation when a series is displayed. Please note that this option only applies to the initial animation of the series itself. For other animations, see chart.animation and the animation parameter under the API methods.- Since:
- 7.2.1.0
- See Also:
setAnimation(boolean)
-
getBaseSeries
public Object getBaseSeries()
Returns an integer identifying the index to use for the base series, or a string representing the id of the series.Default: null
- Since:
- 7.2.1.0
-
setBaseSeries
public void setBaseSeries(int baseSeries)
Sets an integer identifying the index to use for the base series.- Since:
- 7.2.1.0
-
setBaseSeries
public void setBaseSeries(String baseSeries)
Sets a string representing the id of the series to use for the base series.- Since:
- 7.2.1.0
-
getBorderColor
public Color getBorderColor()
Returns the color of the border surrounding each slice.Default: null
- Since:
- 7.2.1.0
-
setBorderColor
public void setBorderColor(Color borderColor)
Sets the color of the border surrounding each slice.- Since:
- 7.2.1.0
-
setBorderColor
public void setBorderColor(String borderColor)
Sets the color of the border surrounding each slice.- Since:
- 7.2.1.0
-
setBorderColor
public void setBorderColor(LinearGradient borderColor)
Sets the color of the border surrounding each slice.- Since:
- 7.2.1.0
-
setBorderColor
public void setBorderColor(RadialGradient borderColor)
Sets the color of the border surrounding each slice.- Since:
- 7.2.1.0
-
getBorderDashStyle
public String getBorderDashStyle()
Returns the border dash style.Note: requires venn type
Default: "solid"
- Since:
- 10.2.1.0
-
setBorderDashStyle
public void setBorderDashStyle(String borderDashStyle)
Sets the border dash style.Note: requires venn type
Default: "solid"
- Since:
- 10.2.1.0
-
getBreadcrumbs
public Breadcrumbs getBreadcrumbs()
Returns the options for the breadcrumbs, the navigation at the top leading the way up through the traversed levels.Note: requires sunburst and treemap type.
Default: an instance of Breadcrumbs
- Since:
- 10.2.1.0
-
setBreadcrumbs
public void setBreadcrumbs(Breadcrumbs breadcrumbs)
Sets the options for the breadcrumbs, the navigation at the top leading the way up through the traversed levels.Note: requires sunburst and treemap type.
Default: an instance of Breadcrumbs
- Since:
- 10.2.1.0
-
getBrighten
public Number getBrighten()
Returns the brighten. (Requires venn type)Default:
0- Since:
- 10.2.1.0
-
setBrighten
public void setBrighten(Number brighten)
Sets the brighten. (Requires venn type)Default:
0- Since:
- 10.2.1.0
-
getBorderRadius
public Object getBorderRadius()
Returns the border radius of the series.- Since:
- 7.2.1.0
-
setBorderRadius
public void setBorderRadius(Number borderRadius)
Sets the border radius of the series.- Since:
- 7.2.1.0
-
setBorderRadius
public void setBorderRadius(String borderRadius)
Sets the border radius of the series.- Since:
- 11.2.0.0
-
getBorderWidth
public Number getBorderWidth()
Returns the border width of the series.
-
setBorderWidth
public void setBorderWidth(Number borderWidth)
Sets the border width of the series.
-
getBoxDashStyle
public String getBoxDashStyle()
Returns the dash style of the box.Note: requires boxplot or errorbar type
Defaults to Solid.
- Since:
- 10.2.1.
-
setBoxDashStyle
public void setBoxDashStyle(String boxDashStyle)
Sets the dash style of the box.Note: requires boxplot or errorbar type
Defaults to Solid.
- Since:
- 10.2.1.
-
getCenter
public List<String> getCenter()
Returns the center of the pie chart relative to the plot area. Can be percentages or pixel values. The default behaviour is to center the pie so that all slices and data labels are within the plot area. As a consequence, the pie may actually jump around in a chart with dynamic values, as the data labels move. In that case, the center should be explicitly set, for example to ["50%", "50%"].Default: [null, null]
- Since:
- 7.2.1.0
-
setCenter
public void setCenter(List<Object> center)
Sets the center of the pie chart relative to the plot area. Can be percentages or pixel values. The default behaviour is to center the pie so that all slices and data labels are within the plot area. As a consequence, the pie may actually jump around in a chart with dynamic values, as the data labels move. In that case, the center should be explicitly set, for example to ["50%", "50%"].- Since:
- 7.2.1.0
-
isCenteredLinks
public boolean isCenteredLinks()
Returns the option to center links rather than position them one after another. (Requires arcdiagram type)Default:
false.- Since:
- 10.2.1.0
-
setCenteredLinks
public void setCenteredLinks(boolean centeredLinks)
Sets the option to center links rather than position them one after another. (Requires arcdiagram type)- Since:
- 10.2.1.0
-
isCenterInCategory
public boolean isCenterInCategory()
When true, the columns will center in the category, ignoring null or missing points. When false, space will be reserved for null or missing points.Default:
false.- Since:
- 10.2.1.0
-
setCenterInCategory
public void setCenterInCategory(boolean centerInCategory)
When true, the columns will center in the category, ignoring null or missing points. When false, space will be reserved for null or missing points.- Since:
- 10.2.1.0
-
getCenterPos
public String getCenterPos()
Returns the center position for arc diagram.Default:
null- Since:
- 10.2.1.0
-
setCenterPos
public void setCenterPos(String centerPos)
Sets the center position for arc diagram.Default:
null- Since:
- 10.2.1.0
-
getClassName
public String getClassName()
Returns an additional class name to apply to the series' graphical elements. This option does not replace default class names of the graphical element.Default: null
- Since:
- 10.2.1.0
-
setClassName
public void setClassName(String className)
Sets an additional class name to apply to the series' graphical elements. This option does not replace default class names of the graphical element.Default: null
- Since:
- 10.2.1.0
-
isClip
public boolean isClip()
Disable this option to allow series rendering in the whole plotting area.Note: Clipping should be always enabled when
chart.zoomTypeis setDefaults to true.
- Since:
- 10.2.1.0
-
setClip
public void setClip(boolean clip)
Disable this option to allow series rendering in the whole plotting area.Note: Clipping should be always enabled when
chart.zoomTypeis setDefaults to true.
- Since:
- 10.2.1.0
-
getCluster
public Cluster getCluster()
Returns the options for marker clusters, the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts.Note: requires scatter, vector, or venn type
Default: an instance of Cluster.
- Since:
- 10.2.1.0
-
setCluster
public void setCluster(Cluster cluster)
Sets the options for marker clusters, the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts.Note: requires scatter, vector, or venn type
Default: an instance of Cluster.
- Since:
- 10.2.1.0
-
setCenter
public void setCenter(Object... center)
Sets the center of the pie chart relative to the plot area. Can be percentages or pixel values. The default behaviour is to center the pie so that all slices and data labels are within the plot area. As a consequence, the pie may actually jump around in a chart with dynamic values, as the data labels move. In that case, the center should be explicitly set, for example to ["50%", "50%"].- Since:
- 7.2.1.0
-
setPlotOptions
public void setPlotOptions(SeriesPlotOptions plotOptions)
Sets the plot options to the series.
-
getPlotOptions
public SeriesPlotOptions getPlotOptions()
Returns the plot options to the series. If null, it will create a new one.
-
addPoint
public void addPoint(Point point)
Add a point at the end of the current points list.- Parameters:
point-
-
addPoint
public void addPoint(Point point, boolean redraw, boolean shift, boolean animation)
Add a point to the end of the current points list.- Parameters:
point- the pointredraw- whether to redraw the chartshift- If shift is true, a point is shifted off the start of the series as one is appended to the end.animation- Whether to apply animation, and optionally animation configuration
-
addPoint
public void addPoint(Point point, boolean redraw, boolean shift, Animation animation)
Add a point at the end of the current points list.- Parameters:
point- the pointredraw- whether to redraw the chartshift- If shift is true, a point is shifted off the start of the series as one is appended to the end.animation- Whether to apply animation, and optionally animation configuration
-
addPoint
public void addPoint(Number y)
Add a number point to the end of the current points list.
-
addPoint
public void addPoint(double y)
Add a number point to the end of the current points list.
-
addPoint
public void addPoint(Number x, Number y)
Add a point with x and y numbers to the end of the current points list.
-
addPoint
public void addPoint(double x, double y)Add a point with x and y numbers to the end of the current points list.
-
addPoint
public void addPoint(Number x, Number low, Number high)
Add a point with x, low, and high numbers to the end of the current points list.
-
addPoint
public void addPoint(double x, double low, double high)Add a point with x, low, and high numbers to the end of the current points list.
-
addPoint
public void addPoint(String name, Number y)
Add a point with name and number to the end of the current points list.
-
addPoint
public void addPoint(String name, Number y, Number x)
Add a point with name, Y number, and X index to the end of the current points list.- Since:
- 1.1
-
addPoint
public void addPoint(String name, double y)
Add a point with name and number to the end of the current points list.
-
addPoint
public void addPoint(String from, String to)
Add a point with from and to to the end of the current points list.- Since:
- 7.2.1.0
-
addPoint
public void addPoint(String from, String to, Number weight)
Add a point with from, to and weight to the end of the current points list.- Since:
- 7.2.1.0
-
addPoint
public void addPoint(String id, String parent, String name)
Add a point with id, parent and name to the end of the current points list.- Since:
- 11.2.0.0
-
setData
public void setData(Point... data)
Sets an array of point data
-
setData
public void setData(Number... data)
Sets an array of number data
-
setData
public void setData(Double... data)
Sets an array of number data
-
setData
public void setData(Integer... data)
Sets an array of number data
-
getPoint
public Point getPoint(int index)
Returns the point in the list from the given index.
-
setIndex
public void setIndex(int index)
Sets the index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.
-
getIndex
public int getIndex()
Returns the index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.Default: -1, it means depended on the implementaion.
-
getInnerRadius
public Object getInnerRadius()
Returns the inner radius for points in a solid gauge. Can be given as a number (pixels) or percentage string.Default: 60
- Since:
- 10.2.1.0
-
setInnerRadius
public void setInnerRadius(Number innerRadius)
Sets the inner radius for points in a solid gauge. Can be given as a number (pixels).- Since:
- 10.2.1.0
-
getIntervals
public Number getIntervals()
Returns the length of the bell curve. A unit of the length of the bell curve is standard deviation. Requires bellcurve.Default: 3
- Since:
- 7.2.1.0
-
setIntervals
public void setIntervals(Number intervals)
Sets the length of the bell curve. A unit of the length of the bell curve is standard deviation. Requires bellcurve.- Since:
- 7.2.1.0
-
getItemPadding
public Number getItemPadding()
Returns the padding between the items, given in relative size where the size of the item is 1.Default:
0.1- Since:
- 10.2.1.0
-
setItemPadding
public void setItemPadding(Number itemPadding)
Sets the padding between the items, given in relative size where the size of the item is 1.Default:
0.1- Since:
- 10.2.1.0
-
getJitter
public Jitter getJitter()
Apply a jitter effect for the rendered markers. When plotting discrete values, a little random noise may help telling the points apart. The jitter setting applies a random displacement of up to n axis units in either direction. So for example on a horizontal X axis, setting the jitter.x to 0.24 will render the point in a random position between 0.24 units to the left and 0.24 units to the right of the true axis position. On a category axis, setting it to 0.5 will fill up the bin and make the data appear continuous. When rendered on top of a box plot or a column series, a jitter value of 0.24 will correspond to the underlying series' default groupPadding and pointPadding settings.- Since:
- 10.2.1.0
-
setJitter
public void setJitter(Jitter jitter)
Apply a jitter effect for the rendered markers. When plotting discrete values, a little random noise may help telling the points apart. The jitter setting applies a random displacement of up to n axis units in either direction. So for example on a horizontal X axis, setting the jitter.x to 0.24 will render the point in a random position between 0.24 units to the left and 0.24 units to the right of the true axis position. On a category axis, setting it to 0.5 will fill up the bin and make the data appear continuous. When rendered on top of a box plot or a column series, a jitter value of 0.24 will correspond to the underlying series' default groupPadding and pointPadding settings.- Since:
- 10.2.1.0
-
getInnerSize
public Object getInnerSize()
In circular view, returns the size of the inner diameter of the circle. Can be a percentage or pixel value. Percentages are relative to the outer perimeter. Pixel values are given as integers. If thegetRows()option is set, it overrides the innerSize setting.Default: "40%"
- Since:
- 7.2.1.0
-
setInnerSize
public void setInnerSize(String innerSize)
In circular view, sets the size of the inner diameter of the circle. Can be a percentage. Percentages are relative to the outer perimeter. If thegetRows()option is set, it overrides the innerSize setting.- Since:
- 7.2.1.0
-
getInteractByLeaf
public boolean getInteractByLeaf()
This option decides if the user can interact with the parent nodes or just the leaf nodes. When this option is undefined, it will be true by default. However when allowTraversingTree is true, then it will be false by default.Requires treemap
- Since:
- 10.2.1.0
-
setInteractByLeaf
public void setInteractByLeaf(boolean interactByLeaf)
This option decides if the user can interact with the parent nodes or just the leaf nodes. When this option is undefined, it will be true by default. However when allowTraversingTree is true, then it will be false by default.Requires treemap
- Since:
- 10.2.1.0
-
isInterpolation
public boolean isInterpolation()
Returns the boolean value of interpolated.Make the heatmap render its data points as an interpolated image.
Default: false
- Since:
- 11.2.0.0
-
setInterpolation
public void setInterpolation(boolean interpolation)
Sets the boolean value of interpolated.Make the heatmap render its data points as an interpolated image.
- Since:
- 11.2.0.0
-
setInnerSize
public void setInnerSize(int innerSize)
In circular view, sets the size of the inner diameter of the circle. Can be a pixel value. Pixel values are given as integers. If thegetRows()option is set, it overrides the innerSize setting.
-
getDataLabels
public DataLabels getDataLabels()
Returns the first or single option of data labels.- See Also:
SeriesPlotOptions.getDataLabels()
-
setDataLabels
public void setDataLabels(DataLabels dataLabels)
Sets the first or single option of data labels.- Parameters:
dataLabels-- See Also:
SeriesPlotOptions.setDataLabels(DataLabels)
-
getDataSorting
public DataSorting getDataSorting()
Returns the series data sorting.Default: an instance of DataSoring.
- Since:
- 10.2.1.0
- See Also:
DataSorting
-
setDataSorting
public void setDataSorting(DataSorting dataSorting)
Sets the series data sorting.Default: an instance of DataSoring.
- Since:
- 10.2.1.0
- See Also:
DataSorting
-
getDataLabelsList
public List<DataLabels> getDataLabelsList()
Returns the list of options of data labels.- Since:
- 7.2.2.0
- See Also:
SeriesPlotOptions.getDataLabelsList()
-
setDataLabels
public void setDataLabels(List<DataLabels> dataLabels)
Sets the list of options of data labels.- Since:
- 7.2.2.0
- See Also:
SeriesPlotOptions.setDataLabels(DataLabels)
-
addDataLabels
public void addDataLabels(DataLabels dataLabels)
Add an option of data labels to the list.- Since:
- 7.2.2.0
- See Also:
SeriesPlotOptions.addDataLabels(DataLabels)
-
getDepth
public Number getDepth()
Returns the depth of the 3D chart.Default:
null- Since:
- 10.2.1.0
-
setDepth
public void setDepth(Number depth)
Sets the depth of the 3D chart.Default:
null- Since:
- 10.2.1.0
-
getDescription
public String getDescription()
A description of the series to add to the screen reader information about the series.Default:
null- Since:
- 10.2.1.0
-
setDescription
public void setDescription(String description)
A description of the series to add to the screen reader information about the series.Default:
null- Since:
- 10.2.1.0
-
getDial
public GaugeDialPlotOptions getDial()
Returns options for the dial or arrow pointer of the gauge.Default: an instance of
GaugeDialPlotOptions.- Since:
- 10.2.1.0
-
setDial
public void setDial(GaugeDialPlotOptions dial)
Sets options for the dial or arrow pointer of the gauge.- Since:
- 10.2.1.0
-
isDisplayNegative
public boolean isDisplayNegative()
Returns whether to display negative sized bubbles. The threshold is given by thesetZThreshold(Number)option, and negative bubbles can be visualized by settingsetNegativeColor(String)Default: true
- Since:
- 10.2.1.0
-
setDisplayNegative
public void setDisplayNegative(boolean displayNegative)
Sets whether to display negative sized bubbles. The threshold is given by thesetZThreshold(Number)option, and negative bubbles can be visualized by settingsetNegativeColor(String)Default: true
- Since:
- 10.2.1.0
-
getCollapseButton
public CollapseButton getCollapseButton()
Returns the options applied to collapse Button for treegraph type.- Since:
- 10.3.3.0
-
setCollapseButton
public void setCollapseButton(CollapseButton collapseButton)
Sets the options applied to collapse Button for treegraph type.- Since:
- 10.3.3.0
-
getColor
public Color getColor()
Returns individual color for the series. By default the color is pulled from the globalcolorsarray.Default: null.
-
setColor
public void setColor(Color color)
Sets individual color for the series. By default the color is pulled from the globalcolorsarray.
-
setColor
public void setColor(String color)
Sets individual color for the series. By default the color is pulled from the globalcolorsarray.
-
setColor
public void setColor(LinearGradient color)
Sets individual color for the series. By default the color is pulled from the globalcolorsarray.
-
setColor
public void setColor(RadialGradient color)
Sets individual color for the series. By default the color is pulled from the globalcolorsarray.
-
getColorAxis
public Object getColorAxis()
When using dual or multiple color axes, this defines which colorAxis the particular series is connected to. It refers to either theAxis.getId()or the index of the axis in the colorAxis array, with 0 being the first. Set this option to false to prevent a series from connecting to the default color axis.Default: 0
- Since:
- 7.2.1.0
-
setColorAxis
public void setColorAxis(Number colorAxis)
When using dual or multiple color axes, this defines which colorAxis the particular series is connected to. It refers to the index of the axis in the colorAxis array, with 0 being the first.- Since:
- 7.2.1.0
-
setColorAxis
public void setColorAxis(String colorAxis)
When using dual or multiple color axes, this defines which colorAxis the particular series is connected to. It refers to theAxis.getId().- Since:
- 7.2.1.0
-
setColorAxis
public void setColorAxis(boolean colorAxis)
When using dual or multiple color axes, this defines which colorAxis the particular series is connected to. Set this option to false to prevent a series from connecting to the default color axis.- Since:
- 7.2.1.0
-
getColorKey
public String getColorKey()
Returns what data value should be used to calculate point color if colorAxis is used. Requires to set min and max if some custom point property is used or if approximation for data grouping is set to 'sum'.Default: "y"
- Since:
- 7.2.1.0
-
setColorKey
public void setColorKey(String colorKey)
Sets what data value should be used to calculate point color if colorAxis is used. Requires to set min and max if some custom point property is used or if approximation for data grouping is set to 'sum'.- Since:
- 7.2.1.0
-
isColorByPoint
public boolean isColorByPoint()
Returns whether color by point option is enabled or not
-
setColorByPoint
public void setColorByPoint(boolean colorByPoint)
Sets whether to enable the color by point option or not
-
getColorIndex
public Number getColorIndex()
Returns a specific color index to use for the series, so its graphic representations are given the class name"highcharts-color-{n}".Default: null
- Since:
- 10.2.1.0
-
setColorIndex
public void setColorIndex(Number colorIndex)
Sets a specific color index to use for the series, so its graphic representations are given the class name"highcharts-color-{n}".Default: null
- Since:
- 10.2.1.0
-
getColors
public List<Color> getColors()
Returns a series specific or series type specific color set to apply instead of the globalCharts.getColors()whensetColorByPoint(boolean)is true.- Since:
- 7.2.1.0
-
setColors
public void setColors(List<Color> colors)
Sets a series specific or series type specific color set to apply instead of the globalCharts.getColors()whensetColorByPoint(boolean)is true.- Since:
- 7.2.1.0
-
setColors
public void setColors(String... colors)
Sets a series specific or series type specific color set to apply instead of the globalCharts.getColors()whensetColorByPoint(boolean)is true.- Since:
- 7.2.1.0
-
setColors
public void setColors(Color... colors)
Sets a series specific or series type specific color set to apply instead of the globalCharts.getColors()whensetColorByPoint(boolean)is true.- Since:
- 10.2.1.0
-
getColsize
public Number getColsize()
Returns the column size - how many X axis units each column in the heatmap should span. (Requires heatmap or tilemap)Default: 1
- Since:
- 10.2.1.0
-
setColsize
public void setColsize(Number colsize)
Sets the column size - how many X axis units each column in the heatmap should span. (Requires heatmap or tilemap)Default: 1
- Since:
- 10.2.1.0
-
isConnectEnds
public boolean isConnectEnds()
Returns whether to connect the ends of a line series plot across the extremes. (Polar charts only).Default: false.
- Since:
- 10.2.1.0
-
setConnectEnds
public void setConnectEnds(boolean connectEnds)
Sets whether to connect the ends of a line series plot across the extremes. (Polar charts only).Default: false.
- Since:
- 10.2.1.0
-
isConnectNulls
public boolean isConnectNulls()
Returns whether to connect a graph line across null points, or render a gap between the two points on either side of the null.Default: false.
- Since:
- 10.2.1.0
-
setConnectNulls
public void setConnectNulls(boolean connectNulls)
Sets whether to connect a graph line across null points, or render a gap between the two points on either side of the null.Default: false.
- Since:
- 10.2.1.0
-
getConnectorColor
public String getConnectorColor()
Returns the color of the line that connects the dumbbell point's values. By default it is the series' color.Note: requires dumbbell or lollipop type
Defaults to null.
- Since:
- 10.2.1.0
-
setConnectorColor
public void setConnectorColor(String connectorColor)
Sets the color of the line that connects the dumbbell point's values. By default it is the series' color.Note: requires dumbbell or lollipop type
Defaults to null.
- Since:
- 10.2.1.0
-
getConnectorWidth
public Number getConnectorWidth()
Returns the pixel width of the line that connects the dumbbell point's values.Note: requires dumbbell or lollipop type
Default: 1
- Since:
- 10.2.1.0
-
setConnectorWidth
public void setConnectorWidth(Number connectorWidth)
Sets the pixel width of the line that connects the dumbbell point's values.Note: requires dumbbell or lollipop type
Default: 1
- Parameters:
connectorWidth-- Since:
- 10.2.1.0
-
isCrisp
public boolean isCrisp()
When true, each point or column edge is rounded to its nearest pixel in order to render sharp on screen. In some cases, when there are a lot of densely packed columns, this leads to visible difference in column widths or distance between columns. In these cases, setting crisp to false may look better, even though each column is rendered blurry.Default: true.
- Since:
- 10.2.1.0
-
setCrisp
public void setCrisp(boolean crisp)
When true, each point or column edge is rounded to its nearest pixel in order to render sharp on screen. In some cases, when there are a lot of densely packed columns, this leads to visible difference in column widths or distance between columns. In these cases, setting crisp to false may look better, even though each column is rendered blurry.Default: true.
- Since:
- 10.2.1.0
-
getCropThreshold
public Number getCropThreshold()
When the series contains less points than the crop threshold, all points are drawn, even if the points fall outside the visible plot area at the current zoom. The advantage of drawing all points (including markers and columns), is that animation is performed on updates. On the other hand, when the series contains more points than the crop threshold, the series data is cropped to only contain points that fall within the plot area. The advantage of cropping away invisible points is to increase performance on large series.Defaults to
300.- Since:
- 10.2.1.0
-
setCropThreshold
public void setCropThreshold(Number cropThreshold)
When the series contains less points than the crop threshold, all points are drawn, even if the points fall outside the visible plot area at the current zoom. The advantage of drawing all points (including markers and columns), is that animation is performed on updates. On the other hand, when the series contains more points than the crop threshold, the series data is cropped to only contain points that fall within the plot area. The advantage of cropping away invisible points is to increase performance on large series.Defaults to
300.- Since:
- 10.2.1.0
-
getCurveFactor
public Number getCurveFactor()
Higher numbers makes the links in a sankey diagram or dependency wheelrender more curved. AcurveFactorof 0 makes the lines straight.Default: null. (depends on its implementation)
- Since:
- 10.2.1.0
-
setCurveFactor
public void setCurveFactor(Number curveFactor)
Higher numbers makes the links in a sankey diagram or dependency wheelrender more curved. AcurveFactorof 0 makes the lines straight.Default: null. (depends on its implementation)
- Since:
- 10.2.1.0
-
getCustom
public <K,V> Map<K,V> getCustom()
Returns a reserved subspace to store options and values for customized functionality. Here you can add additional data for your own event callbacks and formatter callbacks.Default: null.
- Since:
- 10.2.1.0
-
setCustom
public <K,V> void setCustom(Map<K,V> custom)
Sets a reserved subspace to store options and values for customized functionality. Here you can add additional data for your own event callbacks and formatter callbacks.Default: null.
- Since:
- 10.2.1.0
-
getCursor
public String getCursor()
Returns you can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.Default: null
- Since:
- 7.2.1.0
-
setCursor
public void setCursor(String cursor)
Sets you can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.- Since:
- 7.2.1.0
-
getDashStyle
public String getDashStyle()
Returns a name for the dash style to use for the graph. Applies only to series type having a graph, likeline,spline,areaandscatterin case it has alineWidth. The value for thedashStyleinclude:- Solid
- ShortDash
- ShortDot
- ShortDashDot
- ShortDashDotDot
- Dot
- Dash
- LongDash
- DashDot
- LongDashDot
- LongDashDotDot
- Since:
- 10.2.1.0
-
setDashStyle
public void setDashStyle(String dashStyle)
Sets a name for the dash style to use for the graph. Applies only to series type having a graph, likeline,spline,areaandscatterin case it has alineWidth. The value for thedashStyleinclude:- Solid
- ShortDash
- ShortDot
- ShortDashDot
- ShortDashDotDot
- Dot
- Dash
- LongDash
- DashDot
- LongDashDot
- LongDashDotDot
- Since:
- 10.2.1.0
-
getDataGrouping
public WindBarbDataGrouping getDataGrouping()
Returns the data grouping options for the wind barbs, if any. Otherwise, create a new one.- Since:
- 10.2.1.0
-
setDataGrouping
public void setDataGrouping(WindBarbDataGrouping dataGrouping)
Sets the data grouping options for the wind barbs.- Since:
- 10.2.1.0
-
isDataAsColumns
public boolean isDataAsColumns()
Indicates data is structured as columns instead of rows.Default: false.
- Since:
- 10.2.1.0
-
setDataAsColumns
public void setDataAsColumns(boolean dataAsColumns)
Indicates data is structured as columns instead of rows.Default: false.
- Since:
- 10.2.1.0
-
getDragDrop
public DragDrop getDragDrop()
Returns the options of the draggable-points module allows points to be moved around or modified in the chart, if any. Otherwise, create a new one. In addition to the options mentioned under the dragDrop API structure, the module fires three events, point.dragStart, point.drag and point.drop.- Since:
- 7.2.1.0
-
setDragDrop
public void setDragDrop(DragDrop dragDrop)
Sets the options of the draggable-points module allows points to be moved around or modified in the chart. In addition to the options mentioned under the dragDrop API structure, the module fires three events, point.dragStart, point.drag and point.drop.- Since:
- 7.2.1.0
-
isDraggable
public boolean isDraggable()
Flag to determine if nodes are draggable or not. (Requires networkgraph or packedbubble)Default:
true- Since:
- 10.2.1.0
-
setDraggable
public void setDraggable(boolean draggable)
Flag to determine if nodes are draggable or not. (Requires networkgraph or packedbubble)Default:
true- Since:
- 10.2.1.0
-
getEdgeColor
public Color getEdgeColor()
3D columns only. The color of the edges. Similar toborderColor, except it defaults to the same color as the column.Default:
null- Since:
- 10.2.1.0
-
setEdgeColor
public void setEdgeColor(Color color)
3D columns only. The color of the edges. Similar toborderColor, except it defaults to the same color as the column.Default:
null- Since:
- 10.2.1.0
-
getEdgeWidth
public Number getEdgeWidth()
3D columns only. Returns the width of the colored edges.Default: 1
- Since:
- 12.2.1.0
-
setEdgeWidth
public void setEdgeWidth(Number edgeWidth)
3D columns only. Sets the width of the colored edges.- Since:
- 12.2.1.0
-
setEdgeColor
public void setEdgeColor(String color)
3D columns only. The color of the edges. Similar toborderColor, except it defaults to the same color as the column.Default:
null- Since:
- 10.2.1.0
-
isEnableMouseTracking
public boolean isEnableMouseTracking()
Returns enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on graphs and points. For large datasets it improves performance.- Since:
- 7.2.1.0
-
setEnableMouseTracking
public void setEnableMouseTracking(boolean enableMouseTracking)
Sets enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on graphs and points. For large datasets it improves performance.- Since:
- 7.2.1.0
-
isEqualNodes
public boolean isEqualNodes()
Returns whether nodes with different values should have the same size. If set to true, all nodes are calculated based on the nodePadding and current plotArea. (Requires arcdiagram)Default:
false.- Since:
- 10.2.1.0
-
setEqualNodes
public void setEqualNodes(boolean equalNodes)
Sets whether nodes with different values should have the same size. If set to true, all nodes are calculated based on the nodePadding and current plotArea. (Requires arcdiagram)- Since:
- 10.2.1.0
-
getEndAngle
public Number getEndAngle()
In circular view, returns the end angle of the item layout, in degrees where 0 is up. Default: null- Since:
- 7.2.1.0
-
setEndAngle
public void setEndAngle(Number endAngle)
In circular view, sets the end angle of the item layout, in degrees where 0 is up.- Since:
- 7.2.1.0
-
getEventsMap
public Map<String,org.zkoss.json.JavaScriptValue> getEventsMap()
Returns general event handlers for the series items.- Since:
- 11.2.0.0
-
setEvents
public void setEvents(Map<String,org.zkoss.json.JavaScriptValue> events)
Sets a map of general event handlers for the series items.- Since:
- 11.2.0.0
-
addEvent
public void addEvent(String name, org.zkoss.json.JavaScriptValue event)
Sets general event handlers for the series items.- Since:
- 11.2.0.0
-
getFillColor
public Color getFillColor()
Returns fill color or gradient for the area. When null, the series' color is used with the series' fillOpacity.Default: null
- Since:
- 7.2.1.0
-
setFillColor
public void setFillColor(Color color)
Sets fill color for the area. When null, the series' color is used with the series' fillOpacity.- Since:
- 7.2.1.0
-
setFillColor
public void setFillColor(String color)
Sets fill color for the area. When null, the series' color is used with the series' fillOpacity.- Since:
- 7.2.1.0
-
setFillColor
public void setFillColor(LinearGradient color)
Sets fill gradient for the area. When null, the series' color is used with the series' fillOpacity.- Since:
- 7.2.1.0
-
setFillColor
public void setFillColor(RadialGradient color)
Sets fill gradient for the area. When null, the series' color is used with the series' fillOpacity.- Since:
- 7.2.1.0
-
getFillOpacity
public Number getFillOpacity()
Returns fill opacity for the area, arearange, areaspline, areasplinerange, bellcurve, and streamgraph.Default: 0.75.
- Since:
- 10.2.1.0
-
setFillOpacity
public void setFillOpacity(Number fillOpacity)
Sets fill opacity for the area, arearange, areaspline, areasplinerange, bellcurve, and streamgraph.- Since:
- 10.2.1.0
-
getFindNearestPointBy
public String getFindNearestPointBy()
Returns whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series. Defaults to 'xy' for scatter series and 'x' for most other series. If the data has duplicate x-values, it is recommended to set this to 'xy' to allow hovering over all points. Applies only to series types using nearest neighbor search (not direct hover) for tooltip.Default: "x"
- Since:
- 10.2.1.0
-
setFindNearestPointBy
public void setFindNearestPointBy(String findNearestPointBy)
Sets whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series. Defaults to 'xy' for scatter series and 'x' for most other series. If the data has duplicate x-values, it is recommended to set this to 'xy' to allow hovering over all points. Applies only to series types using nearest neighbor search (not direct hover) for tooltip.- Since:
- 10.2.1.0
-
isGetExtremesFromAll
public boolean isGetExtremesFromAll()
Returns whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis. By default, the Y axis adjusts to the min and max of the visible data. Cartesian series only.Default: false
- Since:
- 10.2.1.0
-
setGetExtremesFromAll
public void setGetExtremesFromAll(boolean getExtremesFromAll)
Sets whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis. By default, the Y axis adjusts to the min and max of the visible data. Cartesian series only.- Since:
- 10.2.1.0
-
isGradientForSides
public boolean isGradientForSides()
By default sides fill is set to a gradient through this option being set to true. Set to false to get solid color for the sides. (Requires funnel3d or pyramid3d)Default: true
- Since:
- 10.2.1.0
-
setGradientForSides
public void setGradientForSides(boolean gradientForSides)
By default sides fill is set to a gradient through this option being set to true. Set to false to get solid color for the sides. (Requires funnel3d or pyramid3d)- Since:
- 10.2.1.0
-
isGrouping
public boolean isGrouping()
Returns whether to group non-stacked columns or to let them render independent of each other. Non-grouped columns will be laid out individually and overlap each other.Default:
true- Since:
- 10.2.1.0
-
setGrouping
public void setGrouping(boolean grouping)
Sets whether to group non-stacked columns or to let them render independent of each other. Non-grouped columns will be laid out individually and overlap each other.Default:
true- Since:
- 10.2.1.0
-
getGroupPadding
public Number getGroupPadding()
Returns padding between each value groups, in x axis units.Default: 0.2
- Since:
- 10.2.1.0
-
setGroupPadding
public void setGroupPadding(Number groupPadding)
Sets padding between each value groups, in x axis units.- Since:
- 10.2.1.0
-
getGroupZPadding
public Number getGroupZPadding()
Returns the spacing between columns on the Z Axis in a 3D chart.Default: 1
- Since:
- 10.2.1.0
-
setGroupZPadding
public void setGroupZPadding(Number groupZPadding)
Sets the spacing between columns on the Z Axis in a 3D chart.Default: 1
- Since:
- 10.2.1.0
-
getGapSize
public int getGapSize()
-
setGapSize
public void setGapSize(int gapSize)
-
getHangingIndent
public Number getHangingIndent()
Returns the indentation in pixels of hanging nodes, nodes which parent has layout set to hanging. (Requires organization)Default: 20
- Since:
- 10.2.1.0
-
setHangingIndent
public void setHangingIndent(Number hangingIndent)
Sets the indentation in pixels of hanging nodes, nodes which parent has layout set to hanging. (Requires organization)- Since:
- 10.2.1.0
-
getHangingIndentTranslation
public String getHangingIndentTranslation()
Defines the indentation of a hanging layout parent's children. (Requires organization)Possible options:
-
"inherit"(default): Only the first child adds the indentation, children of a child with indentation inherit the indentation. -
"cumulative": All children of a child with indentation add its own indent. The option may cause overlapping of nodes. Then use shrink option: -
"shrink": Nodes shrink by the hangingIndent value until they reach the minNodeLength.
Defaults to
"inherit".- Since:
- 10.2.1.0
-
-
setHangingIndentTranslation
public void setHangingIndentTranslation(String hangingIndentTranslation)
Defines the indentation of a hanging layout parent's children. (Requires organization)Possible options:
-
"inherit"(default): Only the first child adds the indentation, children of a child with indentation inherit the indentation. -
"cumulative": All children of a child with indentation add its own indent. The option may cause overlapping of nodes. Then use shrink option: -
"shrink": Nodes shrink by the hangingIndent value until they reach the minNodeLength.
Defaults to
"inherit".- Since:
- 10.2.1.0
-
-
getHeight
public String getHeight()
Returns the height of the neck, the lower part of a funnel. If it is a number it defines the pixel height, if it is a percentage string it is the percentage of the plot area height. (Requires funnel, funnel3d, pyramid, or pyramid3d)Default: 100%
- Since:
- 10.2.1.0
-
setHeight
public void setHeight(String height)
Sets the height of the neck, the lower part of a funnel. If it is a number it defines the pixel height, if it is a percentage string it is the percentage of the plot area height. (Requires funnel, funnel3d, pyramid, or pyramid3d)Default: 100%
- Since:
- 10.2.1.0
-
getLayout
public String getLayout()
Returns the layout of the items in rectangular view. Can be either horizontal or verticalDefault: "vertical"
- Since:
- 7.2.1.0
-
setLayout
public void setLayout(String layout)
Sets the layout of the items in rectangular view. Can be either horizontal or vertical- Since:
- 7.2.1.0
-
getLayoutAlgorithm
public String getLayoutAlgorithm()
Get the option that decides which algorithm is used for setting position and dimensions of the points. (Requires treemap)Default: "sliceAndDice"
- Returns:
- either "sliceAndDice", "stripes", "squarified", or "strip"
- Since:
- 10.2.1.0
-
setLayoutAlgorithm
public void setLayoutAlgorithm(String layoutAlgorithm)
Set the option decides which algorithm is used for setting position and dimensions of the points. (Requires treemap)- Parameters:
layoutAlgorithm-- Since:
- 10.2.1.0
-
getPackedBubbleLayoutAlgorithm
public PackedBubbleLayoutAlgorithm getPackedBubbleLayoutAlgorithm()
Return options for layout algorithm when simulation is enabled, if any. Otherwise, create a new one. (Requires packedbubble type)- Since:
- 10.2.1.0
-
setLayoutAlgorithm
public void setLayoutAlgorithm(PackedBubbleLayoutAlgorithm layoutAlgorithm)
Sets options for layout algorithm when simulation is enabled. for packedbubble type- Since:
- 10.2.1.0
-
getNetworkGraphLayoutAlgorithm
public NetworkGraphLayoutAlgorithm getNetworkGraphLayoutAlgorithm()
Return options for layout algorithm for networkgraph type, if any. Otherwise, create a new one. (Requires networkgraph type)- Since:
- 10.2.1.0
-
setLayoutAlgorithm
public void setLayoutAlgorithm(NetworkGraphLayoutAlgorithm layoutAlgorithm)
Sets options for layout algorithm for networkgraph type- Since:
- 10.2.1.0
-
getLayoutStartingDirection
public String getLayoutStartingDirection()
Defines which direction the layout algorithm will start drawing. (Requires treemap)Default: "vertical"
- Returns:
- either "vertical" or "horizontal
- Since:
- 10.2.1.0
-
setLayoutStartingDirection
public void setLayoutStartingDirection(String layoutStartingDirection)
Set which direction the layout algorithm will start drawing. (Requires treemap)Possible values are "vertical" and "horizontal".
- Parameters:
layoutStartingDirection-- Since:
- 10.2.1.0
- See Also:
getLayoutStartingDirection()
-
setLegendIndex
public void setLegendIndex(int legendIndex)
Sets the sequential index of the series in the legend.
-
getLegendIndex
public int getLegendIndex()
Returns the sequential index of the series in the legend.
-
isLevelIsConstant
public boolean isLevelIsConstant()
Used together with the levels and allowDrillToNode options. When set to false the first level visible when drilling is considered to be level one. Otherwise the level will be the same as the tree structure. (Requires treemap or sunburst)Defaults to true.
- Since:
- 10.2.1.0
-
setLevelIsConstant
public void setLevelIsConstant(boolean levelIsConstant)
Used together with the levels and allowDrillToNode options. When set to false the first level visible when drilling is considered to be level one. Otherwise the level will be the same as the tree structure. (Requires treemap or sunburst)Defaults to true.
- Since:
- 10.2.1.0
-
getLevels
public List<Level> getLevels()
Returns options on specific levels. Takes precedence over series options, but not node and link options.Default: null
- Since:
- 10.2.1.0
-
setLevels
public void setLevels(List<Level> levels)
Set options on specific levels. Takes precedence over series options,- Since:
- 10.2.1.0 but not node and link options.
-
setLevels
public void setLevels(Level... levels)
Set options on specific levels. Takes precedence over series options, but not node and link options.- Since:
- 10.2.1.0
-
getLevelSize
public LevelSize getLevelSize()
Returns options of determining the width of the ring per level, if any. Otherwise, create a new one. (Requires sunburst)- Since:
- 10.2.1.0
-
setLevelSize
public void setLevelSize(LevelSize levelSize)
Sets options of determining the width of the ring per level. (Requires sunburst)- Since:
- 10.2.1.0
-
getLinecap
public String getLinecap()
Returns the line cap used for line ends and line joins on the graph.Default:
"round"- Since:
- 10.2.1.0
-
setLinecap
public void setLinecap(String linecap)
Sets the line cap used for line ends and line joins on the graph.- Since:
- 10.2.1.0
-
getLineColor
public Color getLineColor()
Returns a separate color for the graph line. By default the line takes thecolorof the series, but the lineColor setting allows setting a separate color for the line without altering thefillColor.Default: null.
- Since:
- 10.2.1.0
-
setLineColor
public void setLineColor(Color color)
Sets a separate color for the graph line. By default the line takes thecolorof the series, but the lineColor setting allows setting a separate color for the line without altering thefillColor.- Since:
- 10.2.1.0
-
setLineColor
public void setLineColor(String color)
Sets a separate color for the graph line. By default the line takes thecolorof the series, but the lineColor setting allows setting a separate color for the line without altering thefillColor.- Since:
- 10.2.1.0
-
setLineColor
public void setLineColor(LinearGradient color)
Sets a separate color for the graph line. By default the line takes thecolorof the series, but the lineColor setting allows setting a separate color for the line without altering thefillColor.- Since:
- 10.2.1.0
-
setLineColor
public void setLineColor(RadialGradient color)
Sets a separate color for the graph line. By default the line takes thecolorof the series, but the lineColor setting allows setting a separate color for the line without altering thefillColor.- Since:
- 10.2.1.0
-
getLineWidth
public Number getLineWidth()
Returns the width of the point marker's outline.Default: 2
-
setLineWidth
public void setLineWidth(Number lineWidth)
Sets the width of the point marker's outline.Default: 2
-
getLink
public NetworkGraphLink getLink()
Returns the link style options, if any. Otherwise, create a new one.- Since:
- 7.2.1.0
-
setLink
public void setLink(NetworkGraphLink link)
Sets the link style options.- Since:
- 7.2.1.0
-
getTreeGraphLink
public TreeGraphLink getTreeGraphLink()
Returns the tree graph link style options, if any. Otherwise, create a new one.- Since:
- 10.3.3.0
-
setTreeGraphLink
public void setTreeGraphLink(TreeGraphLink link)
Sets the tree graph link style options.- Since:
- 10.3.3.0
-
getLinkColor
public Color getLinkColor()
Returns the color of the links between nodes.(Requires organization)Default: #666666
- Since:
- 10.2.1.0
-
setLinkColor
public void setLinkColor(Color linkColor)
Sets the color of the links between nodes.(Requires organization)- Since:
- 10.2.1.0
-
setLinkColor
public void setLinkColor(String linkColor)
Sets the color of the links between nodes. (Requires organization)- Since:
- 10.2.1.0
-
getLinkedTo
public String getLinkedTo()
Returns the id of another series to link to. Additionally, the value can be ":previous" to link to the previous series. When two series are linked, only the first one appears in the legend. Toggling the visibility of this also toggles the linked series. If master series uses data sorting and linked series does not have its own sorting definition, the linked series will be sorted in the same order as the master one.Default: null.
- Since:
- 7.2.2.0
-
setLinkedTo
public void setLinkedTo(String linkedTo)
Sets the id of another series to link to. Additionally, the value can be ":previous" to link to the previous series. When two series are linked, only the first one appears in the legend. Toggling the visibility of this also toggles the linked series. If master series uses data sorting and linked series does not have its own sorting definition, the linked series will be sorted in the same order as the master one.- Since:
- 7.2.2.0
-
getLinkLineWidth
public Number getLinkLineWidth()
Returns the line width of the links connecting nodes, in pixels.(Requires organization)Default: 1
- Since:
- 10.2.1.0
-
setLinkLineWidth
public void setLinkLineWidth(Number linkLineWidth)
Sets the line width of the links connecting nodes, in pixels. (Requires organization)- Since:
- 10.2.1.0
-
getLinkOpacity
public Number getLinkOpacity()
Returns linkOpacity on all points which lay on the same level. (Requires arcdiagram or sankey)Default:
0.5- Since:
- 10.2.1.0
-
setLinkOpacity
public void setLinkOpacity(Number linkOpacity)
Sets linkOpacity on all points which lay on the same level. (Requires arcdiagram or sankey)- Since:
- 10.2.1.0
-
getLinkRadius
public Number getLinkRadius()
Returns radius for the rounded corners of the links between nodes. (Requires organization)Default: 10
- Since:
- 10.2.1.0
-
setLinkRadius
public void setLinkRadius(Number linkRadius)
Sets radius for the rounded corners of the links between nodes. (Requires organization)- Since:
- 10.2.1.0
-
getLinkWeight
public Number getLinkWeight()
The global link weight. If not set, width is calculated per link, depending on the weight value. (Requires arcdiagram)Defaults to
null.- Since:
- 10.2.1.0
-
setLinkWeight
public void setLinkWeight(Number linkWeight)
The global link weight. If not set, width is calculated per link, depending on the weight value. (Requires arcdiagram)Defaults to
null.- Since:
- 10.2.1.0
-
getLowColor
public Color getLowColor()
Returns color of the start markers in a dumbbell graph.Default:
"#333333".- Since:
- 10.2.1.0
-
setLowColor
public void setLowColor(Color color)
Sets color of the start markers in a dumbbell graph.Default:
"#333333".- Since:
- 10.2.1.0
-
setLowColor
public void setLowColor(String color)
Sets color of the start markers in a dumbbell graph.Default:
"#333333".- Since:
- 10.2.1.0
-
setLowColor
public void setLowColor(LinearGradient color)
Sets color of the start markers in a dumbbell graph.Default:
"#333333".- Since:
- 10.2.1.0
-
setLowColor
public void setLowColor(RadialGradient color)
Sets color of the start markers in a dumbbell graph.Default:
"#333333".- Since:
- 10.2.1.0
-
getLowMarker
public LowMarker getLowMarker()
Returns options for the lower markers of the dumbbell-like series. When lowMarker is not defined, options inherit form the marker.- Since:
- 11.2.0.0
-
setLowMarker
public void setLowMarker(LowMarker lowMarker)
Sets options for the lower markers of the dumbbell-like series. When lowMarker is not defined, options inherit form the marker.- Since:
- 11.2.0.0
-
getMarker
public Marker getMarker()
Returns the marker for this series.
-
setMarker
public void setMarker(Marker marker)
Sets the marker for this series.
-
getMaxFontSize
public Number getMaxFontSize()
Returns the word with the largest weight will have a font size equal to this value. The font size of a word is the ratio between its weight and the largest occurring weight, multiplied with the value of maxFontSize. (Requires wordcloud)Default: 25
- Since:
- 10.2.1.0
-
setMaxFontSize
public void setMaxFontSize(Number maxFontSize)
Sets the word with the largest weight will have a font size equal to this value. The font size of a word is the ratio between its weight and the largest occurring weight, multiplied with the value of maxFontSize. (Requires wordcloud)- Since:
- 10.2.1.0
-
getMaxPointSize
public Object getMaxPointSize()
Returns the maximum size of the points' radius related to chart's plotArea. If a number is set, it applies in pixels. (Requires variablepie)Default: "100%"
- Since:
- 10.2.1.0
-
setMaxPointSize
public void setMaxPointSize(Number maxPointSize)
Sets the maximum size of the points' radius related to chart's plotArea. If a number is set, it applies in pixels. (Requires variablepie)- Since:
- 10.2.1.0
-
getMaxPointWidth
public Number getMaxPointWidth()
Returns the maximum allowed pixel width for a column, translated to the height of a bar in a bar chart. This prevents the columns from becoming too wide when there is a small number of points in the chart.Default: null
- Since:
- 10.2.1.0
-
setMaxPointWidth
public void setMaxPointWidth(Number maxPointWidth)
Sets the maximum allowed pixel width for a column, translated to the height of a bar in a bar chart. This prevents the columns from becoming too wide when there is a small number of points in the chart.- Since:
- 10.2.1.0
-
getMaxSize
public Object getMaxSize()
Returns maximum bubble size. Bubbles will automatically size between the minSize and maxSize to reflect the z value of each bubble. Can be either pixels (when no unit is given), or a percentage of the smallest one of the plot width and height.Default: "20%"
- Since:
- 7.2.1.0
-
setMaxSize
public void setMaxSize(Number maxSize)
Sets maximum bubble size. Bubbles will automatically size between the minSize and maxSize to reflect the z value of each bubble. Can be pixels (when no unit is given).- Since:
- 7.2.1.0
-
setMaxSize
public void setMaxSize(String maxSize)
Sets maximum bubble size. Bubbles will automatically size between the minSize and maxSize to reflect the z value of each bubble. Can be a percentage of the smallest one of the plot width and height.- Since:
- 7.2.1.0
-
getMedianColor
public String getMedianColor()
Returns the color of the median line. Ifnull, the general series color applies. (Require boxplot)Default:
null- Since:
- 10.2.1.0
-
setMedianColor
public void setMedianColor(String medianColor)
Sets the color of the median line. Ifnull, the general series color applies. 'medianColor the color of the median line. Ifnull, the general series color applies. (Require boxplot)Default:
null- Since:
- 10.2.1.0
-
setMedianColor
public void setMedianColor(Color medianColor)
Sets the color of the median line. Ifnull, the general series color applies. 'medianColor the color of the median line. Ifnull, the general series color applies. (Require boxplot)Default:
null- Since:
- 10.2.1.0
-
setMedianColor
public void setMedianColor(LinearGradient medianColor)
Sets the color of the median line. Ifnull, the general series color applies. 'medianColor the color of the median line. Ifnull, the general series color applies. (Require boxplot)Default:
null- Since:
- 10.2.1.0
-
setMedianColor
public void setMedianColor(RadialGradient medianColor)
Sets the color of the median line. Ifnull, the general series color applies. 'medianColor the color of the median line. Ifnull, the general series color applies. (Require boxplot)Default:
null- Since:
- 10.2.1.0
-
getMedianDashStyle
public String getMedianDashStyle()
Returns a name for the dash style of the median. (Requires boxplot) The value for themedianDashStyleinclude:- Solid
- ShortDash
- ShortDot
- ShortDashDot
- ShortDashDotDot
- Dot
- Dash
- LongDash
- DashDot
- LongDashDot
- LongDashDotDot
Default:
"Solid"- Since:
- 10.2.1.0
-
setMedianDashStyle
public void setMedianDashStyle(String medianDashStyle)
Sets a name for the dash style of the median. (Requires boxplot) The value for themedianDashStyleinclude:- Solid
- ShortDash
- ShortDot
- ShortDashDot
- ShortDashDotDot
- Dot
- Dash
- LongDash
- DashDot
- LongDashDot
- LongDashDotDot
- Since:
- 10.2.1.0
-
getMedianWidth
public Number getMedianWidth()
Returns the pixel width of the median line. Ifnull, thesetLineWidth(Number)is used. (Requires boxplot)Default: 2
- Since:
- 10.2.1.0
-
setMedianWidth
public void setMedianWidth(Number medianWidth)
Sets the pixel width of the median line. Ifnull, thesetLineWidth(Number)is used. (Requires boxplot)Default: 2
- Since:
- 10.2.1.0
-
getMinFontSize
public Number getMinFontSize()
Returns a threshold determining the minimum font size that can be applied to a word. (Requires wordcloud)Default: 1
- Since:
- 10.2.1.0
-
setMinFontSize
public void setMinFontSize(Number minFontSize)
Sets a threshold determining the minimum font size that can be applied to a word. (Requires wordcloud)- Since:
- 10.2.1.0
-
getMinLinkWidth
public Number getMinLinkWidth()
Returns the minimal width for a line of a sankey. By default, 0 values are not shown. (Requires arcdiagram or sankey)Default: 0
- Since:
- 10.2.1.0
-
setMinLinkWidth
public void setMinLinkWidth(Number minLinkWidth)
Sets the minimal width for a line of a sankey. By default, 0 values are not shown. (Requires arcdiagram or sankey)- Since:
- 10.2.1.0
-
getMinNodeLength
public Number getMinNodeLength()
In a horizontal chart, the minimum width of the hanging nodes only, in pixels. In a vertical chart, the minimum height of the hanging nodes only, in pixels too. (Requires organization)Note: Used only when
getHangingIndentTranslation()is set to {@code "shrink").Defaults to {@code 10}.
- Since:
- 10.2.1.0
-
setMinNodeLength
public void setMinNodeLength(Number minNodeLength)
In a horizontal chart, the minimum width of the hanging nodes only, in pixels. In a vertical chart, the minimum height of the hanging nodes only, in pixels too. (Requires organization)Note: Used only when
getHangingIndentTranslation()is set to {@code "shrink").Defaults to {@code 10}.
- Since:
- 10.2.1.0
-
getMinPointLength
public Number getMinPointLength()
Returns the minimal height for a column or width for a bar. By default, 0 values are not shown. To visualize a 0 (or close to zero) point, set the minimal point length to a pixel value like 3. In stacked column charts, minPointLength might not be respected for tightly packed values.Default: 0
- Since:
- 10.2.1.0
-
setMinPointLength
public void setMinPointLength(Number minPointLength)
Sets the minimal height for a column or width for a bar. By default, 0 values are not shown. To visualize a 0 (or close to zero) point, set the minimal point length to a pixel value like 3. In stacked column charts, minPointLength might not be respected for tightly packed values.- Since:
- 10.2.1.0
-
getMinPointSize
public Object getMinPointSize()
Returns the minimum size of the points' radius related to chart's plotArea. If a number is set, it applies in pixels. (Requires variablepie)Default:
"10%"- Since:
- 10.2.1.0
-
setMinPointSize
public void setMinPointSize(Number minPointSize)
Sets the minimum size of the points' radius related to chart's plotArea. If a number is set, it applies in pixels. (Requires variablepie)- Since:
- 10.2.1.0
-
getMinSize
public Object getMinSize()
Returns the minimum size.- Since:
- 7.2.1.0
-
setMinSize
public void setMinSize(Number minSize)
Sets the minimum size.- Since:
- 7.2.1.0
-
setMinSize
public void setMinSize(String minSize)
Sets the minimum size.- Since:
- 7.2.1.0
-
setName
public void setName(String name)
Sets the name of the series as shown in the legend, tooltip etc.
-
getNeckHeight
public String getNeckHeight()
Returns the height of the neck, the lower part of the funnel. A number defines pixel width, a percentage string defines a percentage of the plot area height. (Requires funnel)- Since:
- 10.2.1.0
-
setNeckHeight
public void setNeckHeight(String neckHeight)
Sets the height of the neck, the lower part of the funnel. A number defines pixel width, a percentage string defines a percentage of the plot area height. (Requires funnel)- Since:
- 10.2.1.0
-
getNeckWidth
public String getNeckWidth()
Returns the width of the neck, the lower part of the funnel. A number defines pixel width, a percentage string defines a percentage of the plot area width. (Requires funnel)- Since:
- 10.2.1.0
-
setNeckWidth
public void setNeckWidth(String neckWidth)
Sets the width of the neck, the lower part of the funnel. A number defines pixel width, a percentage string defines a percentage of the plot area width. (Requires funnel)- Since:
- 10.2.1.0
-
getNegativeColor
public Color getNegativeColor()
Returns the color for the parts of the graph or points that are below thesetThreshold(Number).Defaults to null.
- Since:
- 10.2.1.0
-
setNegativeColor
public void setNegativeColor(Color color)
Sets the color for the parts of the graph or points that are below thesetThreshold(Number).Defaults to null.
- Since:
- 10.2.1.0
-
setNegativeColor
public void setNegativeColor(String color)
Sets the color for the parts of the graph or points that are below thesetThreshold(Number).Defaults to null.
- Since:
- 10.2.1.0
-
setNegativeColor
public void setNegativeColor(LinearGradient color)
Sets the color for the parts of the graph or points that are below thesetThreshold(Number).Defaults to null.
- Since:
- 10.2.1.0
-
setNegativeColor
public void setNegativeColor(RadialGradient color)
Sets the color for the parts of the graph or points that are below thesetThreshold(Number).Defaults to null.
- Since:
- 10.2.1.0
-
getNegativeFillColor
public Color getNegativeFillColor()
Returns a separate color for the negative part of the area.Default: null.
- Since:
- 10.2.1.0
-
setNegativeFillColor
public void setNegativeFillColor(Color color)
Sets a separate color for the negative part of the area.Default: null.
- Since:
- 10.2.1.0
-
setNegativeFillColor
public void setNegativeFillColor(String color)
Sets a separate color for the negative part of the area.Default: null.
- Since:
- 10.2.1.0
-
setNegativeFillColor
public void setNegativeFillColor(LinearGradient color)
Sets a separate color for the negative part of the area.Default: null.
- Since:
- 10.2.1.0
-
setNegativeFillColor
public void setNegativeFillColor(RadialGradient color)
Sets a separate color for the negative part of the area.Default: null.
- Since:
- 10.2.1.0
-
getOnPoint
public OnPoint getOnPoint()
Returns the Series on point feature. Onlypieandsunburstseries are supported at this moment.Default: an instance of OnPoint
- Since:
- 10.2.1.0
- See Also:
OnPoint
-
setOnPoint
public void setOnPoint(OnPoint onPoint)
Sets the Series on point feature. Onlypieandsunburstseries are supported at this moment.Default: an instance of OnPoint
- Since:
- 10.2.1.0
- See Also:
OnPoint
-
getNodeWidth
public Number getNodeWidth()
Returns the pixel width of each node in a sankey diagram or dependency wheel, or the height in case the chart is inverted. (Requires arcdiagram or sankey)- Since:
- 10.2.1.0
-
setNodeWidth
public void setNodeWidth(String nodeWidth)
Sets the pixel width of each node in a sankey diagram or dependency wheel, or the height in case the chart is inverted. (Requires arcdiagram or sankey)- Since:
- 10.2.1.0
-
setNodeWidth
public void setNodeWidth(Number nodeWidth)
Sets the pixel width of each node in a sankey diagram or dependency wheel, or the height in case the chart is inverted. (Requires arcdiagram or sankey)- Since:
- 10.2.1.0
-
getNullColor
public Color getNullColor()
Returns the color applied to null points. (Requires heatmap)Default:
"#f7f7f7".- Since:
- 10.2.1.0
-
setNullColor
public void setNullColor(Color color)
Sets the color applied to null points. (Requires heatmap)- Since:
- 10.2.1.0
-
setNullColor
public void setNullColor(String color)
Sets the color applied to null points. (Requires heatmap)- Since:
- 11.2.0.0
-
setNullColor
public void setNullColor(LinearGradient color)
Sets the color applied to null points. (Requires heatmap)- Since:
- 11.2.0.0
-
setNullColor
public void setNullColor(RadialGradient color)
Sets the color applied to null points. (Requires heatmap)- Since:
- 11.2.0.0
-
getOffset
public String getOffset()
Returns the offset of an arc diagram nodes column in relation to theplotArea. The offset equal to 50% places nodes in the center of a chart. By default the series is placed so that the biggest node is touching the bottom border of theplotArea. (Requires arcdiagram)Default:
"100%"- Since:
- 10.2.1.0
-
setOffset
public void setOffset(String offset)
Sets the offset of an arc diagram nodes column in relation to theplotArea. The offset equal to 50% places nodes in the center of a chart. By default the series is placed so that the biggest node is touching the bottom border of theplotArea. (Requires arcdiagram)Default:
"100%"- Since:
- 10.2.1.0
-
getOnSeries
public String getOnSeries()
Returns the id of another series in the chart that the wind barbs are projected on. When null, the wind symbols are drawn on the X axis, but offset up or down by the yOffset setting.Default: null
- Since:
- 7.2.1.0
-
setOnSeries
public void setOnSeries(String onSeries)
Sets the id of another series in the chart that the wind barbs are projected on. When null, the wind symbols are drawn on the X axis, but offset up or down by the yOffset setting.- Since:
- 7.2.1.0
-
getOpacity
public Number getOpacity()
Returns opacity of a series parts: line, fill (e.g. area) and dataLabels.Default: 1
- Since:
- 10.2.1.0
-
setOpacity
public void setOpacity(Number opacity)
Sets opacity of a series parts: line, fill (e.g. area) and dataLabels.- Since:
- 10.2.1.0
-
getOvershoot
public Number getOvershoot()
Returns the amount of degrees that are allowed to overshoot (Requires gauge) Default:null
-
setOvershoot
public void setOvershoot(Number overshoot)
Sets the amount of degrees that are allowed to overshoot (Requires gauge)
-
getParentNode
public PackedBubbleParentNode getParentNode()
Returns series options for parent nodes.Default: an instance of
PackedBubbleParentNode- Since:
- 10.2.1.0
-
setParentNode
public void setParentNode(PackedBubbleParentNode parentNode)
Sets series options for parent nodes.- Since:
- 10.2.1.0
-
getPartialFill
public XRangePartialFill getPartialFill()
Returns a partial fill for each point, if any. Otherwise, create a new one. Typically used to visualize how much of a task is performed. The partial fill object can be set either on series or point level.- Since:
- 10.2.1.0
-
setPartialFill
public void setPartialFill(XRangePartialFill partialFill)
Sets a partial fill for each point. Typically used to visualize how much of a task is performed. The partial fill object can be set either on series or point level.- Since:
- 10.2.1.0
-
setPartialFill
public void setPartialFill(Number amount)
Sets a partial fill with an amount for each point. Typically used to visualize how much of a task is performed. The partial fill object can be set either on series or point level.- Since:
- 10.2.1.0
-
getPivot
public GaugePivotPlotOptions getPivot()
Returns options for the pivot or the center point of the gauge.Default: an instance of
GaugePivotPlotOptions.- Since:
- 10.2.1.0
-
setPivot
public void setPivot(GaugePivotPlotOptions pivot)
Sets options for the pivot or the center point of the gauge.- Since:
- 10.2.1.0
-
getPlacementStrategy
public String getPlacementStrategy()
Returns which algorithm is used for placement, and rotation of a word. The choice of algorithm is therefore a crucial part of the resulting layout of the wordcloud. It is possible for users to add their own custom placement strategies for use in word cloud. Read more about it in documentation.Default:
"center"- Since:
- 10.2.1.0
-
setPlacementStrategy
public void setPlacementStrategy(String placementStrategy)
Sets which algorithm is used for placement, and rotation of a word. The choice of algorithm is therefore a crucial part of the resulting layout of the wordcloud. It is possible for users to add their own custom placement strategies for use in word cloud. Read more about it in documentation.- Since:
- 10.2.1.0
-
getPointDescriptionFormatter
public org.zkoss.json.JavaScriptValue getPointDescriptionFormatter()
Returns the formatter function to use instead of the default for series descriptions. Receives one argument, series, referring to the series to describe. Should return a string with the description of the series for a screen reader user. If false is returned, the default formatter will be used for that series.Default: null.
- Since:
- 10.2.1.0
-
setPointDescriptionFormatter
public void setPointDescriptionFormatter(org.zkoss.json.JavaScriptValue pointDescriptionFormatter)
Sets the formatter function to use instead of the default for series descriptions. Receives one argument, series, referring to the series to describe. Should return a string with the description of the series for a screen reader user. If false is returned, the default formatter will be used for that series.Default: null.
- Since:
- 10.2.1.0
-
getPointInterval
public Number getPointInterval()
Returns the point interval of the series. Default: null
-
setPointInterval
public void setPointInterval(Number pointInterval)
Sets the point interval of the series.
-
getPointIntervalUnit
public String getPointIntervalUnit()
On datetime series, this allows for setting the pointInterval to the two irregular time units, month and year. Combine it with pointInterval to draw quarters, 6 months, 10 years etc.Default: null
- Since:
- 2.1.0
-
setPointIntervalUnit
public void setPointIntervalUnit(String pointIntervalUnit)
Set the irregular time unit for point interval, only "day", "month", or "year" is allowed.- Parameters:
pointIntervalUnit- "day", "month", or "year"- Since:
- 2.1.0
-
getPointPadding
public Number getPointPadding()
Returns the padding between each column or bar, in x axis units. Default: 0.1
-
setPointPadding
public void setPointPadding(Number pointPadding)
Sets the padding between each column or bar, in x axis units.
-
getPointPlacement
public Object getPointPlacement()
Returns the point placement.Possible values: null, "on", "between" or numeric.
In a column chart, when pointPlacement is "on", the point will not create any padding of the X axis. In a polar column chart this means that the first column points directly north. If the pointPlacement is "between", the columns will be laid out between ticks. This is useful for example for visualising an amount between two points in time or in a certain sector of a polar chart.
The point placement can also be numeric, where 0 is on the axis value, -0.5 is between this value and the previous, and 0.5 is between this value and the next. Unlike the textual options, numeric point placement options won't affect axis padding.
Defaults to
nullin cartesian charts,"between"in polar charts.
-
setPointPlacement
public void setPointPlacement(String pointPlacement)
Sets the point placement.Possible values: null, "on", "between".
In a column chart, when pointPlacement is "on", the point will not create any padding of the X axis. In a polar column chart this means that the first column points directly north. If the pointPlacement is "between", the columns will be laid out between ticks. This is useful for example for visualising an amount between two points in time or in a certain sector of a polar chart.
Defaults to
nullin cartesian charts,"between"in polar charts.
-
setPointPlacement
public void setPointPlacement(Number pointPlacement)
Sets the point placement with a numberThe point placement can also be numeric, where 0 is on the axis value, -0.5 is between this value and the previous, and 0.5 is between this value and the next. Unlike the textual options, numeric point placement options won't affect axis padding.
-
getPointsInInterval
public Number getPointsInInterval()
Returns how many points should be plotted within 1 interval. See plotOptions.bellcurve.intervals. Requires bellcurve.Default: 3
- Since:
- 7.2.1.0
-
setPointsInInterval
public void setPointsInInterval(Number pointsInInterval)
Sets how many points should be plotted within 1 interval. See plotOptions.bellcurve.intervals. Requires bellcurve.- Since:
- 7.2.1.0
-
getPointStart
public Number getPointStart()
If no x values are given for the points in a series, pointStart defines on what value to start. For example, if a series contains one yearly value starting from 1945, set pointStart to 1945. Requires bellcurve.Default: 0
- Since:
- 7.2.1.0
-
setPointStart
public void setPointStart(Number pointStart)
If no x values are given for the points in a series, pointStart defines on what value to start. For example, if a series contains one yearly value starting from 1945, set pointStart to 1945. Requires bellcurve.- Since:
- 7.2.1.0
-
getPointRange
public Number getPointRange()
Default: null- Since:
- 7.2.1.0
-
setPointRange
public void setPointRange(Number pointRange)
- Since:
- 7.2.1.0
-
getPointWidth
public Number getPointWidth()
Returns a pixel value specifying a fixed width for each column or bar. Whennull, the width is calculated from thepointPaddingandgroupPadding.Default: null
- Since:
- 10.2.1.0
-
setPointWidth
public void setPointWidth(Number pointWidth)
Sets a pixel value specifying a fixed width for each column or bar. Whennull, the width is calculated from thepointPaddingandgroupPadding.- Since:
- 10.2.1.0
-
getRadius
public Object getRadius()
Returns the outer radius for points in a solid gauge. Can be given as a number (pixels) or percentage string.Default:
100- Since:
- 10.2.1.0
-
setRadius
public void setRadius(Number radius)
Sets the outer radius for points in a solid gauge. Can be given as a number (pixels).- Since:
- 10.2.1.0
-
setRadius
public void setRadius(String radius)
Sets the outer radius for points in a solid gauge. Can be given as a percentage string.- Since:
- 10.2.1.0
-
isRelativeXValue
public boolean isRelativeXValue()
When true, X values in the data set are relative to the currentpointStart,pointIntervalandpointIntervalUnitsettings. This allows compression of the data for datasets with irregular X values.The real X values are computed on the formula
f(x) = ax + b, whereais thepointInterval(optionally with a time unit given bypointIntervalUnit), andbis thepointStart.Defaults to
false.- Since:
- 10.2.1.0
-
setRelativeXValue
public void setRelativeXValue(boolean relativeXValue)
When true, X values in the data set are relative to the currentpointStart,pointIntervalandpointIntervalUnitsettings. This allows compression of the data for datasets with irregular X values.The real X values are computed on the formula
f(x) = ax + b, whereais thepointInterval(optionally with a time unit given bypointIntervalUnit), andbis thepointStart.Defaults to
false.- Since:
- 10.2.1.0
-
getName
public String getName()
Returns the name of the series as shown in the legend, tooltip etc.
-
getNodePadding
public Number getNodePadding()
Returns the padding between nodes in a sankey diagram or dependency wheel, in pixels.Default:
10- Since:
- 10.2.1.0
-
setNodePadding
public void setNodePadding(Number nodePadding)
Sets the padding between nodes in a sankey diagram or dependency wheel, in pixels.- Since:
- 10.2.1.0
-
getNodesSize
public int getNodesSize()
Returns the size of nodes.- Since:
- 7.2.1.0
-
getNodes
public Node getNodes()
Returns the Node options, if any. Otherwise, create a new one.Returns the first node (index 0) by default.
- Since:
- 7.2.1.0
- See Also:
Node,getNodes(int)
-
getNodes
public Node getNodes(int index)
Returns the Node options from the given index, if any. Otherwise, create a new one.- Since:
- 7.2.1.0
- See Also:
Node
-
isReversed
public boolean isReversed()
Returns whether the series should be placed on the other side of the plotArea. (Requires arcdiagram or funnel)Default:
false.- Since:
- 10.2.1.0
-
setReversed
public void setReversed(boolean reversed)
Sets whether the series should be placed on the other side of the plotArea. (Requires arcdiagram or funnel)- Since:
- 10.2.1.0
-
getRootId
public String getRootId()
Returns which point to use as a root in the visualization. (Requires sunburst)Default: null
- Since:
- 10.2.1.0
-
setRootId
public void setRootId(String rootId)
Sets which point to use as a root in the visualization. (Requires sunburst)- Since:
- 10.2.1.0
-
getRotation
public WordCloudRotation getRotation()
Returns the rotation options for the words in the wordcloud, if any. Otherwise, create a new one.- Since:
- 10.2.1.0
-
setRotation
public void setRotation(WordCloudRotation rotation)
Sets the rotation options for the words in the wordcloud.- Since:
- 10.2.1.0
-
isRounded
public boolean isRounded()
Returns whether to draw rounded edges on the gauge. (Requires solidgauge)Default:
false- Since:
- 10.2.1.0
-
setRounded
public void setRounded(boolean rounded)
Sets whether to draw rounded edges on the gauge. (Requires solidgauge)- Since:
- 10.2.1.0
-
getRows
public Number getRows()
Returns the number of rows to display in the rectangular or circular view. If thegetInnerSize()is set, it will be overridden by the rows setting.Default: null
- Since:
- 7.2.1.0
-
setRows
public void setRows(Number rows)
Sets the number of rows to display in the rectangular or circular view. If thegetInnerSize()is set, it will be overridden by the rows setting.- Since:
- 7.2.1.0
-
getRowsize
public Number getRowsize()
Returns the row size - how many Y axis units each heatmap row should span.Default: 1.
- Returns:
- row size - how many Y axis units each heatmap row should span.
- Since:
- 10.2.1.0
-
setRowsize
public void setRowsize(Number rowsize)
Sets the row size - how many Y axis units each heatmap row should span.- Since:
- 10.2.1.0
-
isSelected
public boolean isSelected()
Returns whether to select the series initially. IfshowCheckboxis true, the checkbox next to the series name will be checked for a selected series.Default:
false- Since:
- 10.2.1.0
-
setSelected
public void setSelected(boolean selected)
Sets whether to select the series initially. IfshowCheckboxis true, the checkbox next to the series name will be checked for a selected series.Default:
false- Since:
- 10.2.1.0
-
getShadow
public Object getShadow()
Returns the Shadow object or boolean value of shadow, depend on what was set. To apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containingcolor,offsetX,offsetY,opacityandwidth.- Since:
- 11.2.0.0
-
isShadow
public boolean isShadow()
Returns whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containingcolor,offsetX,offsetY,opacityandwidth.Default:
false- Since:
- 10.2.1.0
-
setShadow
public void setShadow(boolean shadow)
Sets whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containingcolor,offsetX,offsetY,opacityandwidth.Default:
false- Since:
- 10.2.1.0
-
setShadow
public void setShadow(Shadow shadow)
Sets whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containingcolor,offsetX,offsetY,opacityandwidth.- Since:
- 11.2.0.0
-
isShowCheckbox
public boolean isShowCheckbox()
Returns if true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by theselectedoption.Default:
false- Since:
- 10.2.1.0
-
setShowCheckbox
public void setShowCheckbox(boolean showCheckbox)
Sets if true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by theselectedoption.Default:
false- Since:
- 10.2.1.0
-
isShowInLegend
public boolean isShowInLegend()
Returns whether to display this particular series or series type in the legend. Standalone series are shown in legend by default, and linked series are not. It is possible to show series that use colorAxis by setting this option to true.Default: true
- Since:
- 7.2.1.0
-
setShowInLegend
public void setShowInLegend(boolean showInLegend)
Sets whether to display this particular series or series type in the legend. Standalone series are shown in legend by default, and linked series are not. It is possible to show series that use colorAxis by setting this option to true.- Since:
- 7.2.1.0
-
getSize
public Object getSize()
Returns the diameter of the pie relative to the plot area. Can be a percentage or pixel value. Pixel values are given as integers. The default behaviour is to scale to the plot area and give room for data labels within the plot area. slicedOffset is also included in the default size calculation. As a consequence, the size of the pie may vary when points are updated and data labels more around. In that case it is best to set a fixed value, for example "75%".Default: null
- Since:
- 7.2.1.0
-
setSize
public void setSize(Number size)
Sets the diameter of the pie relative to the plot area. Can be a percentage or pixel value. Pixel values are given as integers. The default behaviour is to scale to the plot area and give room for data labels within the plot area. slicedOffset is also included in the default size calculation. As a consequence, the size of the pie may vary when points are updated and data labels more around. In that case it is best to set a fixed value, for example "75%".- Since:
- 7.2.1.0
-
setSize
public void setSize(String size)
Sets the diameter of the pie relative to the plot area. Can be a percentage or pixel value. Pixel values are given as integers. The default behaviour is to scale to the plot area and give room for data labels within the plot area. slicedOffset is also included in the default size calculation. As a consequence, the size of the pie may vary when points are updated and data labels more around. In that case it is best to set a fixed value, for example "75%".- Since:
- 7.2.1.0
-
getSizeBy
public String getSizeBy()
Returns what the plot area value should be represented by. The default, area, corresponds best to the human perception of the size of each area.Default: "area"
- Since:
- 7.2.1.0
-
setSizeBy
public void setSizeBy(String sizeBy)
Sets what the plot area value should be represented by.- Since:
- 7.2.1.0
-
isSizeByAbsoluteValue
public boolean isSizeByAbsoluteValue()
When this is true, the absolute value of z determines the size of the bubble. This means that with the default zThreshold of 0, a bubble of value -1 will have the same size as a bubble of value 1, while a bubble of value 0 will have a smaller size according to minSize.Defaults to
false.- Since:
- 10.2.1.0
-
setSizeByAbsoluteValue
public void setSizeByAbsoluteValue(boolean sizeByAbsoluteValue)
When this is true, the absolute value of z determines the size of the bubble. This means that with the default zThreshold of 0, a bubble of value -1 will have the same size as a bubble of value 1, while a bubble of value 0 will have a smaller size according to minSize.Defaults to
false.- Since:
- 10.2.1.0
-
isSkipKeyboardNavigation
public boolean isSkipKeyboardNavigation()
If set to true, the accessibility module will skip past the points in this series for keyboard navigation.Default: false
- Since:
- 10.2.1.0
-
setSkipKeyboardNavigation
public void setSkipKeyboardNavigation(boolean skipKeyboardNavigation)
If set to true, the accessibility module will skip past the points in this series for keyboard navigation.- Since:
- 10.2.1.0
-
getSlicedOffset
public Number getSlicedOffset()
Returns if a point is sliced, moved out from the center, how many pixels should it be moved?Default: 10
- Since:
- 10.2.1.0
-
setSlicedOffset
public void setSlicedOffset(Number slicedOffset)
Sets if a point is sliced, moved out from the center, how many pixels should it be moved?- Since:
- 10.2.1.0
-
isSoftThreshold
public boolean isSoftThreshold()
When this is true, the series will not cause the Y axis to cross the zero plane (or threshold option) unless the data actually crosses the plane. For example, if softThreshold is false, a series of 0, 1, 2, 3 will make the Y axis show negative values according to the minPadding option. If softThreshold is true, the Y axis starts at 0.Default: true
- Since:
- 10.2.1.0
-
setSoftThreshold
public void setSoftThreshold(boolean softThreshold)
When this is true, the series will not cause the Y axis to cross the zero plane (or threshold option) unless the data actually crosses the plane. For example, if softThreshold is false, a series of 0, 1, 2, 3 will make the Y axis show negative values according to the minPadding option. If softThreshold is true, the Y axis starts at 0.- Since:
- 10.2.1.0
-
getSonification
public SeriesSonification getSonification()
Returns the Sonification/audio chart options for a series.- Since:
- 11.2.0.0
-
setSonification
public void setSonification(SeriesSonification sonification)
Sets the Sonification/audio chart options for a series.- Since:
- 11.2.0.0
-
getSortIndex
public Number getSortIndex()
Returns the sort index of the point inside the treemap level.Default:
null- Since:
- 10.2.1.0
-
setSortIndex
public void setSortIndex(Number sortIndex)
Sets the sort index of the point inside the treemap level.Default:
null- Since:
- 10.2.1.0
-
getSpiral
public String getSpiral()
Returns the spiral used for placing a word after the initial position experienced a collision with either another word or the borders. It is possible for users to add their own custom spiralling algorithms for use in word cloud. Read more about it in documentation.Default:
"rectangular"- Since:
- 10.2.1.0
-
setSpiral
public void setSpiral(String spiral)
Sets the spiral used for placing a word after the initial position experienced a collision with either another word or the borders. It is possible for users to add their own custom spiralling algorithms for use in word cloud. Read more about it in documentation.- Since:
- 10.2.1.0
-
setStack
public void setStack(String stack)
Sets the option allows grouping series in a stacked chart. The stack option can be a string or a number or anything else, as long as the grouped series' stack options match each other.
-
setStack
public void setStack(Number stack)
Sets the option allows grouping series in a stacked chart. The stack option can be a string or a number or anything else, as long as the grouped series' stack options match each other.
-
getStack
public Object getStack()
Returns the option allows grouping series in a stacked chart. The stack option can be a string or a number or anything else, as long as the grouped series' stack options match each other.
-
getStacking
public String getStacking()
Returns whether to stack the values of each series on top of each other. Possible values are null to disable, "normal" to stack by value or "percent".- Since:
- 10.2.1.0
-
isStacking
public boolean isStacking()
Returns whether to stack the values of each series on top of each other or not.- Since:
- 10.2.1.0
-
setStacking
public void setStacking(String stacking)
Sets whether to stack the values of each series on top of each other. Possible values are null to disable, "normal" to stack by value or "percent".- Since:
- 10.2.1.0
-
setStacking
public void setStacking(Boolean stacking)
Sets whether to stack the values of each series on top of each other. Possible values are null to disable, "normal" to stack by value or "percent".- Since:
- 10.2.1.0
-
getStartAngle
public Number getStartAngle()
In circular view, returns the start angle of the item layout, in degrees where 0 is up. Default: null- Since:
- 7.2.1.0
-
setStartAngle
public void setStartAngle(Number startAngle)
In circular view, sets the start angle of the item layout, in degrees where 0 is up.- Since:
- 7.2.1.0
-
getStates
public States getStates()
Returns a wrapper object for all the series options in specific states.Default: an instance of
States- Since:
- 10.2.1.0
-
setStates
public void setStates(States states)
Sets a wrapper object for all the series options in specific states.- Since:
- 10.2.1.0
-
getStemDashStyle
public String getStemDashStyle()
Returns the dash style of the stem, the vertical line extending from the box to the whiskers. (Requires boxplot)- Since:
- 10.2.1.0
-
setStemDashStyle
public void setStemDashStyle(String stemDashStyle)
Sets the dash style of the stem, the vertical line extending from the box to the whiskers. (Requires boxplot)- Since:
- 10.2.1.0
-
getStemWidth
public Number getStemWidth()
Returns the width of the stem, the vertical line extending from the box to the whiskers. Ifnull, the width is inherited from thesetLineWidth(Number)option. (Requires boxplot)- Since:
- 10.2.1.0
-
setStemWidth
public void setStemWidth(Number stemWidth)
Sets the width of the stem, the vertical line extending from the box to the whiskers. Ifnull, the width is inherited from thesetLineWidth(Number)option. (Requires boxplot)- Since:
- 10.2.1.0
-
getStep
public String getStep()
Returns whether to apply steps to the line. Possible values areleft,centerandright.Default: null
- Since:
- 10.2.1.0
-
setStep
public void setStep(String step)
Sets whether to apply steps to the line. Possible values areleft,centerandright.- Since:
- 10.2.1.0
-
isStickyTracking
public boolean isStickyTracking()
Returns sticky tracking of mouse events. When true, themouseOutevent on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, themouseOutevent on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. WhenstickyTrackingis false andTooltip.isShared()is false, the tooltip will be hidden when moving the mouse between series. Defaults to true for line and area type series, but to false for columns, pies etc.Default:
false- Since:
- 10.2.1.0
-
setStickyTracking
public void setStickyTracking(boolean stickyTracking)
Sets sticky tracking of mouse events. When true, themouseOutevent on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, themouseOutevent on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. WhenstickyTrackingis false andTooltip.isShared()is false, the tooltip will be hidden when moving the mouse between series. Defaults to true for line and area type series, but to false for columns, pies etc.- Since:
- 10.2.1.0
-
getStyle
public <K,V> Map<K,V> getStyle()
Returns CSS styles for the words. (Requires wordcloud)Default: "fontFamily: 'sans-serif'; fontWeight: 900"
- Type Parameters:
K- type for the keyif style was set using
setStyle(String), type will be Stringif style was set using
setStyle(Map), type will be the same as the type from the key of the mapif style was not set, default style will be applied, and type will be String
V- type for the valueif style was set using
setStyle(String), type will be Stringif style was set using
setStyle(Map), type will be the same as the type from the key of the mapif style was not set, default style will be applied, and type will be String
- Since:
- 10.2.1.0
-
setStyle
public void setStyle(String style)
Sets CSS styles for the words. (Requires wordcloud)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)- Parameters:
style- one or many CSS key:value pairs in a single line string format- Since:
- 10.2.1.0
-
setStyle
public <K,V> void setStyle(Map<K,V> style)
Sets CSS styles for the words. (Requires wordcloud)This method allows complex styling like:
which will generate the final results 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);{ "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" } }- Type Parameters:
K- Type for the key, usually StringV- Type for the value, usually String. For nested maps, use Object or any other type.- Parameters:
style- the style object- Since:
- 10.2.1.0
-
getTargetOptions
public TargetOptions getTargetOptions()
Returns all options related with look and position of targets, if any. Otherwise, create a new one.- Since:
- 7.2.1.0
-
setTargetOptions
public void setTargetOptions(TargetOptions targetOptions)
Sets all options related with look and position of targets.- Since:
- 7.2.1.0
-
getThickness
public Number getThickness()
Returns thickness describing the ring size for a donut type chart, overridinggetInnerSize(). (Requires pie or item)Default:
null- Since:
- 10.2.1.0
-
setThickness
public void setThickness(Number thickness)
Sets thickness describing the ring size for a donut type chart, overridinggetInnerSize(). (Requires pie or item)Default:
null- Since:
- 10.2.1.0
-
getThreshold
public Number getThreshold()
Returns the threshold, also called zero level or base level. For line type series this is only used in conjunction withnegativeColor.Default:
0- Since:
- 10.2.1.0
-
setThreshold
public void setThreshold(Number threshold)
Sets the threshold, also called zero level or base level. For line type series this is only used in conjunction withnegativeColor.Default:
0- Since:
- 10.2.1.0
-
getTileShape
public String getTileShape()
Returns the shape of the tiles in the tilemap. Possible values arehexagon,circle,diamond, andsquare.Default:
"hexagon"- Since:
- 10.2.1.0
-
setTileShape
public void setTileShape(String tileShape)
Sets the shape of the tiles in the tilemap. Possible values arehexagon,circle,diamond, andsquare.- Since:
- 10.2.1.0
-
getTooltip
public Tooltip getTooltip()
Returns the tooltip options.
-
setTooltip
public void setTooltip(Tooltip tooltip)
Sets the tooltip options.
-
getTrackByArea
public boolean getTrackByArea()
Returns whether the whole area or just the line should respond to mouseover tooltips and other mouse or touch events.Default: false.
- Since:
- 10.2.1.0
-
setTrackByArea
public void setTrackByArea(boolean trackByArea)
Sets whether the whole area or just the line should respond to mouseover tooltips and other mouse or touch events.- Since:
- 10.2.1.0
-
getTraverseUpButton
public TraverseUpButton getTraverseUpButton()
Returns options for the button appearing when traversing down in a treemap, if any. Otherwise, create a new one. (Requires treemap or sunburst)- Since:
- 10.2.1.0
-
setTraverseUpButton
public void setTraverseUpButton(TraverseUpButton traverseUpButton)
Sets options for the button appearing when traversing down in a treemap. (Requires treemap or sunburst)- Since:
- 10.2.1.0
-
getTurboThreshold
public Number getTurboThreshold()
Returns when a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed. Also, only the first point is tested, and the rest are assumed to be the same format. This saves expensive data checking and indexing in long series. Set it to0disable.- Since:
- 10.2.1.0
-
setTurboThreshold
public void setTurboThreshold(Number turboThreshold)
Sets when a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed. Also, only the first point is tested, and the rest are assumed to be the same format. This saves expensive data checking and indexing in long series. Set it to0disable.- Since:
- 10.2.1.0
-
setType
public void setType(String type)
The type of series. Can be one of area, areaspline, bar, column, line, pie, scatter, spline, arearange, areasplinerange and columnrange.
-
getType
public String getType()
The type of series. Can be one of area, areaspline, bar, column, line, pie, scatter, spline, arearange, areasplinerange and columnrange.
-
getUpColor
public Color getUpColor()
Returns the color of up point in a waterfall series. series.Default: null
- Since:
- 10.2.1.0
-
setUpColor
public void setUpColor(Color color)
Sets the color of up point in a waterfall series.- Since:
- 10.2.1.0
-
isUseSimulation
public boolean isUseSimulation()
Returns an option is giving a possibility to choose between using simulation for calculating bubble positions. These reflects in both animation and final position of bubbles. Simulation is also adding options to the series graph based on used layout. In case of big data sets, with any performance issues, it is possible to disable animation and pack bubble in a simple circular way.Default:
true- Since:
- 10.2.1.0
-
setUseSimulation
public void setUseSimulation(boolean useSimulation)
Sets an option is giving a possibility to choose between using simulation for calculating bubble positions. These reflects in both animation and final position of bubbles. Simulation is also adding options to the series graph based on used layout. In case of big data sets, with any performance issues, it is possible to disable animation and pack bubble in a simple circular way.- Since:
- 10.2.1.0
-
getVectorLength
public Number getVectorLength()
Returns the pixel length of the stems. (Requires windbarb)Default:
20- Since:
- 10.2.1.0
-
setVectorLength
public void setVectorLength(Number vectorLength)
Sets the pixel length of the stems. (Requires windbarb)- Since:
- 10.2.1.0
-
getWhiskerColor
public Color getWhiskerColor()
Returns the color of the whiskers, the horizontal lines marking low and high values. Whennull, the general series color is used. (Requires boxplot)Default: null
- Since:
- 10.2.1.0
-
setWhiskerColor
public void setWhiskerColor(Color color)
Sets the color of the whiskers, the horizontal lines marking low and high values. Whennull, the general series color is used. (Requires boxplot)- Since:
- 10.2.1.0
-
setWhiskerColor
public void setWhiskerColor(String color)
Sets the color of the whiskers, the horizontal lines marking low and high values. Whennull, the general series color is used. (Requires boxplot)- Since:
- 10.2.1.0
-
setWhiskerColor
public void setWhiskerColor(LinearGradient color)
Sets the color of the whiskers, the horizontal lines marking low and high values. Whennull, the general series color is used. (Requires boxplot)- Since:
- 10.2.1.0
-
setWhiskerColor
public void setWhiskerColor(RadialGradient color)
Sets the color of the whiskers, the horizontal lines marking low and high values. Whennull, the general series color is used. (Requires boxplot)- Since:
- 10.2.1.0
-
getWhiskerDashStyle
public String getWhiskerDashStyle()
Returns the dash style of the whisker.Note: requires boxplot or errorbar type
Defaults to Solid.
- Since:
- 10.2.1.
-
setWhiskerDashStyle
public void setWhiskerDashStyle(String whiskerDashStyle)
Sets the dash style of the whisker.Note: requires boxplot or errorbar type
Defaults to Solid.
- Since:
- 10.2.1.
-
getWhiskerLength
public String getWhiskerLength()
Returns the length of the whiskers, the horizontal lines marking low and high values. It can be a numerical pixel value, or a percentage value of the box width. Set0to disable whiskers. (Requires boxplot)Default:
"50%"- Since:
- 10.2.1.0
-
setWhiskerLength
public void setWhiskerLength(String whiskerLength)
Sets the length of the whiskers, the horizontal lines marking low and high values. It can be a numerical pixel value, or a percentage value of the box width. Set0to disable whiskers. (Requires boxplot)- Since:
- 10.2.1.0
-
setWhiskerLength
public void setWhiskerLength(Number whiskerLength)
Sets the length of the whiskers, the horizontal lines marking low and high values. It can be a numerical pixel value, or a percentage value of the box width. Set0to disable whiskers. (Requires boxplot)- Since:
- 10.2.1.0
-
getWhiskerWidth
public Number getWhiskerWidth()
Returns the line width of the whiskers, the horizontal lines marking low and high values. Whennull, the generalsetLineWidth(Number)applies. (Requires boxplot)Default:
2- Since:
- 10.2.1.0
-
setWhiskerWidth
public void setWhiskerWidth(Number whiskerWidth)
Sets the line width of the whiskers, the horizontal lines marking low and high values. Whennull, the generalsetLineWidth(Number)applies. (Requires boxplot)- Since:
- 10.2.1.0
-
getWidth
public String getWidth()
Returns the width of the funnel compared to the width of the plot area, or the pixel width if it is a number. (Requires funnel)Default:
"90%"- Since:
- 10.2.1.0
-
setWidth
public void setWidth(String width)
Sets the width of the funnel compared to the width of the plot area, or the pixel width if it is a number. (Requires funnel)- Since:
- 10.2.1.0
-
isWrap
public boolean isWrap()
Returns when this option istrue, the dial will wrap around the axes. For instance, in a full-range gauge going from 0 to 360, a value of 400 will point to 40. Whenwrapisfalse, the dial stops at 360. (Requires gauge)Default: true.
- Since:
- 10.2.1.0
-
setWrap
public void setWrap(boolean wrap)
Sets when this option istrue, the dial will wrap around the axes. For instance, in a full-range gauge going from 0 to 360, a value of 400 will point to 40. Whenwrapisfalse, the dial stops at 360. (Requires gauge)- Since:
- 10.2.1.0
-
setXAxis
public void setXAxis(int xAxis)
When using dual or multiple x axes, this number defines which xAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the xAxis array, with 0 being the first. Defaults to 0.
-
setXAxis
public void setXAxis(String xAxis)
When using dual or multiple x axes, this number defines which xAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the xAxis array, with 0 being the first. Defaults to 0.
-
getXAxis
public Object getXAxis()
When using dual or multiple x axes, this number defines which xAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the xAxis array, with 0 being the first. Defaults to 0.
-
setYAxis
public void setYAxis(int yAxis)
When using dual or multiple y axes, this number defines which yAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the yAxis array, with 0 being the first. Defaults to 0.
-
setYAxis
public void setYAxis(String yAxis)
When using dual or multiple y axes, this number defines which yAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the yAxis array, with 0 being the first. Defaults to 0.
-
getYAxis
public Object getYAxis()
When using dual or multiple y axes, this number defines which yAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the yAxis array, with 0 being the first. Defaults to 0.
-
getXOffset
public Number getXOffset()
Returns horizontal offset from the cartesian position, in pixels. When the chart is inverted, this option allows translation like yOffset in non inverted charts. (Requires windbarb)Default:
0- Since:
- 10.2.1.0
-
setXOffset
public void setXOffset(Number xOffset)
Sets horizontal offset from the cartesian position, in pixels. When the chart is inverted, this option allows translation like yOffset in non inverted charts. (Requires windbarb)- Since:
- 10.2.1.0
-
getYOffset
public Number getYOffset()
Returns vertical offset from the cartesian position, in pixels. The default value makes sure the symbols don't overlap the X axis when onSeries is null, and that they don't overlap the linked series when onSeries is given. (Requires windbarb)Default:
-20- Since:
- 10.2.1.0
-
setYOffset
public void setYOffset(Number yOffset)
Sets vertical offset from the cartesian position, in pixels. The default value makes sure the symbols don't overlap the X axis when onSeries is null, and that they don't overlap the linked series when onSeries is given. (Requires windbarb)- Since:
- 10.2.1.0
-
setZIndex
public void setZIndex(int zIndex)
Define the visual z index of the series.
-
getZIndex
public int getZIndex()
Define the visual z index of the series.
-
getZMax
public Number getZMax()
Returns the maximum for the Z value range. Defaults to the highest Z value in the data. (Requires bubble and variablepie)Default: null
- Since:
- 10.2.1.0
-
setZMax
public void setZMax(Number zMax)
Sets the maximum for the Z value range. (Requires bubble and variablepie)- Since:
- 10.2.1.0
-
getZMin
public Number getZMin()
Returns the minimum for the Z value range. Defaults to the lowest Z value in the data. (Requires bubble and variablepie)Default:
null- Since:
- 10.2.1.0
-
setZMin
public void setZMin(Number zMin)
Sets the minimum for the Z value range. (Requires bubble and variablepie)- Since:
- 10.2.1.0
-
getZoneAxis
public String getZoneAxis()
Defines the Axis on which the zones are applied.- Returns:
- the zone axis or the default value "y"
- Since:
- 2.1.0
-
setZoneAxis
public void setZoneAxis(String zoneAxis)
Set the axis on which the zones are applied. Only X, Y, or Z axis are supported.- Parameters:
zoneAxis- either "x", "y", or "z"- Since:
- 2.1.0
-
getZones
public List<Zone> getZones()
An list defining zones within a series. Zones can be applied to the X axis, Y axis or Z axis for bubbles, according to the zoneAxis option.- Since:
- 2.1.0
- See Also:
Zone
-
setZones
public void setZones(List<Zone> zones)
Set the zones within a series.- Since:
- 2.1.0
- See Also:
getZones(),Zone
-
getKeys
public List<String> getKeys()
Returns an array specifying which option maps to which key in the data point array. This makes it convenient to work with unstructured data arrays from different sources.Defaults: null.
- Since:
- 10.2.1.0
-
setKeys
public void setKeys(List<String> keys)
Returns an array specifying which option maps to which key in the data point array. This makes it convenient to work with unstructured data arrays from different sources.Defaults: null.
- Since:
- 10.2.1.0
-
setKeys
public void setKeys(String... keys)
Returns an array specifying which option maps to which key in the data point array. This makes it convenient to work with unstructured data arrays from different sources.Defaults: null.
- Since:
- 10.2.1.0
-
getLabel
public SeriesLabel getLabel()
Returns series label options, if any. Otherwise, create a new one. Series labels are placed as close to the series as possible in a natural way, seeking to avoid other series. The goal of this feature is to make the chart more easily readable, like if a human designer placed the labels in the optimal position. The series labels currently work with series types having a graph or an area.- Since:
- 10.2.1.0
-
setLabel
public void setLabel(SeriesLabel label)
Sets series label options. Series labels are placed as close to the series as possible in a natural way, seeking to avoid other series. The goal of this feature is to make the chart more easily readable, like if a human designer placed the labels in the optimal position. The series labels currently work with series types having a graph or an area.- Since:
- 10.2.1.0
-
getZThreshold
public Number getZThreshold()
Returns whensetDisplayNegative(boolean)isfalse, bubbles with lower Z values are skipped. WhendisplayNegativeistrueand asetNegativeColor(String)is given, points with lower Z is colored.Default: 0
- Since:
- 10.2.1.0
-
setZThreshold
public void setZThreshold(Number zThreshold)
Sets whensetDisplayNegative(boolean)isfalse, bubbles with lower Z values are skipped. WhendisplayNegativeistrueand asetNegativeColor(String)is given, points with lower Z is colored.- Since:
- 10.2.1.0
-
hide
public void hide()
Hides the series if visible. If theChart.isIgnoreHiddenSeries()option is true,the chart is redrawn without this series.
-
isVisible
public boolean isVisible()
Returns whether the series is visible or not.Default: true
-
setVisible
public void setVisible(boolean visible)
Sets whether the series is visible.
-
setVisibleDirectly
public boolean setVisibleDirectly(boolean visible)
Sets whether the series is visible directly.
-
show
public void show()
Shows the series if hidden.
-
remove
public void remove()
-
select
public void select()
-
onChange
public void onChange(OptionDataEvent event)
Description copied from interface:OptionDataListenerSent when the contents of the chart option has changed.- Specified by:
onChangein interfaceOptionDataListener- Overrides:
onChangein classOptionable
-
toJSONString
public String toJSONString()
Description copied from class:OptionableEncodes this object to a JSON string. It is the same asOptionable.toString().- Specified by:
toJSONStringin interfaceorg.zkoss.json.JSONAware- Overrides:
toJSONStringin classOptionable
-
-