Apache POI - Common 5.3.0 · org.apache.poi.hssf.record.chart.SeriesRecord

Field Summary

Modifier and Type	Field and Description
public static final short	BUBBLE_SERIES_TYPE_DATES
public static final short	BUBBLE_SERIES_TYPE_NUMERIC
public static final short	BUBBLE_SERIES_TYPE_SEQUENCE
public static final short	BUBBLE_SERIES_TYPE_TEXT
public static final short	CATEGORY_DATA_TYPE_DATES
public static final short	CATEGORY_DATA_TYPE_NUMERIC
public static final short	CATEGORY_DATA_TYPE_SEQUENCE
public static final short	CATEGORY_DATA_TYPE_TEXT
private short	field_1_categoryDataType
private short	field_2_valuesDataType
private short	field_3_numCategories
private short	field_4_numValues
private short	field_5_bubbleSeriesType
private short	field_6_numBubbleValues
public static final short	sid
public static final short	VALUES_DATA_TYPE_DATES
public static final short	VALUES_DATA_TYPE_NUMERIC
public static final short	VALUES_DATA_TYPE_SEQUENCE
public static final short	VALUES_DATA_TYPE_TEXT

Constructor Summary

Access	Constructor and Description
public	SeriesRecord()
public	SeriesRecord(SeriesRecord other)
public	SeriesRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
public SeriesRecord	copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy.
public short	Returns: One of BUBBLE_SERIES_TYPE_DATES BUBBLE_SERIES_TYPE_NUMERIC BUBBLE_SERIES_TYPE_SEQUENCE BUBBLE_SERIES_TYPE_TEXT getBubbleSeriesType() Get the bubble series type field for the Series record.
public short	Returns: One of CATEGORY_DATA_TYPE_DATES CATEGORY_DATA_TYPE_NUMERIC CATEGORY_DATA_TYPE_SEQUENCE CATEGORY_DATA_TYPE_TEXT getCategoryDataType() Get the category data type field for the Series record.
protected int	getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.
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	getNumBubbleValues() Get the num bubble values field for the Series record.
public short	getNumCategories() Get the num categories field for the Series record.
public short	getNumValues() Get the num values field for the Series record.
public short	getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record.
public short	Returns: One of VALUES_DATA_TYPE_DATES VALUES_DATA_TYPE_NUMERIC VALUES_DATA_TYPE_SEQUENCE VALUES_DATA_TYPE_TEXT getValuesDataType() Get the values data type field for the Series record.
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	setBubbleSeriesType(short One of BUBBLE_SERIES_TYPE_DATES BUBBLE_SERIES_TYPE_NUMERIC BUBBLE_SERIES_TYPE_SEQUENCE BUBBLE_SERIES_TYPE_TEXT field_5_bubbleSeriesType) Set the bubble series type field for the Series record.
public void	setCategoryDataType(short One of CATEGORY_DATA_TYPE_DATES CATEGORY_DATA_TYPE_NUMERIC CATEGORY_DATA_TYPE_SEQUENCE CATEGORY_DATA_TYPE_TEXT field_1_categoryDataType) Set the category data type field for the Series record.
public void	setNumBubbleValues(short field_6_numBubbleValues) Set the num bubble values field for the Series record.
public void	setNumCategories(short field_3_numCategories) Set the num categories field for the Series record.
public void	setNumValues(short field_4_numValues) Set the num values field for the Series record.
public void	setValuesDataType(short One of VALUES_DATA_TYPE_DATES VALUES_DATA_TYPE_NUMERIC VALUES_DATA_TYPE_SEQUENCE VALUES_DATA_TYPE_TEXT field_2_valuesDataType) Set the values data type field for the Series record.

Inherited from org.apache.poi.hssf.record.StandardRecord:: getRecordSize serialize

Field Detail

BUBBLE_SERIES_TYPE_DATES	back to summary
public static final short BUBBLE_SERIES_TYPE_DATES

