Method Details

• getChartType

  public ChartType getChartType()

  Overrides:

  getChartType in class AbstractPlotOptions

• getAllowPointSelect

  public Boolean getAllowPointSelect()

  See Also:

  • setAllowPointSelect(Boolean)

• setAllowPointSelect

  public void setAllowPointSelect(Boolean allowPointSelect)

  Allow this series' points to be selected by clicking on the markers, bars or pie slices.

  Defaults to: false

• getAnimation

  public Boolean getAnimation()

  See Also:

  • setAnimation(Boolean)

• setAnimation

  public void setAnimation(Boolean animation)

  Enable or disable 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 ChartModel.setAnimation(Boolean)

• getAnimationLimit

  public Number getAnimationLimit()

  See Also:

  • setAnimationLimit(Number)

• 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 doesn't run if there is more than 250 points totally. To disable this cap, set animationLimit to Infinity.

• getBorderColor

  public Color getBorderColor()

  See Also:

  • setBorderColor(Color)

• setBorderColor

  public void setBorderColor(Color borderColor)

  The color of the border surrounding each column or bar.

  In styled mode, the border stroke can be set with the .highcharts-point rule.

  Defaults to: #ffffff

• getBorderRadius

  public Number getBorderRadius()

  See Also:

  • setBorderRadius(Number)

• setBorderRadius

  public void setBorderRadius(Number borderRadius)

  The corner radius of the border surrounding each column or bar.

  Defaults to: 0

• getBorderWidth

  public Number getBorderWidth()

  See Also:

  • setBorderWidth(Number)

• setBorderWidth

  public void setBorderWidth(Number borderWidth)

  The width of the border surrounding each column or bar.

  In styled mode, the stroke width can be set with the .highcharts-point rule.

  Defaults to: 1

• getClassName

  public String getClassName()

  See Also:

  • setClassName(String)

• setClassName

  public void setClassName(String className)

  A class name to apply to the series' graphical elements.

• getColor

  public Color getColor()

  See Also:

  • setColor(Color)

• setColor

  public void setColor(Color color)

  The main color or the series. In line type series it applies to the line and the point markers unless otherwise specified. In bar type series it applies to the bars unless a color is specified per point. The default value is pulled from the options.colors array.

  In styled mode, the color can be defined by the colorIndex option. Also, the series color can be set with the .highcharts-series, .highcharts-color-{n}, .highcharts-{type}-series or .highcharts-series-{n} class, or individual classes given by the className option.

• getColorByPoint

  public Boolean getColorByPoint()

  See Also:

  • setColorByPoint(Boolean)

• setColorByPoint

  public void setColorByPoint(Boolean colorByPoint)

  When using automatic point colors pulled from the options.colors collection, this option determines whether the chart should receive one color per series or one color per point.

  Defaults to: false

• getColorIndex

  public Number getColorIndex()

  See Also:

  • setColorIndex(Number)

• setColorIndex

  public void setColorIndex(Number colorIndex)

  Styled mode only. A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.

• getColors

  public Color[] getColors()

  See Also:

  • setColors(Color...)

• setColors

  public void setColors(Color... colors)

  A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.

• addColor

  public void addColor(Color color)

  Adds color to the colors array

  Parameters:

  color - to add

  See Also:

  • setColors(Color...)

• removeColor

  public void removeColor(Color color)

  Removes first occurrence of color in colors array

  Parameters:

  color - to remove

  See Also:

  • setColors(Color...)

• getCursor

  public Cursor getCursor()

  See Also:

  • setCursor(Cursor)

• setCursor

  public void setCursor(Cursor cursor)

  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.

• getDataLabels

  public ArrayList<DataLabels> getDataLabels()

  See Also:

  • setDataLabels(ArrayList)

• setDataLabels

  public void setDataLabels(ArrayList<DataLabels> dataLabels)

  Options for the series data labels, appearing next to each data point.

  In styled mode, the data labels can be styled wtih the .highcharts-data-label-box and .highcharts-data-label class names (see example).

