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

Class ChartRecord

java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.StandardRecord
org.apache.poi.hssf.record.chart.ChartRecord
All Implemented Interfaces:
Duplicatable, GenericRecord
public final class ChartRecord extends StandardRecord
CHART (0x1002)

The chart record is used to define the location and size of a chart.

Chart related records don't seem to be covered in either the OOO or the MS documentation. The book "Microsoft Excel 97 Developer's Kit" ISBN: (1-57231-498-2) seems to have an entire chapter (10) devoted to Chart records. One blog suggests that some documentation for these records is available in "MSDN Library, Feb 1998", but no later.

  • Field Details

  • Constructor Details

    • ChartRecord

      public ChartRecord()

    • ChartRecord

      public ChartRecord(ChartRecord other)

    • ChartRecord

      public ChartRecord(RecordInputStream in)

  • Method Details

    • 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

    • getDataSize

      protected int getDataSize()
      Specified by:
      getDataSize in class StandardRecord

    • 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

    • copy

      public ChartRecord copy()
      Specified by:
      copy in interface Duplicatable
      Specified by:
      copy in class StandardRecord
      Returns:
      a deep copy of the implementing class / instance

    • getX

      public int getX()
      Get the x field for the Chart record.

    • setX

      public void setX(int x)
      Set the x field for the Chart record.

    • getY

      public int getY()
      Get the y field for the Chart record.

    • setY

      public void setY(int y)
      Set the y field for the Chart record.

    • getWidth

      public int getWidth()
      Get the width field for the Chart record.

    • setWidth

      public void setWidth(int width)
      Set the width field for the Chart record.

    • getHeight

      public int getHeight()
      Get the height field for the Chart record.

    • setHeight

      public void setHeight(int height)
      Set the height field for the Chart record.

    • getGenericRecordType

      public HSSFRecordTypes getGenericRecordType()
      Specified by:
      getGenericRecordType in interface GenericRecord
      Specified by:
      getGenericRecordType in class Record

    • getGenericProperties

      public Map<String,Supplier<?>> getGenericProperties()