BUBBLE_SERIES_TYPE_NUMERIC	back to summary
public static final short BUBBLE_SERIES_TYPE_NUMERIC

BUBBLE_SERIES_TYPE_SEQUENCE	back to summary
public static final short BUBBLE_SERIES_TYPE_SEQUENCE

BUBBLE_SERIES_TYPE_TEXT	back to summary
public static final short BUBBLE_SERIES_TYPE_TEXT

CATEGORY_DATA_TYPE_DATES	back to summary
public static final short CATEGORY_DATA_TYPE_DATES

CATEGORY_DATA_TYPE_NUMERIC	back to summary
public static final short CATEGORY_DATA_TYPE_NUMERIC

CATEGORY_DATA_TYPE_SEQUENCE	back to summary
public static final short CATEGORY_DATA_TYPE_SEQUENCE

CATEGORY_DATA_TYPE_TEXT	back to summary
public static final short CATEGORY_DATA_TYPE_TEXT

field_1_categoryDataType	back to summary
private short field_1_categoryDataType

field_2_valuesDataType	back to summary
private short field_2_valuesDataType

field_3_numCategories	back to summary
private short field_3_numCategories

field_4_numValues	back to summary
private short field_4_numValues

field_5_bubbleSeriesType	back to summary
private short field_5_bubbleSeriesType

field_6_numBubbleValues	back to summary
private short field_6_numBubbleValues

sid	back to summary
public static final short sid

VALUES_DATA_TYPE_DATES	back to summary
public static final short VALUES_DATA_TYPE_DATES

VALUES_DATA_TYPE_NUMERIC	back to summary
public static final short VALUES_DATA_TYPE_NUMERIC

VALUES_DATA_TYPE_SEQUENCE	back to summary
public static final short VALUES_DATA_TYPE_SEQUENCE

VALUES_DATA_TYPE_TEXT	back to summary
public static final short VALUES_DATA_TYPE_TEXT

Constructor Detail

SeriesRecord	back to summary
public SeriesRecord()

SeriesRecord	back to summary
public SeriesRecord(SeriesRecord other)

SeriesRecord	back to summary
public SeriesRecord(RecordInputStream in)

Method Detail

copy	back to summary
public SeriesRecord copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy. Returns:SeriesRecord Doc from org.apache.poi.common.Duplicatable.copy. a deep copy of the implementing class / instance Annotations @Override

copy

back to summary

public SeriesRecord copy()

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

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

Returns:SeriesRecord

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

a deep copy of the implementing class / instance

Annotations

@Override

getBubbleSeriesType	back to summary
public short getBubbleSeriesType() Get the bubble series type field for the Series record. Returns:short One of BUBBLE_SERIES_TYPE_DATES BUBBLE_SERIES_TYPE_NUMERIC BUBBLE_SERIES_TYPE_SEQUENCE BUBBLE_SERIES_TYPE_TEXT

getBubbleSeriesType

back to summary

public short getBubbleSeriesType()

Get the bubble series type field for the Series record.

Returns:short: One of BUBBLE_SERIES_TYPE_DATES BUBBLE_SERIES_TYPE_NUMERIC BUBBLE_SERIES_TYPE_SEQUENCE BUBBLE_SERIES_TYPE_TEXT

getCategoryDataType	back to summary
public short getCategoryDataType() Get the category data type field for the Series record. Returns:short One of CATEGORY_DATA_TYPE_DATES CATEGORY_DATA_TYPE_NUMERIC CATEGORY_DATA_TYPE_SEQUENCE CATEGORY_DATA_TYPE_TEXT

getCategoryDataType

back to summary

public short getCategoryDataType()

Get the category data type field for the Series record.

Returns:short: One of CATEGORY_DATA_TYPE_DATES CATEGORY_DATA_TYPE_NUMERIC CATEGORY_DATA_TYPE_SEQUENCE CATEGORY_DATA_TYPE_TEXT

