Top Description Fields Constructors Methods
org.apache.poi.hssf.record.chart

public final Class ChartRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.hssf.record.HSSFRecordTypes, .RecordInputStream, .StandardRecord, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput
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

Modifier and TypeField and Description
private int
field_1_x

private int
field_2_y

private int
field_3_width

private int
field_4_height

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
ChartRecord()

public
ChartRecord(ChartRecord other)

public
ChartRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public ChartRecord
copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

protected int
getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

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

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public HSSFRecordTypes
getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

public int
getHeight()

Get the height field for the Chart record.

public short
getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

public int
getWidth()

Get the width field for the Chart record.

public int
getX()

Get the x field for the Chart record.

public int
getY()

Get the y field for the Chart record.

public void
serialize(LittleEndianOutput
the output object
out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record.

public void
setHeight(int height)

Set the height field for the Chart record.

public void
setWidth(int width)

Set the width field for the Chart record.

public void
setX(int x)

Set the x field for the Chart record.

public void
setY(int y)

Set the y field for the Chart record.

Inherited from org.apache.poi.hssf.record.StandardRecord:
getRecordSizeserialize

Field Detail

field_1_xback to summary
private int field_1_x
field_2_yback to summary
private int field_2_y
field_3_widthback to summary
private int field_3_width
field_4_heightback to summary
private int field_4_height
sidback to summary
public static final short sid

Constructor Detail

ChartRecordback to summary
public ChartRecord()
ChartRecordback to summary
public ChartRecord(ChartRecord other)
ChartRecordback to summary
public ChartRecord(RecordInputStream in)

Method Detail

copyback to summary
public ChartRecord copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:ChartRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
getDataSizeback to summary
protected int getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getGenericRecordTypeback to summary
public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations
@Override
getHeightback to summary
public int getHeight()

Get the height field for the Chart record.

getSidback to summary
public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

Returns:short

he id for this record

getWidthback to summary
public int getWidth()

Get the width field for the Chart record.

getXback to summary
public int getX()

Get the x field for the Chart record.

getYback to summary
public int getY()

Get the y field for the Chart record.

serializeback to summary
public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

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 org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters
out:LittleEndianOutput

the output object

setHeightback to summary
public void setHeight(int height)

Set the height field for the Chart record.

setWidthback to summary
public void setWidth(int width)

Set the width field for the Chart record.

setXback to summary
public void setX(int x)

Set the x field for the Chart record.

setYback to summary
public void setY(int y)

Set the y field for the Chart record.