Package org.zkoss.chart.plotOptions

Class ColumnRangePlotOptions

    • Constructor Detail

      • ColumnRangePlotOptions

        public ColumnRangePlotOptions()

    • Method Detail

      • getBorderColor

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

        Default: null

        Since:
        10.2.1.0

      • setBorderColor

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

      • setBorderColor

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

      • setBorderColor

        public void setBorderColor​(LinearGradient borderColor)
        Sets the color of the border surrounding each slice.
        Since:
        10.2.1.0

      • setBorderColor

        public void setBorderColor​(RadialGradient borderColor)
        Sets the color of the border surrounding each slice.
        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

      • getDepth

        public Number getDepth()
        Returns the depth of the columns in a 3D column range chart.

        Default: 25

        Overrides:
        getDepth in class SeriesPlotOptions

      • setDepth

        public void setDepth​(Number depth)
        Sets the depth of the columns in a 3D column range chart.
        Overrides:
        setDepth in class SeriesPlotOptions

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

        Default: true

        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.

        Default: true

        Since:
        10.2.1.0

      • getGroupPadding

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

        Default: 0.2

        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

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

        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