Package org.apache.poi.hssf.record.chart

Class BarRecord

  • All Implemented Interfaces:
    org.apache.poi.common.Duplicatable, GenericRecord
    public final class BarRecord
extends StandardRecord
    The bar record is used to define a bar chart.

    • Constructor Detail

      • BarRecord

        public BarRecord()

      • BarRecord

        public BarRecord​(BarRecord other)

    • Method Detail

      • getSid

        public short getSid()
        Description copied from class: Record
        return the non static version of the id for this record.
        Specified by:
        getSid in class Record
        Returns:
        he id for this record

      • getBarSpace

        public short getBarSpace()
        Get the bar space field for the Bar record.

      • setBarSpace

        public void setBarSpace​(short field_1_barSpace)
        Set the bar space field for the Bar record.

      • getCategorySpace

        public short getCategorySpace()
        Get the category space field for the Bar record.

      • setCategorySpace

        public void setCategorySpace​(short field_2_categorySpace)
        Set the category space field for the Bar record.

      • getFormatFlags

        public short getFormatFlags()
        Get the format flags field for the Bar record.

      • setFormatFlags

        public void setFormatFlags​(short field_3_formatFlags)
        Set the format flags field for the Bar record.

      • setHorizontal

        public void setHorizontal​(boolean value)
        Sets the horizontal field value. true to display horizontal bar charts, false for vertical

      • isHorizontal

        public boolean isHorizontal()
        true to display horizontal bar charts, false for vertical
        Returns:
        the horizontal field value.

      • setStacked

        public void setStacked​(boolean value)
        Sets the stacked field value. stack displayed values

      • isStacked

        public boolean isStacked()
        stack displayed values
        Returns:
        the stacked field value.

      • setDisplayAsPercentage

        public void setDisplayAsPercentage​(boolean value)
        Sets the display as percentage field value. display chart values as a percentage

      • isDisplayAsPercentage

        public boolean isDisplayAsPercentage()
        display chart values as a percentage
        Returns:
        the display as percentage field value.

      • setShadow

        public void setShadow​(boolean value)
        Sets the shadow field value. display a shadow for the chart

      • isShadow

        public boolean isShadow()
        display a shadow for the chart
        Returns:
        the shadow field value.

      • copy

        public BarRecord copy()
        Specified by:
        copy in interface org.apache.poi.common.Duplicatable
        Specified by:
        copy in class StandardRecord

      • getGenericProperties

        public java.util.Map<java.lang.String,​java.util.function.Supplier<?>> getGenericProperties()