Package loci.poi.hssf.record
Class SeriesLabelsRecord
- java.lang.Object
-
- loci.poi.hssf.record.Record
-
- loci.poi.hssf.record.SeriesLabelsRecord
-
public class SeriesLabelsRecord extends Record
The series label record defines the type of label associated with the data format record. NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/records/definitions.- Author:
- Glen Stampoultzis (glens at apache.org)
-
-
Field Summary
Fields Modifier and Type Field Description static short
sid
-
Constructor Summary
Constructors Constructor Description SeriesLabelsRecord()
SeriesLabelsRecord(RecordInputStream in)
Constructs a SeriesLabels record and sets its fields appropriately.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
clone()
protected void
fillFields(RecordInputStream in)
called by the constructor, should set class level fields.short
getFormatFlags()
Get the format flags field for the SeriesLabels record.int
getRecordSize()
Size of record (exluding 4 byte header)short
getSid()
return the non static version of the id for this record.boolean
isLabelAsPercentage()
show category label/value as percentage (pie charts only)boolean
isShowActual()
show actual value of the data pointboolean
isShowBubbleSizes()
??boolean
isShowLabel()
display category labelboolean
isShowPercent()
show value as percentage of total (pie charts only)boolean
isSmoothedLine()
show smooth lineint
serialize(int offset, byte[] data)
called by the class that is responsible for writing this sucker.void
setFormatFlags(short field_1_formatFlags)
Set the format flags field for the SeriesLabels record.void
setLabelAsPercentage(boolean value)
Sets the label as percentage field value.void
setShowActual(boolean value)
Sets the show actual field value.void
setShowBubbleSizes(boolean value)
Sets the show bubble sizes field value.void
setShowLabel(boolean value)
Sets the show label field value.void
setShowPercent(boolean value)
Sets the show percent field value.void
setSmoothedLine(boolean value)
Sets the smoothed line field value.String
toString()
get a string representation of the record (for biffview/debugging)protected void
validateSid(short id)
Checks the sid matches the expected side for this record-
Methods inherited from class loci.poi.hssf.record.Record
isInValueSection, isValue, serialize
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
SeriesLabelsRecord
public SeriesLabelsRecord()
-
SeriesLabelsRecord
public SeriesLabelsRecord(RecordInputStream in)
Constructs a SeriesLabels record and sets its fields appropriately.- Parameters:
in
- the RecordInputstream to read the record from
-
-
Method Detail
-
validateSid
protected void validateSid(short id)
Checks the sid matches the expected side for this record- Specified by:
validateSid
in classRecord
- Parameters:
id
- the expected sid.
-
fillFields
protected void fillFields(RecordInputStream in)
Description copied from class:Record
called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFields
in classRecord
- Parameters:
in
- the RecordInputstream to read the record from
-
toString
public String toString()
Description copied from class:Record
get a string representation of the record (for biffview/debugging)
-
serialize
public int serialize(int offset, byte[] data)
Description copied from class:Record
called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array.
-
getRecordSize
public int getRecordSize()
Size of record (exluding 4 byte header)- Overrides:
getRecordSize
in classRecord
-
getSid
public short getSid()
Description copied from class:Record
return the non static version of the id for this record.
-
getFormatFlags
public short getFormatFlags()
Get the format flags field for the SeriesLabels record.
-
setFormatFlags
public void setFormatFlags(short field_1_formatFlags)
Set the format flags field for the SeriesLabels record.
-
setShowActual
public void setShowActual(boolean value)
Sets the show actual field value. show actual value of the data point
-
isShowActual
public boolean isShowActual()
show actual value of the data point- Returns:
- the show actual field value.
-
setShowPercent
public void setShowPercent(boolean value)
Sets the show percent field value. show value as percentage of total (pie charts only)
-
isShowPercent
public boolean isShowPercent()
show value as percentage of total (pie charts only)- Returns:
- the show percent field value.
-
setLabelAsPercentage
public void setLabelAsPercentage(boolean value)
Sets the label as percentage field value. show category label/value as percentage (pie charts only)
-
isLabelAsPercentage
public boolean isLabelAsPercentage()
show category label/value as percentage (pie charts only)- Returns:
- the label as percentage field value.
-
setSmoothedLine
public void setSmoothedLine(boolean value)
Sets the smoothed line field value. show smooth line
-
isSmoothedLine
public boolean isSmoothedLine()
show smooth line- Returns:
- the smoothed line field value.
-
setShowLabel
public void setShowLabel(boolean value)
Sets the show label field value. display category label
-
isShowLabel
public boolean isShowLabel()
display category label- Returns:
- the show label field value.
-
setShowBubbleSizes
public void setShowBubbleSizes(boolean value)
Sets the show bubble sizes field value. ??
-
isShowBubbleSizes
public boolean isShowBubbleSizes()
??- Returns:
- the show bubble sizes field value.
-
-