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

Modifier and Type	Field and Description
private static final BitField	crossesFarRight
private short	field_1_crossingPoint
private short	field_2_labelFrequency
private short	field_3_tickMarkFrequency
private short	field_4_options
private static final BitField	reversed
public static final short	sid
private static final BitField	valueAxisCrossing

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

Method Summary

Modifier and Type	Method and Description
public CategorySeriesAxisRecord	copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy.
public short	getCrossingPoint() Get the crossing point field for the CategorySeriesAxis 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	getLabelFrequency() Get the label frequency field for the CategorySeriesAxis record.
public short	getOptions() Get the options field for the CategorySeriesAxis 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	getTickMarkFrequency() Get the tick mark frequency field for the CategorySeriesAxis record.
public boolean	Returns: the crosses far right field value. isCrossesFarRight() axis crosses at the far right
public boolean	Returns: the reversed field value. isReversed() categories are displayed in reverse order
public boolean	Returns: the value axis crossing field value. isValueAxisCrossing() set true to indicate axis crosses between categories and false to cross axis midway
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	setCrossesFarRight(boolean value) Sets the crosses far right field value.
public void	setCrossingPoint(short field_1_crossingPoint) Set the crossing point field for the CategorySeriesAxis record.
public void	setLabelFrequency(short field_2_labelFrequency) Set the label frequency field for the CategorySeriesAxis record.
public void	setOptions(short field_4_options) Set the options field for the CategorySeriesAxis record.
public void	setReversed(boolean value) Sets the reversed field value.
public void	setTickMarkFrequency(short field_3_tickMarkFrequency) Set the tick mark frequency field for the CategorySeriesAxis record.
public void	setValueAxisCrossing(boolean value) Sets the value axis crossing field value.

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

crossesFarRight	back to summary
private static final BitField crossesFarRight

field_1_crossingPoint	back to summary
private short field_1_crossingPoint

field_2_labelFrequency	back to summary
private short field_2_labelFrequency

field_3_tickMarkFrequency	back to summary
private short field_3_tickMarkFrequency

field_4_options	back to summary
private short field_4_options

reversed	back to summary
private static final BitField reversed

sid	back to summary
public static final short sid

valueAxisCrossing	back to summary
private static final BitField valueAxisCrossing

CategorySeriesAxisRecord	back to summary
public CategorySeriesAxisRecord()

CategorySeriesAxisRecord	back to summary
public CategorySeriesAxisRecord(CategorySeriesAxisRecord other)

CategorySeriesAxisRecord	back to summary
public CategorySeriesAxisRecord(RecordInputStream in)

Method Detail

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

copy

back to summary

public CategorySeriesAxisRecord copy()

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

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

Returns:CategorySeriesAxisRecord

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

a deep copy of the implementing class / instance

Annotations

@Override

getCrossingPoint	back to summary
public short getCrossingPoint() Get the crossing point field for the CategorySeriesAxis record.

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

getLabelFrequency	back to summary
public short getLabelFrequency() Get the label frequency field for the CategorySeriesAxis record.

getOptions	back to summary
public short getOptions() Get the options field for the CategorySeriesAxis 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

getTickMarkFrequency	back to summary
public short getTickMarkFrequency() Get the tick mark frequency field for the CategorySeriesAxis record.

isCrossesFarRight	back to summary
public boolean isCrossesFarRight() axis crosses at the far right Returns:boolean the crosses far right field value.

isCrossesFarRight

back to summary

public boolean isCrossesFarRight()

axis crosses at the far right

Returns:boolean: the crosses far right field value.

isReversed	back to summary
public boolean isReversed() categories are displayed in reverse order Returns:boolean the reversed field value.

isReversed

back to summary

public boolean isReversed()

categories are displayed in reverse order

Returns:boolean: the reversed field value.

isValueAxisCrossing	back to summary
public boolean isValueAxisCrossing() set true to indicate axis crosses between categories and false to cross axis midway Returns:boolean the value axis crossing field value.

isValueAxisCrossing

back to summary

public boolean isValueAxisCrossing()

set true to indicate axis crosses between categories and false to cross axis midway

Returns:boolean: the value axis crossing field value.

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

setCrossesFarRight	back to summary
public void setCrossesFarRight(boolean value) Sets the crosses far right field value. axis crosses at the far right

setCrossingPoint	back to summary
public void setCrossingPoint(short field_1_crossingPoint) Set the crossing point field for the CategorySeriesAxis record.

setLabelFrequency	back to summary
public void setLabelFrequency(short field_2_labelFrequency) Set the label frequency field for the CategorySeriesAxis record.

setOptions	back to summary
public void setOptions(short field_4_options) Set the options field for the CategorySeriesAxis record.

setReversed	back to summary
public void setReversed(boolean value) Sets the reversed field value. categories are displayed in reverse order

setTickMarkFrequency	back to summary
public void setTickMarkFrequency(short field_3_tickMarkFrequency) Set the tick mark frequency field for the CategorySeriesAxis record.

setValueAxisCrossing	back to summary
public void setValueAxisCrossing(boolean value) Sets the value axis crossing field value. set true to indicate axis crosses between categories and false to cross axis midway

public final Class CategorySeriesAxisRecord

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail