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

Class PieFormatRecord

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

All Implemented Interfaces:

Duplicatable, GenericRecord

public final class PieFormatRecord
extends StandardRecord

The record specifies the distance of a data point or data points in a series from the center of pie chart.

Author:

Glen Stampoultzis (glens at apache.org)

Field Summary

Fields

Modifier and Type	Field	Description
static short	sid

Constructor Summary

Constructors

Constructor	Description
PieFormatRecord()
PieFormatRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method	Description
Object	clone()
PieFormatRecord	copy()
protected int	getDataSize()
Map<String,Supplier<?>>	getGenericProperties()
HSSFRecordTypes	getGenericRecordType()
short	getPcExplode()	Get the percentage distance of a data point or data pints in a series from the center of the plot area for a doughnut or pie chart (0 ~ 100).
short	getSid()	return the non static version of the id for this record.
void	serialize(LittleEndianOutput out)	Write the data content of this BIFF record.
void	setPcExplode(short field_1_pcExplode)	Set the percentage distance of a data point or data pints in a series from the center of the plot area for a doughnut or pie chart (0 ~ 100).

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

PieFormatRecord

public PieFormatRecord()

PieFormatRecord

public PieFormatRecord(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

copy

public PieFormatRecord copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class StandardRecord

Returns:

a deep copy of the implementing class / instance

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

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

getPcExplode

public short getPcExplode()

Get the percentage distance of a data point or data pints in a series from the center of the plot area for a doughnut or pie chart (0 ~ 100). 0 means data point is as close to the center as possible; 100 means data point is at the edge of the chart area; > 100 will scale down data point to fit in chart area.

setPcExplode

public void setPcExplode(short field_1_pcExplode)

Set the percentage distance of a data point or data pints in a series from the center of the plot area for a doughnut or pie chart (0 ~ 100). 0 means data point is as close to the center as possible; 100 means data point is at the edge of the chart area; > 100 will scale down data point to fit in chart area.

getGenericProperties

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