• getDescription

  public String getDescription()

  See Also:

  • setDescription(String)

• setDescription

  public void setDescription(String description)

  Requires Accessibility module

  A description of the series to add to the screen reader information about the series.

  Defaults to: undefined

• getEnableMouseTracking

  public Boolean getEnableMouseTracking()

  See Also:

  • setEnableMouseTracking(Boolean)

• setEnableMouseTracking

  public void setEnableMouseTracking(Boolean enableMouseTracking)

  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.

  Defaults to: true

• getGroupPadding

  public Number getGroupPadding()

  See Also:

  • setGroupPadding(Number)

• setGroupPadding

  public void setGroupPadding(Number groupPadding)

  Padding between each value groups, in x axis units.

  Defaults to: 0.2

• getGrouping

  public Boolean getGrouping()

  See Also:

  • setGrouping(Boolean)

• setGrouping

  public void setGrouping(Boolean grouping)

  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.

  Defaults to: true

• getKeys

  public String[] getKeys()

  See Also:

  • setKeys(String...)

• setKeys

  public void setKeys(String... keys)

  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.

• addKey

  public void addKey(String key)

  Adds key to the keys array

  Parameters:

  key - to add

  See Also:

  • setKeys(String...)

• removeKey

  public void removeKey(String key)

  Removes first occurrence of key in keys array

  Parameters:

  key - to remove

  See Also:

  • setKeys(String...)

• getLinkedTo

  public String getLinkedTo()

  See Also:

  • setLinkedTo(String)

• setLinkedTo

  public void setLinkedTo(String linkedTo)

  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.

• getMaxPointWidth

  public Number getMaxPointWidth()

  See Also:

  • setMaxPointWidth(Number)

• setMaxPointWidth

  public void setMaxPointWidth(Number maxPointWidth)

  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.

  Defaults to: null

• getMinPointLength

  public Number getMinPointLength()

  See Also:

  • setMinPointLength(Number)

• setMinPointLength

  public void setMinPointLength(Number minPointLength)

  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.

  Defaults to: 0

• getPointDescriptionFormatter

  public String getPointDescriptionFormatter()

• setPointDescriptionFormatter

  public void setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)

• getPointPadding

  public Number getPointPadding()

  See Also:

  • setPointPadding(Number)

• setPointPadding

  public void setPointPadding(Number pointPadding)

  Padding between each column or bar, in x axis units.

  Defaults to: 0.1

• getPointWidth

  public Number getPointWidth()

  See Also:

  • setPointWidth(Number)

• setPointWidth

  public void setPointWidth(Number pointWidth)

  A pixel value specifying a fixed width for each column or bar. When null, the width is calculated from the pointPadding and groupPadding.

• getSelected

  public Boolean getSelected()

  See Also:

  • setSelected(Boolean)

• setSelected

  public void setSelected(Boolean selected)

  Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name will be checked for a selected series.

  Defaults to: false

• getShadow

  public Boolean getShadow()

  See Also:

  • setShadow(Boolean)

• setShadow

  public void setShadow(Boolean shadow)

  Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.

  Defaults to: false

• getShowCheckbox

  public Boolean getShowCheckbox()

  See Also:

  • setShowCheckbox(Boolean)

• setShowCheckbox

  public void setShowCheckbox(Boolean showCheckbox)

  If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by the selected option.

  Defaults to: false

• getShowInLegend

  public Boolean getShowInLegend()

  See Also:

  • setShowInLegend(Boolean)

• setShowInLegend

  public void setShowInLegend(Boolean showInLegend)

  Whether to display this particular series or series type in the legend. The default value is true for standalone series, false for linked series.

  Defaults to: true

• getSkipKeyboardNavigation

  public Boolean getSkipKeyboardNavigation()

  See Also:

  • setSkipKeyboardNavigation(Boolean)

• setSkipKeyboardNavigation

  public void setSkipKeyboardNavigation(Boolean skipKeyboardNavigation)

  If set to True, the accessibility module will skip past the points in this series for keyboard navigation.

• getStates

  public States getStates()

  See Also:

  • setStates(States)

