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

public final Class BarRecord

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

Field Summary

Modifier and TypeField and Description
private static final BitField
displayAsPercentage

private short
field_1_barSpace

private short
field_2_categorySpace

private short
field_3_formatFlags

private static final BitField
horizontal

private static final BitField
shadow

public static final short
sid

private static final BitField
stacked

Constructor Summary

AccessConstructor and Description
public
BarRecord()

public
BarRecord(BarRecord other)

public
BarRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public BarRecord
copy()

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

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

public short
getBarSpace()

Get the bar space field for the Bar record.

public short
getCategorySpace()

Get the category space field for the Bar record.

protected int
getDataSize()

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

public short
getFormatFlags()

Get the format flags field for the Bar 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()

display chart values as a percentage

public boolean

Returns:

the horizontal field value.
isHorizontal()

true to display horizontal bar charts, false for vertical

public boolean

Returns:

the shadow field value.
isShadow()

display a shadow for the chart

public boolean

Returns:

the stacked field value.
isStacked()

stack displayed values

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
setBarSpace(short field_1_barSpace)

Set the bar space field for the Bar record.

public void
setCategorySpace(short field_2_categorySpace)

Set the category space field for the Bar record.

public void
setDisplayAsPercentage(boolean value)

Sets the display as percentage field value.

public void
setFormatFlags(short field_3_formatFlags)

Set the format flags field for the Bar record.

public void
setHorizontal(boolean value)

Sets the horizontal field value.

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_barSpaceback to summary
private short field_1_barSpace
field_2_categorySpaceback to summary
private short field_2_categorySpace
field_3_formatFlagsback to summary
private short field_3_formatFlags
horizontalback to summary
private static final BitField horizontal
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

BarRecordback to summary
public BarRecord()
BarRecordback to summary
public BarRecord(BarRecord other)
BarRecordback to summary
public BarRecord(RecordInputStream in)

Method Detail

copyback to summary
public BarRecord copy()

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

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

Returns:BarRecord

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

a deep copy of the implementing class / instance

Annotations
@Override
getBarSpaceback to summary
public short getBarSpace()

Get the bar space field for the Bar record.

getCategorySpaceback to summary
public short getCategorySpace()

Get the category space field for the Bar record.

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

display chart values as a percentage

Returns:boolean

the display as percentage field value.

isHorizontalback to summary
public boolean isHorizontal()

true to display horizontal bar charts, false for vertical

Returns:boolean

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

stack displayed values

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

setBarSpaceback to summary
public void setBarSpace(short field_1_barSpace)

Set the bar space field for the Bar record.

setCategorySpaceback to summary
public void setCategorySpace(short field_2_categorySpace)

Set the category space field for the Bar record.

setDisplayAsPercentageback to summary
public void setDisplayAsPercentage(boolean value)

Sets the display as percentage field value. display chart values as a percentage

setFormatFlagsback to summary
public void setFormatFlags(short field_3_formatFlags)

Set the format flags field for the Bar record.

setHorizontalback to summary
public void setHorizontal(boolean value)

Sets the horizontal field value. true to display horizontal bar charts, false for vertical

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. stack displayed values