Package org.apache.poi.hssf.record.chart
Class SeriesRecord
- 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.SeriesRecord
-
- All Implemented Interfaces:
org.apache.poi.common.Duplicatable
,GenericRecord
public final class SeriesRecord extends StandardRecord
The series record describes the overall data for a series.
-
-
Field Summary
Fields Modifier and Type Field Description static short
BUBBLE_SERIES_TYPE_DATES
static short
BUBBLE_SERIES_TYPE_NUMERIC
static short
BUBBLE_SERIES_TYPE_SEQUENCE
static short
BUBBLE_SERIES_TYPE_TEXT
static short
CATEGORY_DATA_TYPE_DATES
static short
CATEGORY_DATA_TYPE_NUMERIC
static short
CATEGORY_DATA_TYPE_SEQUENCE
static short
CATEGORY_DATA_TYPE_TEXT
static short
sid
static short
VALUES_DATA_TYPE_DATES
static short
VALUES_DATA_TYPE_NUMERIC
static short
VALUES_DATA_TYPE_SEQUENCE
static short
VALUES_DATA_TYPE_TEXT
-
Constructor Summary
Constructors Constructor Description SeriesRecord()
SeriesRecord(SeriesRecord other)
SeriesRecord(RecordInputStream in)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SeriesRecord
copy()
short
getBubbleSeriesType()
Get the bubble series type field for the Series record.short
getCategoryDataType()
Get the category data type field for the Series record.java.util.Map<java.lang.String,java.util.function.Supplier<?>>
getGenericProperties()
HSSFRecordTypes
getGenericRecordType()
short
getNumBubbleValues()
Get the num bubble values field for the Series record.short
getNumCategories()
Get the num categories field for the Series record.short
getNumValues()
Get the num values field for the Series record.short
getSid()
return the non static version of the id for this record.short
getValuesDataType()
Get the values data type field for the Series record.void
serialize(LittleEndianOutput out)
void
setBubbleSeriesType(short field_5_bubbleSeriesType)
Set the bubble series type field for the Series record.void
setCategoryDataType(short field_1_categoryDataType)
Set the category data type field for the Series record.void
setNumBubbleValues(short field_6_numBubbleValues)
Set the num bubble values field for the Series record.void
setNumCategories(short field_3_numCategories)
Set the num categories field for the Series record.void
setNumValues(short field_4_numValues)
Set the num values field for the Series record.void
setValuesDataType(short field_2_valuesDataType)
Set the values data type field for the Series record.-
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, 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
-
CATEGORY_DATA_TYPE_DATES
public static final short CATEGORY_DATA_TYPE_DATES
- See Also:
- Constant Field Values
-
CATEGORY_DATA_TYPE_NUMERIC
public static final short CATEGORY_DATA_TYPE_NUMERIC
- See Also:
- Constant Field Values
-
CATEGORY_DATA_TYPE_SEQUENCE
public static final short CATEGORY_DATA_TYPE_SEQUENCE
- See Also:
- Constant Field Values
-
CATEGORY_DATA_TYPE_TEXT
public static final short CATEGORY_DATA_TYPE_TEXT
- See Also:
- Constant Field Values
-
VALUES_DATA_TYPE_DATES
public static final short VALUES_DATA_TYPE_DATES
- See Also:
- Constant Field Values
-
VALUES_DATA_TYPE_NUMERIC
public static final short VALUES_DATA_TYPE_NUMERIC
- See Also:
- Constant Field Values
-
VALUES_DATA_TYPE_SEQUENCE
public static final short VALUES_DATA_TYPE_SEQUENCE
- See Also:
- Constant Field Values
-
VALUES_DATA_TYPE_TEXT
public static final short VALUES_DATA_TYPE_TEXT
- See Also:
- Constant Field Values
-
BUBBLE_SERIES_TYPE_DATES
public static final short BUBBLE_SERIES_TYPE_DATES
- See Also:
- Constant Field Values
-
BUBBLE_SERIES_TYPE_NUMERIC
public static final short BUBBLE_SERIES_TYPE_NUMERIC
- See Also:
- Constant Field Values
-
BUBBLE_SERIES_TYPE_SEQUENCE
public static final short BUBBLE_SERIES_TYPE_SEQUENCE
- See Also:
- Constant Field Values
-
BUBBLE_SERIES_TYPE_TEXT
public static final short BUBBLE_SERIES_TYPE_TEXT
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
SeriesRecord
public SeriesRecord()
-
SeriesRecord
public SeriesRecord(SeriesRecord other)
-
SeriesRecord
public SeriesRecord(RecordInputStream in)
-
-
Method Detail
-
serialize
public void serialize(LittleEndianOutput out)
-
getSid
public short getSid()
Description copied from class:Record
return the non static version of the id for this record.
-
copy
public SeriesRecord copy()
- Specified by:
copy
in interfaceorg.apache.poi.common.Duplicatable
- Specified by:
copy
in classStandardRecord
-
getCategoryDataType
public short getCategoryDataType()
Get the category data type field for the Series record.- Returns:
- One of CATEGORY_DATA_TYPE_DATES CATEGORY_DATA_TYPE_NUMERIC CATEGORY_DATA_TYPE_SEQUENCE CATEGORY_DATA_TYPE_TEXT
-
setCategoryDataType
public void setCategoryDataType(short field_1_categoryDataType)
Set the category data type field for the Series record.- Parameters:
field_1_categoryDataType
- One of CATEGORY_DATA_TYPE_DATES CATEGORY_DATA_TYPE_NUMERIC CATEGORY_DATA_TYPE_SEQUENCE CATEGORY_DATA_TYPE_TEXT
-
getValuesDataType
public short getValuesDataType()
Get the values data type field for the Series record.- Returns:
- One of VALUES_DATA_TYPE_DATES VALUES_DATA_TYPE_NUMERIC VALUES_DATA_TYPE_SEQUENCE VALUES_DATA_TYPE_TEXT
-
setValuesDataType
public void setValuesDataType(short field_2_valuesDataType)
Set the values data type field for the Series record.- Parameters:
field_2_valuesDataType
- One of VALUES_DATA_TYPE_DATES VALUES_DATA_TYPE_NUMERIC VALUES_DATA_TYPE_SEQUENCE VALUES_DATA_TYPE_TEXT
-
getNumCategories
public short getNumCategories()
Get the num categories field for the Series record.
-
setNumCategories
public void setNumCategories(short field_3_numCategories)
Set the num categories field for the Series record.
-
getNumValues
public short getNumValues()
Get the num values field for the Series record.
-
setNumValues
public void setNumValues(short field_4_numValues)
Set the num values field for the Series record.
-
getBubbleSeriesType
public short getBubbleSeriesType()
Get the bubble series type field for the Series record.- Returns:
- One of BUBBLE_SERIES_TYPE_DATES BUBBLE_SERIES_TYPE_NUMERIC BUBBLE_SERIES_TYPE_SEQUENCE BUBBLE_SERIES_TYPE_TEXT
-
setBubbleSeriesType
public void setBubbleSeriesType(short field_5_bubbleSeriesType)
Set the bubble series type field for the Series record.- Parameters:
field_5_bubbleSeriesType
- One of BUBBLE_SERIES_TYPE_DATES BUBBLE_SERIES_TYPE_NUMERIC BUBBLE_SERIES_TYPE_SEQUENCE BUBBLE_SERIES_TYPE_TEXT
-
getNumBubbleValues
public short getNumBubbleValues()
Get the num bubble values field for the Series record.
-
setNumBubbleValues
public void setNumBubbleValues(short field_6_numBubbleValues)
Set the num bubble values field for the Series record.
-
getGenericRecordType
public HSSFRecordTypes getGenericRecordType()
- Specified by:
getGenericRecordType
in interfaceGenericRecord
- Specified by:
getGenericRecordType
in classRecord
-
getGenericProperties
public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()
-
-