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

Class PieRecord

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.PieRecord

All Implemented Interfaces:

Duplicatable, GenericRecord

public final class PieRecord
extends StandardRecord

The pie record is used to define a pie chart.

Author:

henrichen@zkoss.org

Field Summary

Fields

Modifier and Type	Field	Description
static short	sid

Constructor Summary

Constructors

Constructor	Description
PieRecord()
PieRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method	Description
Object	clone()
PieRecord	copy()
short	getAnStart()	Get the start angle in degrees clockwise from the top of the circle.
protected int	getDataSize()
short	getFormatFlags()	Get the format flags field for the Pie record.
Map<String,Supplier<?>>	getGenericProperties()
HSSFRecordTypes	getGenericRecordType()
short	getPcDonut()	Get the size of the center hole as a percentage of the plot area size (0 as Pie, 10 to 90 as Doughnut).
short	getSid()	return the non static version of the id for this record.
boolean	isShadow()	display a shadow for the chart
boolean	isShowLdrLines()	Whether show leader lines for data labels.
void	serialize(LittleEndianOutput out)	Write the data content of this BIFF record.
void	setAnStart(short field_1_anStart)	Set the format flags field for the Area record.
void	setFormatFlags(short field_3_formatFlags)	Set the format flags field for the Pie record.
void	setPcDonut(short field_2_pcDonut)	Set the size of the center hole as a percentage of the plot area size (0 as Pie, 10 to 90 as Doughnut).
void	setShadow(boolean value)	Sets the shadow field value.
void	setShowLdrLines(boolean value)	Sets show leader lines for data labels.

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

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

PieRecord

public PieRecord()

PieRecord

public PieRecord(RecordInputStream in)

Method Detail

getDataSize

protected int getDataSize()

Specified by:

getDataSize in class StandardRecord

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

copy

public PieRecord copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class StandardRecord

Returns:

a deep copy of the implementing class / instance

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

getGenericRecordType

public HSSFRecordTypes getGenericRecordType()

Specified by:

getGenericRecordType in interface GenericRecord

Specified by:

getGenericRecordType in class Record

clone

public Object clone()

Overrides:

clone in class Object

getFormatFlags

public short getFormatFlags()

Get the format flags field for the Pie record.

setFormatFlags

public void setFormatFlags(short field_3_formatFlags)

Set the format flags field for the Pie record.

getAnStart

public short getAnStart()

Get the start angle in degrees clockwise from the top of the circle.

setAnStart

public void setAnStart(short field_1_anStart)

Set the format flags field for the Area record.

getPcDonut

public short getPcDonut()

Get the size of the center hole as a percentage of the plot area size (0 as Pie, 10 to 90 as Doughnut).

setPcDonut

public void setPcDonut(short field_2_pcDonut)

Set the size of the center hole as a percentage of the plot area size (0 as Pie, 10 to 90 as Doughnut).

setShowLdrLines

public void setShowLdrLines(boolean value)

Sets show leader lines for data labels.

isShowLdrLines

public boolean isShowLdrLines()

Whether show leader lines for data labels.

Returns:

Whether show leader lines for data labels.

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.

getGenericProperties

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