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

Class CategorySeriesAxisRecord

  • All Implemented Interfaces:
    Duplicatable, GenericRecord
    public final class CategorySeriesAxisRecord
extends StandardRecord
    This record refers to a category or series axis and is used to specify label/tickmark frequency.

    • Constructor Detail

      • CategorySeriesAxisRecord

        public CategorySeriesAxisRecord()

      • CategorySeriesAxisRecord

        public CategorySeriesAxisRecord​(RecordInputStream in)

    • Method Detail

      • serialize

        public void serialize​(LittleEndianOutput out)
        Description copied from class: StandardRecord
        Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.

        The number of bytes written must equal the record size reported by RecordBase.getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

        Specified by:
        serialize in class StandardRecord
        Parameters:
        out - the output object

      • 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

      • getCrossingPoint

        public short getCrossingPoint()
        Get the crossing point field for the CategorySeriesAxis record.

      • setCrossingPoint

        public void setCrossingPoint​(short field_1_crossingPoint)
        Set the crossing point field for the CategorySeriesAxis record.

      • getLabelFrequency

        public short getLabelFrequency()
        Get the label frequency field for the CategorySeriesAxis record.

      • setLabelFrequency

        public void setLabelFrequency​(short field_2_labelFrequency)
        Set the label frequency field for the CategorySeriesAxis record.

      • getTickMarkFrequency

        public short getTickMarkFrequency()
        Get the tick mark frequency field for the CategorySeriesAxis record.

      • setTickMarkFrequency

        public void setTickMarkFrequency​(short field_3_tickMarkFrequency)
        Set the tick mark frequency field for the CategorySeriesAxis record.

      • getOptions

        public short getOptions()
        Get the options field for the CategorySeriesAxis record.

      • setOptions

        public void setOptions​(short field_4_options)
        Set the options field for the CategorySeriesAxis record.

      • setValueAxisCrossing

        public void setValueAxisCrossing​(boolean value)
        Sets the value axis crossing field value. set true to indicate axis crosses between categories and false to cross axis midway

      • isValueAxisCrossing

        public boolean isValueAxisCrossing()
        set true to indicate axis crosses between categories and false to cross axis midway
        Returns:
        the value axis crossing field value.

      • setCrossesFarRight

        public void setCrossesFarRight​(boolean value)
        Sets the crosses far right field value. axis crosses at the far right

      • isCrossesFarRight

        public boolean isCrossesFarRight()
        axis crosses at the far right
        Returns:
        the crosses far right field value.

      • setReversed

        public void setReversed​(boolean value)
        Sets the reversed field value. categories are displayed in reverse order

      • isReversed

        public boolean isReversed()
        categories are displayed in reverse order
        Returns:
        the reversed field value.