Package org.zkoss.chart.plotOptions

Class ColumnPlotOptions

    • Constructor Detail

      • ColumnPlotOptions

        public ColumnPlotOptions()

    • Method Detail

      • 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

      • 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: 50

        Overrides:
        getCropThreshold in class SeriesPlotOptions

      • 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 SeriesPlotOptions

      • getBorderColor

        public Color getBorderColor()
        Returns the color of the border surrounding each column or bar.

        Default: #FFFFFF

      • setBorderColor

        public void setBorderColor​(Color color)
        Sets the color of the border surrounding each column or bar. 'borderColor the color of the border surrounding each column or bar.

      • setBorderColor

        public void setBorderColor​(String color)
        Sets the color of the border surrounding each column or bar. 'borderColor the color of the border surrounding each column or bar.

      • setBorderColor

        public void setBorderColor​(LinearGradient color)
        Sets the color of the border surrounding each column or bar. 'borderColor the color of the border surrounding each column or bar.

      • setBorderColor

        public void setBorderColor​(RadialGradient color)
        Sets the color of the border surrounding each column or bar. 'borderColor the color of the border surrounding each column or bar.

      • getBorderRadius

        public Object getBorderRadius()
        Returns the corner radius of the border surrounding each column or bar.

        Default: 0

        Overrides:
        getBorderRadius in class SeriesPlotOptions

      • setBorderWidth

        public void setBorderWidth​(Number borderWidth)
        Sets the width of the border surrounding each column or bar.
        Overrides:
        setBorderWidth in class SeriesPlotOptions

      • isCrisp

        public boolean isCrisp()
        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.

        Default: true

        Overrides:
        isCrisp in class SeriesPlotOptions
        Since:
        7.2.1.0

      • setCrisp

        public void setCrisp​(boolean crisp)
        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.
        Overrides:
        setCrisp in class SeriesPlotOptions
        Since:
        7.2.1.0

      • getEdgeWidth

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

        Default: 1

        Since:
        7.2.1.0

      • setEdgeWidth

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

      • 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

      • getGroupZPadding

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

        Default: 1

      • setGroupZPadding

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

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

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

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

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

      • getPointPadding

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

        Default: 0.1

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

      • 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

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

      • 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

      • setPointWidth

        public void setPointWidth​(int 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.