Method Details

• getChartType

  public ChartType getChartType()

  Overrides:

  getChartType in class AbstractPlotOptions

• getAllowDrillToNode

  public Boolean getAllowDrillToNode()

  See Also:

  • setAllowDrillToNode(Boolean)

• setAllowDrillToNode

  public void setAllowDrillToNode(Boolean allowDrillToNode)

  When enabled the user can click on a point which is a parent and zoom in on its children.

  Defaults to: false

• 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

• getAlternateStartingDirection

  public Boolean getAlternateStartingDirection()

  See Also:

  • setAlternateStartingDirection(Boolean)

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

  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 tree map item.

  Defaults to: #e6e6e6

• 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 of the series. In heat maps this color is rarely used, as we mostly use the color to denote the value of each point. Unless options are set in the colorAxis, the default value is pulled from the options.colors array.

  Defaults to: null

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

• getCrisp

  public Boolean getCrisp()

  See Also:

  • setCrisp(Boolean)

• setCrisp

  public void setCrisp(Boolean crisp)

  When true, each 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.

  Defaults to: true

• getCropThreshold

  public Number getCropThreshold()

  See Also:

  • setCropThreshold(Number)

• setCropThreshold

  public void setCropThreshold(Number cropThreshold)

  When the series contains less points than the crop threshold, all points are drawn, event 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

• 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 DataLabels getDataLabels()

  See Also:

  • setDataLabels(DataLabels)

• setDataLabels

  public void setDataLabels(DataLabels dataLabels)

• 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

• getExposeElementToA11y

  public Boolean getExposeElementToA11y()

  See Also:

  • setExposeElementToA11y(Boolean)

• setExposeElementToA11y

  public void setExposeElementToA11y(Boolean exposeElementToA11y)

  By default, series are exposed to screen readers as regions. By enabling this option, the series element itself will be exposed in the same way as the data points. This is useful if the series is not used as a grouping entity in the chart, but you still want to attach a description to the series.

  Requires the Accessibility module.

  Defaults to: undefined

• getFindNearestPointBy

  public Dimension getFindNearestPointBy()

  See Also:

  • setFindNearestPointBy(Dimension)

• setFindNearestPointBy

  public void setFindNearestPointBy(Dimension findNearestPointBy)

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

• getGetExtremesFromAll

  public Boolean getGetExtremesFromAll()

  See Also:

  • setGetExtremesFromAll(Boolean)

• setGetExtremesFromAll

  public void setGetExtremesFromAll(Boolean getExtremesFromAll)

  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.

  Defaults to: false

• getIgnoreHiddenPoint

  public Boolean getIgnoreHiddenPoint()

  See Also:

  • setIgnoreHiddenPoint(Boolean)

• setIgnoreHiddenPoint

  public void setIgnoreHiddenPoint(Boolean ignoreHiddenPoint)

  Whether to ignore hidden points when the layout algorithm runs. If false, hidden points will leave open spaces.

  Defaults to: true

• getInteractByLeaf

  public Boolean getInteractByLeaf()

  See Also:

  • setInteractByLeaf(Boolean)

• 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 allowDrillToNode is true, then it will be false by default.

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

• getLayoutAlgorithm

  public TreeMapLayoutAlgorithm getLayoutAlgorithm()

  See Also:

  • setLayoutAlgorithm(TreeMapLayoutAlgorithm)

• setLayoutAlgorithm

  public void setLayoutAlgorithm(TreeMapLayoutAlgorithm layoutAlgorithm)

  This option decides which algorithm is used for setting position and dimensions of the points. Can be one of sliceAndDice, stripes, squarified or strip.

  Defaults to: sliceAndDice

• getLayoutStartingDirection

  public TreeMapLayoutStartingDirection getLayoutStartingDirection()

  See Also:

  • setLayoutStartingDirection(TreeMapLayoutStartingDirection)

• setLayoutStartingDirection

  public void setLayoutStartingDirection(TreeMapLayoutStartingDirection layoutStartingDirection)

  Defines which direction the layout algorithm will start drawing. Possible values are "vertical" and "horizontal".

  Defaults to: vertical

• getLevelIsConstant

  public Boolean getLevelIsConstant()

  See Also:

  • setLevelIsConstant(Boolean)

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

  Defaults to: true

• getLevels

  public Level[] getLevels()

  See Also:

  • setLevels(Level...)

• setLevels

  public void setLevels(Level... levels)

  Set options on specific levels. Takes precedence over series options, but not point options.

• addLevel

  public void addLevel(Level level)

  Adds level to the levels array

  Parameters:

  level - to add

  See Also:

  • setLevels(Level...)

• removeLevel

  public void removeLevel(Level level)

  Removes first occurrence of level in levels array

  Parameters:

  level - to remove

  See Also:

  • setLevels(Level...)

• 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

• getOpacity

  public Number getOpacity()

  See Also:

  • setOpacity(Number)

• setOpacity

  public void setOpacity(Number opacity)

  The opacity of a point in treemap. When a point has children, the visibility of the children is determined by the opacity.

  Defaults to: 0.15

• getPointDescriptionFormatter

  public String getPointDescriptionFormatter()

• setPointDescriptionFormatter

  public void setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)

• 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 series type or specific series item in the legend.

  Defaults to: false

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

• getSortIndex

  public Number getSortIndex()

  See Also:

  • setSortIndex(Number)

• setSortIndex

  public void setSortIndex(Number sortIndex)

  The sort index of the point inside the treemap level.

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

• 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

• getZoneAxis

  public ZoneAxis getZoneAxis()

  See Also:

  • setZoneAxis(ZoneAxis)

• setZoneAxis

  public void setZoneAxis(ZoneAxis zoneAxis)

  Defines the Axis on which the zones are applied.

  Defaults to: y

• getZones

  public Zones[] getZones()

  See Also:

  • setZones(Zones...)

• setZones

  public void setZones(Zones... zones)

  An array 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.

  In styled mode, the color zones are styled with the .highcharts-zone-{n} class, or custom classed from the className option (view live demo).

• addZone

  public void addZone(Zones zone)

  Adds zone to the zones array

  Parameters:

  zone - to add

  See Also:

  • setZones(Zones...)

• removeZone

  public void removeZone(Zones zone)

  Removes first occurrence of zone in zones array

  Parameters:

  zone - to remove

  See Also:

  • setZones(Zones...)