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

public final Class SeriesLabelsRecord

extends StandardRecord
Class Inheritance
Static Imports
org.apache.poi.util.GenericRecordUtil.getBitsAsString

The series label record defines the type of label associated with the data format record.

Field Summary

Modifier and TypeField and Description
private short
private static final BitField
private static final BitField
private static final BitField
private static final BitField
private static final BitField
public static final short
private static final BitField

Constructor Summary

AccessConstructor and Description
public
public
public

Method Summary

Modifier and TypeMethod and Description
public SeriesLabelsRecord
protected int
public short
getFormatFlags()

Get the format flags field for the SeriesLabels record.

public Map<String, Supplier<?>>
public HSSFRecordTypes
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 label as percentage field value.
isLabelAsPercentage
()

show category label/value as percentage (pie charts only)

public boolean

Returns:

the show actual field value.
isShowActual
()

show actual value of the data point

public boolean

Returns:

the show bubble sizes field value.
isShowBubbleSizes
()

??

public boolean

Returns:

the show label field value.
isShowLabel
()

display category label

public boolean

Returns:

the show percent field value.
isShowPercent
()

show value as percentage of total (pie charts only)

public boolean

Returns:

the smoothed line field value.
isSmoothedLine
()

show smooth line

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
setFormatFlags(short field_1_formatFlags)

Set the format flags field for the SeriesLabels record.

public void
setLabelAsPercentage(boolean value)

Sets the label as percentage field value.

public void
setShowActual(boolean value)

Sets the show actual field value.

public void
setShowBubbleSizes(boolean value)

Sets the show bubble sizes field value.

public void
setShowLabel(boolean value)

Sets the show label field value.

public void
setShowPercent(boolean value)

Sets the show percent field value.

public void
setSmoothedLine(boolean value)

Sets the smoothed line field value.

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

Field Detail

field_1_formatFlagsback to summary
private short field_1_formatFlags
labelAsPercentageback to summary
private static final BitField labelAsPercentage
showActualback to summary
private static final BitField showActual
showBubbleSizesback to summary
private static final BitField showBubbleSizes
showLabelback to summary
private static final BitField showLabel
showPercentback to summary
private static final BitField showPercent
sidback to summary
public static final short sid
smoothedLineback to summary
private static final BitField smoothedLine

Constructor Detail

SeriesLabelsRecordback to summary
public SeriesLabelsRecord()
SeriesLabelsRecordback to summary
public SeriesLabelsRecord(SeriesLabelsRecord other)
SeriesLabelsRecordback to summary
public SeriesLabelsRecord(RecordInputStream in)

Method Detail

copyback to summary
public SeriesLabelsRecord copy()

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

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

Returns:SeriesLabelsRecord

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

isLabelAsPercentageback to summary
public boolean isLabelAsPercentage()

show category label/value as percentage (pie charts only)

Returns:boolean

the label as percentage field value.

isShowActualback to summary
public boolean isShowActual()

show actual value of the data point

Returns:boolean

the show actual field value.

isShowBubbleSizesback to summary
public boolean isShowBubbleSizes()

??

Returns:boolean

the show bubble sizes field value.

isShowLabelback to summary
public boolean isShowLabel()

display category label

Returns:boolean

the show label field value.

isShowPercentback to summary
public boolean isShowPercent()

show value as percentage of total (pie charts only)

Returns:boolean

the show percent field value.

isSmoothedLineback to summary
public boolean isSmoothedLine()

show smooth line

Returns:boolean

the smoothed line 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

setFormatFlagsback to summary
public void setFormatFlags(short field_1_formatFlags)

Set the format flags field for the SeriesLabels record.

setLabelAsPercentageback to summary
public void setLabelAsPercentage(boolean value)

Sets the label as percentage field value. show category label/value as percentage (pie charts only)

setShowActualback to summary
public void setShowActual(boolean value)

Sets the show actual field value. show actual value of the data point

setShowBubbleSizesback to summary
public void setShowBubbleSizes(boolean value)

Sets the show bubble sizes field value. ??

setShowLabelback to summary
public void setShowLabel(boolean value)

Sets the show label field value. display category label

setShowPercentback to summary
public void setShowPercent(boolean value)

Sets the show percent field value. show value as percentage of total (pie charts only)

setSmoothedLineback to summary
public void setSmoothedLine(boolean value)

Sets the smoothed line field value. show smooth line