• setStates

  public void setStates(States states)

  A wrapper object for all the series options in specific states.

• getStickyTracking

  public Boolean getStickyTracking()

  See Also:

  • setStickyTracking(Boolean)

• setStickyTracking

  public void setStickyTracking(Boolean stickyTracking)

  Sticky tracking of mouse events. When true, the mouseOut event on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, the mouseOut event on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. When stickyTracking is false and tooltip.shared 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.

  Defaults to: true

• getTooltip

  public SeriesTooltip getTooltip()

  See Also:

  • setTooltip(SeriesTooltip)

• setTooltip

  public void setTooltip(SeriesTooltip tooltip)

  A configuration object for the tooltip rendering of each single series. Properties are inherited from tooltip, but only the following properties can be defined on a series level.

• getTurboThreshold

  public Number getTurboThreshold()

  See Also:

  • setTurboThreshold(Number)

• setTurboThreshold

  public void setTurboThreshold(Number turboThreshold)

  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 to 0 disable.

  Defaults to: 1000

• getVisible

  public Boolean getVisible()

  See Also:

  • setVisible(Boolean)

• setVisible

  public void setVisible(Boolean visible)

  Set the initial visibility of the series.

  Defaults to: true

• getCenterInCategory

  public Boolean getCenterInCategory()

  See Also:

  • setCenterInCategory(Boolean)

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

  Defaults to false.

• getClip

  public Boolean getClip()

  See Also:

  • setClip(Boolean)

• 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 zoomType is set

• getDashStyle

  public DashStyle getDashStyle()

  See Also:

  • setDashStyle(DashStyle)

• setDashStyle

  public void setDashStyle(DashStyle dashStyle)

  A name for the dash style to use for the graph. Applies only to series type having a graph, like line, spline, area and scatter in case it has a lineWidth. The value for the dashStyle include:

  • Solid
  • ShortDash
  • ShortDot
  • ShortDashDot
  • ShortDashDotDot
  • Dot
  • Dash
  • LongDash
  • DashDot
  • LongDashDot
  • LongDashDotDot

  Defaults to: Solid

• getOpacity

  public Number getOpacity()

  See Also:

  • setOpacity(Number)

• setOpacity

  public void setOpacity(Number opacity)

  Opacity of a series parts: line, fill (e.g. area) and dataLabels.

  Defaults to 1.

• getPartialFill

  public PartialFill getPartialFill()

  See Also:

  • setPartialFill(PartialFill)

• setPartialFill

  public void setPartialFill(PartialFill partialFill)

  Partial fill configuration for series points, typically used to visualize how much of a task is performed.

• getConnectors

  public SeriesConnectors getConnectors()

  See Also:

  • setConnectors(SeriesConnectors)

• setConnectors

  public void setConnectors(SeriesConnectors connectors)

  Override Pathfinder connector options for a series. Requires Highcharts Gantt to be loaded.

• getCustom

  public AbstractConfigurationObject getCustom()

  See also setCustom(AbstractConfigurationObject)

• setCustom

  public void setCustom(AbstractConfigurationObject custom)

  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.

• getIncludeInDataExport

  public Boolean getIncludeInDataExport()

  See Also:

  • setIncludeInDataExport(Boolean)

• setIncludeInDataExport

  public void setIncludeInDataExport(Boolean includeInDataExport)

  When set to false will prevent the series data from being included in any form of data export.

  Parameters:

  includeInDataExport -

• getDragDrop

  public DragDrop getDragDrop()

  See Also:

  • setDragDrop(DragDrop)

• setDragDrop

  public void setDragDrop(DragDrop dragDrop)

  The DragDrop options allows points to be moved around or modified in the chart. In addition to the options mentioned under the dragDrop API structure, the chart fires three events: dragStart, drag and drop.

  Parameters:

  dragDrop -

  See Also:

  • Chart.addPointDragStartListener(ComponentEventListener)
  • Chart.addPointDragListener(ComponentEventListener)
  • Chart.addPointDropListener(ComponentEventListener)