PlotOptionsTreemap
Related Docs:
class PlotOptionsTreemap
| package config
When enabled the user can click on a point which is a parent and zoom in on its children.
Allow this series' points to be selected by clicking on the markers, bars or pie slices.
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.
Enable or disable the initial animation when a series is displayed. The animation can also be set as a configuration object. 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. The following properties are supported:. <dl>. <dt>duration</dt>.
Math object. See the easing demo.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.
The color of the border surrounding each tree map item.
The width of the border surrounding each column or bar.. .
In styled mode, the stroke width can be set with the .highcharts-point rule.
A class name to apply to the series' graphical elements.
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.
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.
Styled mode only. A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.
A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.
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.
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.
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.
Requires Accessibility module. A description of the series to add to the screen reader information about the series.
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.
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.
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.
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.
Whether to ignore hidden points when the layout algorithm runs. If false, hidden points will leave open spaces.
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.
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.
This option decides which algorithm is used for setting position and dimensions of the points. Can be one of sliceAndDice, stripes, squarified or strip.
Defines which direction the layout algorithm will start drawing. Possible values are "vertical" and "horizontal".
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.
Set options on specific levels. Takes precedence over series options, but not point options.
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.
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.
The opacity of a point in treemap. When a point has children, the visibility of the children is determined by the opacity.
Properties for each single point
Same as accessibility.pointDescriptionFormatter, but for an individual series. Overrides the chart wide configuration.
Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name will be checked for a selected series.
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.
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.
Whether to display this series type or specific series item in the legend.
If set to True, the accessibility module will skip past the points in this series for keyboard navigation.
The sort index of the point inside the treemap level.
A wrapper object for all the series options in specific states.
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.
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.
Set the initial visibility of the series.
Defines the Axis on which the zones are applied.
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).