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

public final Class AreaRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.hssf.record.HSSFRecordTypes, .RecordInputStream, .StandardRecord, org.apache.poi.util.BitField, .BitFieldFactory, .GenericRecordUtil, .LittleEndianOutput
The area record is used to define an area chart.

Field Summary

Modifier and TypeField and Description
private static final BitField
displayAsPercentage

private short
field_1_formatFlags

private static final BitField
shadow

public static final short
sid

private static final BitField
stacked

Constructor Summary

AccessConstructor and Description
public
AreaRecord()

public
AreaRecord(AreaRecord other)

public
AreaRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public AreaRecord
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 short
getFormatFlags()

Get the format flags field for the Area record.

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

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

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

public boolean

Returns:

the display as percentage field value.
isDisplayAsPercentage()

results displayed as percentages

public boolean

Returns:

the shadow field value.
isShadow()

display a shadow for the chart

public boolean

Returns:

the stacked field value.
isStacked()

series is stacked

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
setDisplayAsPercentage(boolean value)

Sets the display as percentage field value.

public void
setFormatFlags(short field_1_formatFlags)

Set the format flags field for the Area record.

public void
setShadow(boolean value)

Sets the shadow field value.

public void
setStacked(boolean value)

Sets the stacked field value.

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

Field Detail

displayAsPercentageback to summary
private static final BitField displayAsPercentage
field_1_formatFlagsback to summary
private short field_1_formatFlags
shadowback to summary
private static final BitField shadow
sidback to summary
public static final short sid
stackedback to summary
private static final BitField stacked

Constructor Detail

AreaRecordback to summary
public AreaRecord()
AreaRecordback to summary
public AreaRecord(AreaRecord other)
AreaRecordback to summary
public AreaRecord(RecordInputStream in)

Method Detail

copyback to summary
public AreaRecord copy()

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

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

Returns:AreaRecord

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.

getFormatFlagsback to summary
public short getFormatFlags()

Get the format flags field for the Area record.

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

isDisplayAsPercentageback to summary
public boolean isDisplayAsPercentage()

results displayed as percentages

Returns:boolean

the display as percentage field value.

isShadowback to summary
public boolean isShadow()

display a shadow for the chart

Returns:boolean

the shadow field value.

isStackedback to summary
public boolean isStacked()

series is stacked

Returns:boolean

the stacked field value.

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

setDisplayAsPercentageback to summary
public void setDisplayAsPercentage(boolean value)

Sets the display as percentage field value. results displayed as percentages

setFormatFlagsback to summary
public void setFormatFlags(short field_1_formatFlags)

Set the format flags field for the Area record.

setShadowback to summary
public void setShadow(boolean value)

Sets the shadow field value. display a shadow for the chart

setStackedback to summary
public void setStacked(boolean value)

Sets the stacked field value. series is stacked