Package org.zkoss.chart.plotOptions

Class BubblePlotOptions

    • Constructor Detail

      • BubblePlotOptions

        public BubblePlotOptions()

    • Method Detail

      • getCropThreshold

        public Number getCropThreshold()
        Returns 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.

        Default: 300

        Overrides:
        getCropThreshold in class ColumnPlotOptions

      • setCropThreshold

        public void setCropThreshold​(Number cropThreshold)
        Sets 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.
        Overrides:
        setCropThreshold in class ColumnPlotOptions

      • isDisplayNegative

        public boolean isDisplayNegative()
        Returns whether to display negative sized bubbles. The threshold is given by the setZThreshold(Number) option, and negative bubbles can be visualized by setting setNegativeColor(String)

        Default: true

      • setDisplayNegative

        public void setDisplayNegative​(boolean displayNegative)
        Sets whether to display negative sized bubbles. The threshold is given by the setZThreshold(Number) option, and negative bubbles can be visualized by setting setNegativeColor(String)

        Default: true

      • 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

      • getMaxSize

        public String 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%

      • 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 either pixels (when no unit is given), or a percentage of the smallest one of the plot width and height.

      • getMinSize

        public String getMinSize()
        Returns minimum 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: 8

      • setMinSize

        public void setMinSize​(String minSize)
        Sets minimum 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.

      • getSizeBy

        public String getSizeBy()
        Returns whether the bubble's value should be represented by the area or the width of the bubble.

        The default, area, corresponds best to the human perception of the size of each bubble.

      • setSizeBy

        public void setSizeBy​(String sizeBy)
        Sets whether the bubble's value should be represented by the area or the width of the bubble. The default, area, corresponds best to the human perception of the size of each bubble.

      • 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

      • getZMax

        public Number getZMax()
        Returns the maximum for the Z value range. Defaults to the highest Z value in the data.

        Default: null

      • setZMax

        public void setZMax​(Number zMax)
        Sets the maximum for the Z value range.

      • getZMin

        public Number getZMin()
        Returns the minimum for the Z value range. Defaults to the lowest Z value in the data.

        Default: null

      • setZMin

        public void setZMin​(Number zMin)
        Sets the minimum for the Z value range.