Packages

object PlotOptionsTreemap

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PlotOptionsTreemap
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apply(allowDrillToNode: UndefOr[Boolean] = js.undefined, allowPointSelect: UndefOr[Boolean] = js.undefined, alternateStartingDirection: UndefOr[Boolean] = js.undefined, animation: UndefOr[Boolean] = js.undefined, animationLimit: UndefOr[Double] = js.undefined, borderColor: UndefOr[|[String, Object]] = js.undefined, borderWidth: UndefOr[Double] = js.undefined, className: UndefOr[String] = js.undefined, color: UndefOr[|[String, Object]] = js.undefined, colorByPoint: UndefOr[Boolean] = js.undefined, colors: UndefOr[Array[|[String, Object]]] = js.undefined, cropThreshold: UndefOr[Double] = js.undefined, cursor: UndefOr[String] = js.undefined, dataLabels: UndefOr[CleanJsObject[PlotOptionsTreemapDataLabels]] = js.undefined, description: UndefOr[String] = js.undefined, enableMouseTracking: UndefOr[Boolean] = js.undefined, events: UndefOr[CleanJsObject[PlotOptionsTreemapEvents]] = js.undefined, getExtremesFromAll: UndefOr[Boolean] = js.undefined, interactByLeaf: UndefOr[Boolean] = js.undefined, keys: UndefOr[Array[String]] = js.undefined, layoutAlgorithm: UndefOr[String] = js.undefined, layoutStartingDirection: UndefOr[String] = js.undefined, levelIsConstant: UndefOr[Boolean] = js.undefined, levels: UndefOr[Array[CleanJsObject[PlotOptionsTreemapLevels]]] = js.undefined, linkedTo: UndefOr[String] = js.undefined, maxPointWidth: UndefOr[Double] = js.undefined, opacity: UndefOr[Double] = js.undefined, point: UndefOr[CleanJsObject[PlotOptionsTreemapPoint]] = js.undefined, selected: UndefOr[Boolean] = js.undefined, shadow: UndefOr[|[Boolean, Object]] = js.undefined, showCheckbox: UndefOr[Boolean] = js.undefined, showInLegend: UndefOr[Boolean] = js.undefined, sortIndex: UndefOr[Double] = js.undefined, states: UndefOr[CleanJsObject[PlotOptionsTreemapStates]] = js.undefined, stickyTracking: UndefOr[Boolean] = js.undefined, tooltip: UndefOr[CleanJsObject[PlotOptionsTreemapTooltip]] = js.undefined, turboThreshold: UndefOr[Double] = js.undefined, visible: UndefOr[Boolean] = js.undefined, zoneAxis: UndefOr[String] = js.undefined, zones: UndefOr[Array[CleanJsObject[PlotOptionsTreemapZones]]] = js.undefined): PlotOptionsTreemap

    allowDrillToNode

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

    allowPointSelect

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

    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.

    animation

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

    The duration of the animation in milliseconds.
    . <dt>easing</dt>.
    A string reference to an easing function set on the Math object. See the easing demo.
    . </dl>. . Due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.

    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.

    borderColor

    The color of the border surrounding each tree map item.

    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.

    className

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

    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.

    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.

    colors

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

    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.

    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.

    description

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

    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.

    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.

    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.

    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.

    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.

    layoutStartingDirection

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

    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.

    levels

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

    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.

    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.

    opacity

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

    point

    Properties for each single point

    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.

    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.

    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.

    showInLegend

    Whether to display this series type or specific series item in the legend.

    sortIndex

    The sort index of the point inside the treemap level.

    states

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

    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.

    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.

    visible

    Set the initial visibility of the series.

    zoneAxis

    Defines the Axis on which the zones are applied.

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

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped