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 Summary
Fields Modifier and Type Field Description static shortsid
-
Constructor Summary
Constructors Constructor Description ChartRecord()ChartRecord(ChartRecord other)ChartRecord(RecordInputStream in)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ChartRecordcopy()protected intgetDataSize()Map<String,Supplier<?>>getGenericProperties()HSSFRecordTypesgetGenericRecordType()intgetHeight()Get the height field for the Chart record.shortgetSid()return the non static version of the id for this record.intgetWidth()Get the width field for the Chart record.intgetX()Get the x field for the Chart record.intgetY()Get the y field for the Chart record.voidserialize(LittleEndianOutput out)Write the data content of this BIFF record.voidsetHeight(int height)Set the height field for the Chart record.voidsetWidth(int width)Set the width field for the Chart record.voidsetX(int x)Set the x field for the Chart record.voidsetY(int y)Set the y field for the Chart record.-
Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
-
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord
getGenericChildren
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ChartRecord
public ChartRecord()
-
ChartRecord
public ChartRecord(ChartRecord other)
-
ChartRecord
public ChartRecord(RecordInputStream in)
-
-
Method Detail
-
serialize
public void serialize(LittleEndianOutput out)
Description copied from class:StandardRecordWrite 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:
serializein classStandardRecord- Parameters:
out- the output object
-
getDataSize
protected int getDataSize()
- Specified by:
getDataSizein classStandardRecord
-
getSid
public short getSid()
Description copied from class:Recordreturn the non static version of the id for this record.
-
copy
public ChartRecord copy()
- Specified by:
copyin interfaceDuplicatable- Specified by:
copyin classStandardRecord- 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:
getGenericRecordTypein interfaceGenericRecord- Specified by:
getGenericRecordTypein classRecord
-
-