Package org.zkoss.chart.plotOptions

Class ScatterPlotOptions

    • Constructor Detail

      • ScatterPlotOptions

        public ScatterPlotOptions()

    • Method Detail

      • getCluster

        public Cluster getCluster()
        Returns the options for marker clusters, the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts.

        Default: an instance of Cluster.

        Since:
        10.2.1.0

      • setCluster

        public void setCluster​(Cluster cluster)
        Sets the options for marker clusters, the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts.

        Default: an instance of Cluster.

        Since:
        10.2.1.0

      • setDepth

        public void setDepth​(Number depth)
        Sets the total depth of the chart.
        Overrides:
        setDepth in class SeriesPlotOptions
        Parameters:
        depth - the total depth of the chart. Defaults to 100.

      • getHeight

        public Number getHeight()
        Returns the height of the scatter plot.

        Default: null.

        Returns:
        the height of the scatter plot.

      • setHeight

        public void setHeight​(Number height)
        Sets the height of the scatter plot.

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

      • setLineWidth

        public void setLineWidth​(Number lineWidth)
        Sets the width of the line connecting the data points. 'lineWidth the width of the line connecting the data points.
        Overrides:
        setLineWidth in class SeriesPlotOptions

      • isStickyTracking

        public boolean isStickyTracking()
        Returns 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.
        Overrides:
        isStickyTracking in class SeriesPlotOptions

      • setStickyTracking

        public void setStickyTracking​(boolean stickyTracking)
        Sets 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.
        Overrides:
        setStickyTracking in class SeriesPlotOptions

      • getWidth

        public Number getWidth()
        Returns the width of the scatter plot.

        Default: null.

        Returns:
        the width of the scatter plot.

      • setWidth

        public void setWidth​(Number width)
        Sets the width of the scatter plot.