getDataSize	back to summary
protected int getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations

@Override

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

getGenericRecordType

back 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

getNumBubbleValues	back to summary
public short getNumBubbleValues() Get the num bubble values field for the Series record.

getNumCategories	back to summary
public short getNumCategories() Get the num categories field for the Series record.

getNumValues	back to summary
public short getNumValues() Get the num values field for the Series record.

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

getSid

back 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

getValuesDataType	back to summary
public short getValuesDataType() Get the values data type field for the Series record. Returns:short One of VALUES_DATA_TYPE_DATES VALUES_DATA_TYPE_NUMERIC VALUES_DATA_TYPE_SEQUENCE VALUES_DATA_TYPE_TEXT

getValuesDataType

back to summary

public short getValuesDataType()

Get the values data type field for the Series record.

Returns:short: One of VALUES_DATA_TYPE_DATES VALUES_DATA_TYPE_NUMERIC VALUES_DATA_TYPE_SEQUENCE VALUES_DATA_TYPE_TEXT

serialize back to summary

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

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

setBubbleSeriesType	back to summary
public void setBubbleSeriesType(short field_5_bubbleSeriesType) Set the bubble series type field for the Series record. Parameters field_5_bubbleSeriesType:short One of BUBBLE_SERIES_TYPE_DATES BUBBLE_SERIES_TYPE_NUMERIC BUBBLE_SERIES_TYPE_SEQUENCE BUBBLE_SERIES_TYPE_TEXT

setBubbleSeriesType

back to summary

public void setBubbleSeriesType(short field_5_bubbleSeriesType)

Set the bubble series type field for the Series record.

Parameters

field_5_bubbleSeriesType:short: One of BUBBLE_SERIES_TYPE_DATES BUBBLE_SERIES_TYPE_NUMERIC BUBBLE_SERIES_TYPE_SEQUENCE BUBBLE_SERIES_TYPE_TEXT

setCategoryDataType	back to summary
public void setCategoryDataType(short field_1_categoryDataType) Set the category data type field for the Series record. Parameters field_1_categoryDataType:short One of CATEGORY_DATA_TYPE_DATES CATEGORY_DATA_TYPE_NUMERIC CATEGORY_DATA_TYPE_SEQUENCE CATEGORY_DATA_TYPE_TEXT

setCategoryDataType

back to summary

public void setCategoryDataType(short field_1_categoryDataType)

Set the category data type field for the Series record.

Parameters

field_1_categoryDataType:short: One of CATEGORY_DATA_TYPE_DATES CATEGORY_DATA_TYPE_NUMERIC CATEGORY_DATA_TYPE_SEQUENCE CATEGORY_DATA_TYPE_TEXT

setNumBubbleValues	back to summary
public void setNumBubbleValues(short field_6_numBubbleValues) Set the num bubble values field for the Series record.

setNumCategories	back to summary
public void setNumCategories(short field_3_numCategories) Set the num categories field for the Series record.

setNumValues	back to summary
public void setNumValues(short field_4_numValues) Set the num values field for the Series record.

setValuesDataType	back to summary
public void setValuesDataType(short field_2_valuesDataType) Set the values data type field for the Series record. Parameters field_2_valuesDataType:short One of VALUES_DATA_TYPE_DATES VALUES_DATA_TYPE_NUMERIC VALUES_DATA_TYPE_SEQUENCE VALUES_DATA_TYPE_TEXT

setValuesDataType

back to summary

public void setValuesDataType(short field_2_valuesDataType)

Set the values data type field for the Series record.

Parameters

field_2_valuesDataType:short: One of VALUES_DATA_TYPE_DATES VALUES_DATA_TYPE_NUMERIC VALUES_DATA_TYPE_SEQUENCE VALUES_DATA_TYPE_TEXT

public final Class SeriesRecord

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail