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

Class ScatterRecord

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

All Implemented Interfaces:

Duplicatable, GenericRecord

public final class ScatterRecord
extends StandardRecord

The scatter record is used to define a scatter chart.

Author:

henrichen@zkoss.org

Field Summary

Fields

Modifier and Type	Field	Description
static short	sid

Constructor Summary

Constructors

Constructor	Description
ScatterRecord()
ScatterRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method	Description
Object	clone()
ScatterRecord	copy()
protected int	getDataSize()
short	getFormatFlags()	Get the format flags field for the Pie record.
Map<String,Supplier<?>>	getGenericProperties()
HSSFRecordTypes	getGenericRecordType()
short	getRatio()	Get the ratio to show the bubble to their default size.
short	getSid()	return the non static version of the id for this record.
short	getSize()	Get how the default size of the data points represents the value: 1 means the data point represents the value; 2 means width of the data point represent the value.
boolean	isBubbles()	whether this is a scatter chart(false) or bubble chart(true).
boolean	isNegBubbles()	Whether show negative data points bubble.
boolean	isShadow()	display a shadow for the chart
void	serialize(LittleEndianOutput out)	Write the data content of this BIFF record.
void	setBubbles(boolean value)	Sets the bubbles field value.
void	setFormatFlags(short field_3_formatFlags)	Set the format flags field for the Pie record.
void	setNegBubbles(boolean value)	True to show negative data points bubble.
void	setRatio(short field_1_ratio)	Set the ratio to show the bubble to their default size.
void	setShadow(boolean value)	Sets the shadow field value.
void	setSize(short field_2_size)	Set how the default size of the data points represents the value: 1 means the data point represents the value; 2 means width of the data point represent the value.

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

ScatterRecord

public ScatterRecord()

ScatterRecord

public ScatterRecord(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 ScatterRecord 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.

getRatio

public short getRatio()

Get the ratio to show the bubble to their default size.

setRatio

public void setRatio(short field_1_ratio)

Set the ratio to show the bubble to their default size.

getSize

public short getSize()

Get how the default size of the data points represents the value: 1 means the data point represents the value; 2 means width of the data point represent the value.

setSize

public void setSize(short field_2_size)

Set how the default size of the data points represents the value: 1 means the data point represents the value; 2 means width of the data point represent the value.

setNegBubbles

public void setNegBubbles(boolean value)

True to show negative data points bubble.

isNegBubbles

public boolean isNegBubbles()

Whether show negative data points bubble.

Returns:

Whether show negative data points bubble.

setBubbles

public void setBubbles(boolean value)

Sets the bubbles field value. whether this is a scatter chart(false) or bubble chart(true).

isBubbles

public boolean isBubbles()

whether this is a scatter chart(false) or bubble chart(true).

Returns:

the bubbles field value.

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()