Package org.zkoss.chart.plotOptions

Class HistogramPlotOptions

    • Constructor Detail

      • HistogramPlotOptions

        public HistogramPlotOptions()

    • Method Detail

      • setColors

        public void setColors​(List<Color> colors)
        Sets the series specific or series type specific color set to apply instead of the global colors when SeriesPlotOptions.isColorByPoint() is true.
        Since:
        10.2.1.0

      • setColors

        public void setColors​(String... colors)
        Sets the series specific or series type specific color set to apply instead of the global colors when SeriesPlotOptions.isColorByPoint() is true.
        Since:
        10.2.1.0

      • setColors

        public void setColors​(Color... colors)
        Sets the series specific or series type specific color set to apply instead of the global colors when SeriesPlotOptions.isColorByPoint() is true.
        Since:
        10.2.1.0

      • setDepth

        public void setDepth​(Number depth)
        Sets the depth of the 3D chart.

        Default: null

        Overrides:
        setDepth in class SeriesPlotOptions
        Since:
        10.2.1.0

      • isCenterInCategory

        public boolean isCenterInCategory()
        When true, the columns will center in the category, ignoring null or missing points. When false, space will be reserved for null or missing points.

        Default: false.

        Overrides:
        isCenterInCategory in class SeriesPlotOptions
        Since:
        10.2.1.0

      • setCenterInCategory

        public void setCenterInCategory​(boolean centerInCategory)
        When true, the columns will center in the category, ignoring null or missing points. When false, space will be reserved for null or missing points.
        Overrides:
        setCenterInCategory in class SeriesPlotOptions
        Since:
        10.2.1.0

      • getBorderColor

        public Color getBorderColor()
        Returns the color of the border surrounding each slice.

        Default: #FFFFFF

        Since:
        10.2.1.0

      • setBorderColor

        public void setBorderColor​(Color borderColor)
        Sets the color of the border surrounding each slice. Default: #FFFFFF
        Since:
        10.2.1.0

      • setBorderColor

        public void setBorderColor​(String borderColor)
        Sets the color of the border surrounding each slice. Default: #FFFFFF
        Since:
        10.2.1.0

      • getBinsNumber

        public Object getBinsNumber()
        Returns a preferable number of bins. It is a suggestion, so a histogram may have a different number of bins. By default it is set to the square root of the base series' data length. Available options are: square-root, sturges, rice. You can also define a function which takes a baseSeries as a parameter and should return a positive integer.

        Default: "square-root"

      • setBinsNumber

        public void setBinsNumber​(String binsNumber)
        Sets a preferable number of bins. It is a suggestion, so a histogram may have a different number of bins. Available options are: square-root, sturges, rice.

      • setBinsNumber

        public void setBinsNumber​(int binsNumber)
        Sets a preferable number of bins. It is a suggestion, so a histogram may have a different number of bins.

      • setBinsNumber

        public void setBinsNumber​(org.zkoss.json.JavaScriptValue binsNumber)
        Sets a preferable number of bins. It is a suggestion, so a histogram may have a different number of bins. You can define a function which takes a baseSeries as a parameter and should return a positive integer.

      • getBinWidth

        public Number getBinWidth()
        Returns the width of each bin. By default the bin's width is calculated as (max - min) / number of bins. This option takes precedence over binsNumber.

        Default: null

      • setBinWidth

        public void setBinWidth​(Number binWidth)
        Sets the width of each bin. By default the bin's width is calculated as (max - min) / number of bins. This option takes precedence over binsNumber.

      • getEdgeColor

        public Color getEdgeColor()
        3D columns only. The color of the edges. Similar to borderColor, except it defaults to the same color as the column.

        Default: null

        Since:
        10.2.1.0

      • setEdgeColor

        public void setEdgeColor​(Color color)
        3D columns only. The color of the edges. Similar to borderColor, except it defaults to the same color as the column.

        Default: null

        Since:
        10.2.1.0

      • setEdgeColor

        public void setEdgeColor​(String color)
        3D columns only. The color of the edges. Similar to borderColor, except it defaults to the same color as the column.

        Default: null

        Since:
        10.2.1.0

      • getEdgeWidth

        public Number getEdgeWidth()
        3D columns only. Returns the width of the colored edges.

        Default: 1

        Since:
        10.2.1.0

      • setEdgeWidth

        public void setEdgeWidth​(Number edgeWidth)
        3D columns only. Sets the width of the colored edges.
        Since:
        10.2.1.0

      • isGrouping

        public boolean isGrouping()
        Returns whether to group non-stacked columns or to let them render independent of each other. Non-grouped columns will be laid out individually and overlap each other.

        Defaults to false.

        Since:
        10.2.1.0

      • setGrouping

        public void setGrouping​(boolean grouping)
        Sets whether to group non-stacked columns or to let them render independent of each other. Non-grouped columns will be laid out individually and overlap each other.
        Since:
        10.2.1.0

      • getGroupPadding

        public Number getGroupPadding()
        Returns padding between each value groups, in x axis units.

        Default: 0

        Overrides:
        getGroupPadding in class SeriesPlotOptions
        Since:
        10.2.1.0

      • setGroupPadding

        public void setGroupPadding​(Number groupPadding)
        Sets padding between each value groups, in x axis units.
        Overrides:
        setGroupPadding in class SeriesPlotOptions
        Since:
        10.2.1.0

      • getGroupZPadding

        public Number getGroupZPadding()
        Returns the spacing between columns on the Z Axis in a 3D chart.

        Default: 1

        Since:
        10.2.1.0

      • setGroupZPadding

        public void setGroupZPadding​(Number groupZPadding)
        Sets the spacing between columns on the Z Axis in a 3D chart.

        Default: 1

        Since:
        10.2.1.0

      • getMaxPointWidth

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

        Default: null

        Since:
        10.2.1.0

      • setMaxPointWidth

        public void setMaxPointWidth​(Number maxPointWidth)
        Sets 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.
        Since:
        10.2.1.0

      • getMinPointLength

        public Number getMinPointLength()
        Returns the minimal height for a column or width for a bar. By default, 0 values are not shown. To visualize a 0 (or close to zero) point, set the minimal point length to a pixel value like 3. In stacked column charts, minPointLength might not be respected for tightly packed values.

        Default: 0

        Since:
        10.2.1.0

      • setMinPointLength

        public void setMinPointLength​(Number minPointLength)
        Sets the minimal height for a column or width for a bar. By default, 0 values are not shown. To visualize a 0 (or close to zero) point, set the minimal point length to a pixel value like 3. In stacked column charts, minPointLength might not be respected for tightly packed values.
        Since:
        10.2.1.0

      • getPointPadding

        public Number getPointPadding()
        Returns padding between each column or bar, in x axis units.

        Default: 0

        Since:
        10.2.1.0

      • setPointPadding

        public void setPointPadding​(Number pointPadding)
        Sets padding between each column or bar, in x axis units. 'pointPadding padding between each column or bar, in x axis units.
        Since:
        10.2.1.0

      • getPointRange

        public Number getPointRange()
        Returns the X axis range that each point is valid for. This determines the width of the column. On a categorized axis, the range will be 1 by default (one category unit). On linear and datetime axes, the range will be computed as the distance between the two closest data points.

        Default: null

        Since:
        10.2.1.0

      • setPointRange

        public void setPointRange​(Number pointRange)
        Sets the X axis range that each point is valid for. This determines the width of the column. On a categorized axis, the range will be 1 by default (one category unit). On linear and datetime axes, the range will be computed as the distance between the two closest data points.
        Since:
        10.2.1.0

      • getPointWidth

        public Number getPointWidth()
        Returns a pixel value specifying a fixed width for each column or bar. When null, the width is calculated from the pointPadding and groupPadding.

        Default: null

        Since:
        10.2.1.0

      • setPointWidth

        public void setPointWidth​(Number pointWidth)
        Sets a pixel value specifying a fixed width for each column or bar. When null, the width is calculated from the pointPadding and groupPadding.
        Since:
        10.2.1.0